## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: Tool_Button

- Goto spec source

# Description

    package Gtk.Tool_Button is

This package defines a special kind of Gtk.Toolbar child that embeds a button.

See also gtk-toggle_tool_button.ads, gtk-radio_tool_button.ads and gtk-menu_tool_button.ads

Binding from C File version 2.8.17

# Classes

### Gtk_Tool_Button_Record

- Goto declaration in source

    type Gtk_Tool_Button_Record is new Gtk.Tool_Item.Gtk_Tool_Item_Record
          with null record;

#### Ancestors:

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

#### Immediate Children:

Gtk.Menu_Tool_Button.Gtk_Menu_Tool_Button_Record
Gtk.Toggle_Tool_Button.Gtk_Toggle_Tool_Button_Record

#### Primitive operations:

Get_Icon_Name

- To API doc
- To spec

Get_Icon_Widget

- To API doc
- To spec

Get_Label

- To API doc
- To spec

Get_Label_Widget

- To API doc
- To spec

Get_Stock_Id

- To API doc
- To spec

Get_Use_Underline

- 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.Tool_Item.Get_Expand

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Homogeneous

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Icon_Size

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Is_Important

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Orientation

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Proxy_Menu_Item

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Relief_Style

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Toolbar_Style

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Use_Drag_Window

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Visible_Horizontal

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Get_Visible_Vertical

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Rebuild_Menu

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Retrieve_Proxy_Menu_Item

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Expand

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Homogeneous

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Is_Important

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Proxy_Menu_Item

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Tooltip

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Tooltip_Markup

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Tooltip_Text

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Use_Drag_Window

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Visible_Horizontal

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Set_Visible_Vertical

- To API doc
- To spec

(Inherited)
Gtk.Tool_Item.Toolbar_Reconfigured

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

- To API doc
- To spec

Set_Icon_Widget

- To API doc
- To spec

Set_Label

- To API doc
- To spec

Set_Label_Widget

- To API doc
- To spec

Set_Stock_Id

- To API doc
- To spec

Set_Use_Underline

- To API doc
- To spec

# Types

### Gtk_Tool_Button

- Goto declaration in source

    type Gtk_Tool_Button is access all Gtk_Tool_Button_Record'Class;

# Constants & Global variables

### Signal_Clicked

- Goto declaration in source

(Glib.Signal_Name)

    Signal_Clicked : constant Glib.Signal_Name := "clicked";

### Label_Property

- Goto declaration in source

(Glib.Properties.Property_String)

    Label_Property         : constant Glib.Properties.Property_String;

### Use_Underline_Property

- Goto declaration in source

(Glib.Properties.Property_Boolean)

    Use_Underline_Property : constant Glib.Properties.Property_Boolean;

### Label_Widget_Property

- Goto declaration in source

(Glib.Properties.Property_Object)

    Label_Widget_Property  : constant Glib.Properties.Property_Object;

### Stock_Id_Property

- Goto declaration in source

(Glib.Properties.Property_String)

    Stock_Id_Property      : constant Glib.Properties.Property_String;

### Icon_Name_Property

- Goto declaration in source

(Glib.Properties.Property_String)

    Icon_Name_Property     : constant Glib.Properties.Property_String;

### Icon_Widget_Property

- Goto declaration in source

(Glib.Properties.Property_Object)

    Icon_Widget_Property   : constant Glib.Properties.Property_Object;

# Subprograms & Entries

### Gtk_New

- Goto spec in source

    procedure Gtk_New (Button: out Gtk_Tool_Button;Icon_Widget: Gtk.Widget.Gtk_Widget := null;Label: String := "");

### Initialize

- Goto spec in source

    procedure Initialize (Button: access Gtk_Tool_Button_Record'Class;Icon_Widget: Gtk.Widget.Gtk_Widget := null;Label: String := "");

Create or initialize a button, given its icon and label. Any of the parameters can be left unspecified if the button has none of these.

### Gtk_New_From_Stock

- Goto spec in source

    procedure Gtk_New_From_Stock (Button: out Gtk_Tool_Button;Stock_Id: String);

### Initialize_From_Stock

- Goto spec in source

    procedure Initialize_From_Stock (Button: access Gtk_Tool_Button_Record'Class;Stock_Id: String);

Create or initialize a button from a stock icon (see gtk-stock.ads)

### Get_Type

- Goto spec in source
- Goto body in source

    function Get_Type return GType;

Return the internal type used for this widget class

### Set_Icon_Name

- Goto spec in source

    procedure Set_Icon_Name (Button: access Gtk_Tool_Button_Record;Icon_Name: String);

### Get_Icon_Name

- Goto spec in source

    function Get_Icon_Name (Button: access Gtk_Tool_Button_Record)  return String;

Sets the icon for the tool button from a named themed icon. See the docs for Gtk.Icon_them for more details. The "icon_name" property only has an effect if not overriden by non-null "label", "icon_widget" or "stock_id" properties

### Set_Icon_Widget

- Goto spec in source

    procedure Set_Icon_Widget (Button: access Gtk_Tool_Button_Record;Icon_Widget: Gtk.Widget.Gtk_Widget := null);

### Get_Icon_Widget

- Goto spec in source

    function Get_Icon_Widget (Button: access Gtk_Tool_Button_Record) return Gtk.Widget.Gtk_Widget;

Sets or gets the widget used as icon on Button. If Icon_Widget is null, the icon used for the button is determined by the "stock_id" property. If the latter is also null, the button has no icon

### Set_Label

- Goto spec in source

    procedure Set_Label (Button: access Gtk_Tool_Button_Record;Label: String);

### Get_Label

- Goto spec in source

    function Get_Label (Button: access Gtk_Tool_Button_Record) return String;

Sets or gets the label used for the button. The "label" property only has an effect if not overridden by a non-null "label_widget" property. If both are null, the label comes from the "stock_id" properties. If also null, the button has no label. Get_Label only returns the value of the "labeL" property.

### Set_Label_Widget

- Goto spec in source

    procedure Set_Label_Widget (Button: access Gtk_Tool_Button_Record;Label_Widget: Gtk.Widget.Gtk_Widget := null);

### Get_Label_Widget

- Goto spec in source

    function Get_Label_Widget (Button: access Gtk_Tool_Button_Record) return Gtk.Widget.Gtk_Widget;

Sets Label_Widget as the widget that will be used as the label for the button. If this is null, the "label" property is used as label.

### Set_Stock_Id

- Goto spec in source

    procedure Set_Stock_Id (Button: access Gtk_Tool_Button_Record;Stock_Id: String);

### Get_Stock_Id

- Goto spec in source

    function Get_Stock_Id (Button: access Gtk_Tool_Button_Record) return String;

Sets the name of the stock item. This property has no effect if overriden by non-null "label" or "icon_widget" properties.

### Set_Use_Underline

- Goto spec in source

    procedure Set_Use_Underline (Button: access Gtk_Tool_Button_Record;Use_Underline: Boolean := True);

### Get_Use_Underline

- Goto spec in source

    function Get_Use_Underline (Button: access Gtk_Tool_Button_Record) return Boolean;

If Use_Underline is true, an underline in the label property indicates that the next character should be used a mnemonic accelerator key in the overflow menu of the toolbar. For instance, if the label is "_Open", the item in the overflow menu can be activated with alt-O. Labels shown on tool buttons never have mnemonics on them.