## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: Tool_Item

- Goto spec source

# Description

    package Gtk.Tool_Item is

This package defines the base class for all items that can be added into a toolbar (see gtk-toolbar.ads).

See also Gtk.Tool_Button (gtk-tool_button.ads).

See also Gtk.Separator_Tool_Item (gtk-separator_tool_item).

Binding from C File version 2.16.6

# Classes

### Gtk_Tool_Item_Record

- Goto declaration in source

    type Gtk_Tool_Item_Record is new Gtk.Bin.Gtk_Bin_Record with null record;

#### Ancestors:

Gtk.Bin.Gtk_Bin_Record
Gtk.Container.Gtk_Container_Record
Gtk.Widget.Gtk_Widget_Record
Glib.Object.GObject_Record

#### Immediate Children:

Gtk.Separator_Tool_Item.Gtk_Separator_Tool_Item_Record
Gtk.Tool_Button.Gtk_Tool_Button_Record

#### Primitive operations:

Get_Expand

- To API doc
- To spec

Get_Homogeneous

- To API doc
- To spec

Get_Icon_Size

- To API doc
- To spec

Get_Is_Important

- To API doc
- To spec

Get_Orientation

- To API doc
- To spec

Get_Proxy_Menu_Item

- To API doc
- To spec

Get_Relief_Style

- To API doc
- To spec

Get_Toolbar_Style

- To API doc
- To spec

Get_Use_Drag_Window

- To API doc
- To spec

Get_Visible_Horizontal

- To API doc
- To spec

Get_Visible_Vertical

- To API doc
- To spec

Glib.Object.Deallocate

- To API doc
- To spec

(Inherited)
Glib.Object.Get_Type

- To API doc
- To spec

(Inherited)
Glib.Object.Notify

- To API doc
- To spec

(Inherited)
Glib.Object.Ref

- To API doc
- To spec

(Inherited)
Glib.Object.Ref_Sink

- To API doc
- To spec

(Inherited)
Glib.Object.Unref

- To API doc
- To spec

(Inherited)
Gtk.Bin.Get_Child

- To API doc
- To spec

(Inherited)
Gtk.Container.Add

- To API doc
- To spec

(Inherited)
Gtk.Container.Check_Resize

- To API doc
- To spec

(Inherited)
Gtk.Container.Child_Get_Property

- To API doc
- To spec

(Inherited)
Gtk.Container.Child_Set_Property

- To API doc
- To spec

(Inherited)
Gtk.Container.Child_Type

- To API doc
- To spec

(Inherited)
Gtk.Container.Forall

- To API doc
- To spec

(Inherited)
Gtk.Container.Foreach

- To API doc
- To spec

(Inherited)
Gtk.Container.Get_Border_Width

- To API doc
- To spec

(Inherited)
Gtk.Container.Get_Children

- To API doc
- To spec

(Inherited)
Gtk.Container.Get_Focus_Chain

- To API doc
- To spec

(Inherited)
Gtk.Container.Get_Focus_Child

- To API doc
- To spec

(Inherited)
Gtk.Container.Get_Focus_Hadjustment

- To API doc
- To spec

(Inherited)
Gtk.Container.Get_Focus_Vadjustment

- To API doc
- To spec

(Inherited)
Gtk.Container.Get_Resize_Mode

- To API doc
- To spec

(Inherited)
Gtk.Container.Propagate_Expose

- To API doc
- To spec

(Inherited)
Gtk.Container.Remove

- To API doc
- To spec

(Inherited)
Gtk.Container.Resize_Children

- To API doc
- To spec

(Inherited)
Gtk.Container.Set_Border_Width

- To API doc
- To spec

(Inherited)
Gtk.Container.Set_Focus_Chain

- To API doc
- To spec

(Inherited)
Gtk.Container.Set_Focus_Child

- To API doc
- To spec

(Inherited)
Gtk.Container.Set_Focus_Hadjustment

- To API doc
- To spec

(Inherited)
Gtk.Container.Set_Focus_Vadjustment

- To API doc
- To spec

(Inherited)
Gtk.Container.Set_Reallocate_Redraws

- To API doc
- To spec

(Inherited)
Gtk.Container.Set_Resize_Mode

- To API doc
- To spec

(Inherited)
Gtk.Container.Unset_Focus_Chain

- To API doc
- To spec

(Inherited)
Gtk.Widget.Activate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Add_Accelerator

- To API doc
- To spec

(Inherited)
Gtk.Widget.Add_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Add_Mnemonic_Label

- To API doc
- To spec

(Inherited)
Gtk.Widget.Can_Activate_Accel

- To API doc
- To spec

(Inherited)
Gtk.Widget.Child_Notify

- To API doc
- To spec

(Inherited)
Gtk.Widget.Class_Path

- To API doc
- To spec

(Inherited)
Gtk.Widget.Class_Path_Reversed

- To API doc
- To spec

(Inherited)
Gtk.Widget.Create_Pango_Context

- To API doc
- To spec

(Inherited)
Gtk.Widget.Create_Pango_Layout

- To API doc
- To spec

(Inherited)
Gtk.Widget.Destroy

- To API doc
- To spec

(Inherited)
Gtk.Widget.Draw

- To API doc
- To spec

(Inherited)
Gtk.Widget.Ensure_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Error_Bell

- To API doc
- To spec

(Inherited)
Gtk.Widget.Flag_Is_Set

- To API doc
- To spec

(Inherited)
Gtk.Widget.Flags

- To API doc
- To spec

(Inherited)
Gtk.Widget.Freeze_Child_Notify

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_Height

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_Width

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_X

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Allocation_Y

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Ancestor

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Child_Requisition

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Child_Visible

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Colormap

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Composite_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Direction

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Extension_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Has_Tooltip

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_No_Show_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Pango_Context

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Parent

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Parent_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Pointer

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Root_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Size_Request

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Snapshot

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_State

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Tooltip_Markup

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Tooltip_Text

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Tooltip_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Toplevel

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Visual

- To API doc
- To spec

(Inherited)
Gtk.Widget.Get_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Grab_Default

- To API doc
- To spec

(Inherited)
Gtk.Widget.Grab_Focus

- To API doc
- To spec

(Inherited)
Gtk.Widget.Has_Screen

- To API doc
- To spec

(Inherited)
Gtk.Widget.Hide

- To API doc
- To spec

(Inherited)
Gtk.Widget.Hide_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Input_Shape_Combine_Mask

- To API doc
- To spec

(Inherited)
Gtk.Widget.Intersect

- To API doc
- To spec

(Inherited)
Gtk.Widget.Is_Ancestor

- To API doc
- To spec

(Inherited)
Gtk.Widget.Is_Composited

- To API doc
- To spec

(Inherited)
Gtk.Widget.Is_Focus

- To API doc
- To spec

(Inherited)
Gtk.Widget.Keynav_Failed

- To API doc
- To spec

(Inherited)
Gtk.Widget.List_Mnemonic_Labels

- To API doc
- To spec

(Inherited)
Gtk.Widget.Map

- To API doc
- To spec

(Inherited)
Gtk.Widget.Mnemonic_Activate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Base

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Bg

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Cursor

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Fg

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Font

- To API doc
- To spec

(Inherited)
Gtk.Widget.Modify_Text

- To API doc
- To spec

(Inherited)
Gtk.Widget.Path

- To API doc
- To spec

(Inherited)
Gtk.Widget.Path_Reversed

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Clear

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Clear_Area

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Draw

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Draw_Area

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Resize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Queue_Resize_No_Redraw

- To API doc
- To spec

(Inherited)
Gtk.Widget.Realize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Region_Intersect

- To API doc
- To spec

(Inherited)
Gtk.Widget.Remove_Accelerator

- To API doc
- To spec

(Inherited)
Gtk.Widget.Remove_Mnemonic_Label

- To API doc
- To spec

(Inherited)
Gtk.Widget.Render_Icon

- To API doc
- To spec

(Inherited)
Gtk.Widget.Reparent

- To API doc
- To spec

(Inherited)
Gtk.Widget.Reset_Rc_Styles

- To API doc
- To spec

(Inherited)
Gtk.Widget.Reset_Shapes

- To API doc
- To spec

(Inherited)
Gtk.Widget.Restore_Default_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Send_Expose

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Accel_Path

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_App_Paintable

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Child_Visible

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Colormap

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Composite_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Direction

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Double_Buffered

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Extension_Events

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Flags

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Has_Tooltip

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Name

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_No_Show_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Parent

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Parent_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Redraw_On_Allocate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Scroll_Adjustments

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Sensitive

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Size_Request

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_State

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Style

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Tooltip_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_UPosition

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_USize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Set_Window

- To API doc
- To spec

(Inherited)
Gtk.Widget.Shape_Combine_Mask

- To API doc
- To spec

(Inherited)
Gtk.Widget.Show

- To API doc
- To spec

(Inherited)
Gtk.Widget.Show_All

- To API doc
- To spec

(Inherited)
Gtk.Widget.Show_Now

- To API doc
- To spec

(Inherited)
Gtk.Widget.Size_Allocate

- To API doc
- To spec

(Inherited)
Gtk.Widget.Size_Request

- To API doc
- To spec

(Inherited)
Gtk.Widget.Style_Get_Property

- To API doc
- To spec

(Inherited)
Gtk.Widget.Thaw_Child_Notify

- To API doc
- To spec

(Inherited)
Gtk.Widget.Trigger_Tooltip_Query

- To API doc
- To spec

(Inherited)
Gtk.Widget.Unmap

- To API doc
- To spec

(Inherited)
Gtk.Widget.Unrealize

- To API doc
- To spec

(Inherited)
Gtk.Widget.Unset_Flags

- To API doc
- To spec

(Inherited)
Rebuild_Menu

- To API doc
- To spec

Retrieve_Proxy_Menu_Item

- To API doc
- To spec

Set_Expand

- To API doc
- To spec

Set_Homogeneous

- To API doc
- To spec

Set_Is_Important

- To API doc
- To spec

Set_Proxy_Menu_Item

- To API doc
- To spec

Set_Tooltip

- To API doc
- To spec

Set_Tooltip_Markup

- To API doc
- To spec

(overriding Gtk.Widget.Set_Tooltip_Markup)
Set_Tooltip_Text

- To API doc
- To spec

(overriding Gtk.Widget.Set_Tooltip_Text)
Set_Use_Drag_Window

- To API doc
- To spec

Set_Visible_Horizontal

- To API doc
- To spec

Set_Visible_Vertical

- To API doc
- To spec

Toolbar_Reconfigured

- To API doc
- To spec

# Types

### Gtk_Tool_Item

- Goto declaration in source

    type Gtk_Tool_Item is access all Gtk_Tool_Item_Record'Class;

# Constants & Global variables

### Visible_Horizontal_Property

- Goto declaration in source

(Glib.Properties.Property_Boolean)

    Visible_Horizontal_Property : constant Glib.Properties.Property_Boolean;

### Visible_Vertical_Property

- Goto declaration in source

(Glib.Properties.Property_Boolean)

    Visible_Vertical_Property   : constant Glib.Properties.Property_Boolean;

### Is_Important_Property

- Goto declaration in source

(Glib.Properties.Property_Boolean)

    Is_Important_Property       : constant Glib.Properties.Property_Boolean;

### Signal_Create_Menu_Proxy

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Create_Menu_Proxy    : constant Glib.Signal_Name :=
                                       "create_menu_proxy";

### Signal_Toolbar_Reconfigured

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Toolbar_Reconfigured : constant Glib.Signal_Name :=
                                       "toolbar_reconfigured";

### Signal_Set_Tooltip

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Set_Tooltip          : constant Glib.Signal_Name :=
                                       "set_tooltip";

# Subprograms & Entries

### Gtk_New

- Goto spec in source

    procedure Gtk_New    (Item: out Gtk_Tool_Item);

### Initialize

- Goto spec in source

    procedure Initialize (Item: access Gtk_Tool_Item_Record'Class);

Create a new tool item, which contains a single child.

### Get_Type

- Goto spec in source
- Goto body in source

    function Get_Type return GType;

Return the internal value associated with a Gtk_Button.

### Set_Expand

- Goto spec in source

    procedure Set_Expand (Tool_Item: access Gtk_Tool_Item_Record;Expand: Boolean);

### Get_Expand

- Goto spec in source

    function Get_Expand (Tool_Item: access Gtk_Tool_Item_Record) return Boolean;

Sets whether Tool_Item is allocated extra space when there is more room on the toolbar than needed for the items. The effect is that the item gets bigger when the toolbar gets bigger.

### Set_Homogeneous

- Goto spec in source

    procedure Set_Homogeneous (Tool_Item: access Gtk_Tool_Item_Record;Homogeneous: Boolean);

### Get_Homogeneous

- Goto spec in source

    function Get_Homogeneous (Tool_Item: access Gtk_Tool_Item_Record) return Boolean;

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.

### Get_Icon_Size

- Goto spec in source

    function Get_Icon_Size (Tool_Item: access Gtk_Tool_Item_Record) return Gtk.Enums.Gtk_Icon_Size;

Returns the icon size used for Tool_Item. Custom subclasses of Gtk_Tool_Item_Record should call this function to find out what size icons they should use. This settings depends on the toolbar that contains the item

### Set_Is_Important

- Goto spec in source

    procedure Set_Is_Important (Tool_Item: access Gtk_Tool_Item_Record;Is_Important: Boolean);

### Get_Is_Important

- Goto spec in source

    function Get_Is_Important (Tool_Item: access Gtk_Tool_Item_Record) return Boolean;

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

### Get_Orientation

- Goto spec in source

    function Get_Orientation (Tool_Item: access Gtk_Tool_Item_Record) return Gtk.Enums.Gtk_Orientation;

Returns the orientation used for Tool_Item.

### Set_Proxy_Menu_Item

- Goto spec in source

    procedure Set_Proxy_Menu_Item (Tool_Item: access Gtk_Tool_Item_Record;Menu_Item_Id: String;Menu_Item: Gtk.Menu_Item.Gtk_Menu_Item);

### Get_Proxy_Menu_Item

- Goto spec in source

    function Get_Proxy_Menu_Item (Tool_Item: access Gtk_Tool_Item_Record;Menu_Item_Id: String) return Gtk.Menu_Item.Gtk_Menu_Item;

Sets the menu item used in the toolbar overflow menu. Menu_Item_Id is used to identify the caller of this function and should also be used with Get_Proxy_Menu_Item. Custom subclasses of Gtk_Tool_Item_Record should use this function to update their menu item when the tool item changes. See also Gtk.Toolbar.Set_Show_Arrow.

### Retrieve_Proxy_Menu_Item

- Goto spec in source

    function Retrieve_Proxy_Menu_Item (Tool_Item: access Gtk_Tool_Item_Record) return Gtk.Menu_Item.Gtk_Menu_Item;

Returns the menu item that was last set by Set_Proxy_Menu_Item, ie the menu item that will appear in the overflow menu. This might be different from the one set through Set_Proxy_Menu_Item, if someone else has overriden the menu afterward.

### Rebuild_Menu

- Goto spec in source

    procedure Rebuild_Menu (Tool_Item: access Gtk_Tool_Item_Record);

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.

### Set_Tooltip

- Goto spec in source

    procedure Set_Tooltip (Tool_Item: access Gtk_Tool_Item_Record;Tooltips: access Gtk.Tooltips.Gtk_Tooltips_Record'Class;Tip_Text: String;Tip_Private: String := "");

Sets the tooltips object to be used for Tool item, the text to be displayed as tooltip on the item and the private text to be used

### Set_Tooltip_Markup

- Goto spec in source

    procedure Set_Tooltip_Markup (Tool_Item: access Gtk_Tool_Item_Record;Markup: UTF8_String);

Sets the markup text to be displayed as tooltip on the item. See Gtk.Widget.Set_Tooltip_Markup.

### Set_Tooltip_Text

- Goto spec in source

    procedure Set_Tooltip_Text (Tool_Item: access Gtk_Tool_Item_Record;Text: UTF8_String);

Sets the text to be displayed as tooltip on the item. See Gtk.Widget.Set_Tooltip_Text.

### Set_Visible_Vertical

- Goto spec in source

    procedure Set_Visible_Vertical (Toolitem: access Gtk_Tool_Item_Record;Visible_Vertical: Boolean);

### Get_Visible_Vertical

- Goto spec in source

    function Get_Visible_Vertical (Toolitem: access Gtk_Tool_Item_Record) return Boolean;

Sets whether Toolitem 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 Toolitem will not appear on toolbars that are docked vertically.

### Set_Visible_Horizontal

- Goto spec in source

    procedure Set_Visible_Horizontal (Toolitem: access Gtk_Tool_Item_Record;Visible_Horizontal: Boolean);

### Get_Visible_Horizontal

- Goto spec in source

    function Get_Visible_Horizontal (Toolitem: access Gtk_Tool_Item_Record) return Boolean;

Same as Set_Visible_Vertical, but for a horizontal orientation

### Set_Use_Drag_Window

- Goto spec in source

    procedure Set_Use_Drag_Window (Toolitem: access Gtk_Tool_Item_Record;Use_Drag_Window: Boolean);

### Get_Use_Drag_Window

- Goto spec in source

    function Get_Use_Drag_Window (Toolitem: access Gtk_Tool_Item_Record) return Boolean;

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

### Get_Relief_Style

- Goto spec in source

    function Get_Relief_Style (Tool_Item: access Gtk_Tool_Item_Record) return Gtk.Enums.Gtk_Relief_Style;

Get the relief style of the item

### Get_Toolbar_Style

- Goto spec in source

    function Get_Toolbar_Style (Tool_Item: access Gtk_Tool_Item_Record) return Gtk.Enums.Gtk_Toolbar_Style;

Get the style of the toolbar that contains the item

### Toolbar_Reconfigured

- Goto spec in source

    procedure Toolbar_Reconfigured (Tool_Item: access Gtk_Tool_Item_Record);

Emits the signal #GtkToolItem::toolbar_reconfigured on Tool_Item. Gtk_Toolbar and other Gtk_Tool_Shell implementations use this function to notify children when some aspect of their configuration changes.