<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
]>
<!--ENTITY index-Objects-Grouped SYSTEM "objects_grouped.sgml"-->
<refentry id="GtkToolItem">
<refmeta>
<refentrytitle role="top_of_page" id="GtkToolItem.top_of_page">GtkToolItem</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GtkToolItem</refname>
<refpurpose>The base class of widgets that can be added to GtkToolShell</refpurpose>
</refnamediv>

<refsynopsisdiv id="GtkToolItem.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;gtk/gtk.h&gt;

                    <link linkend="GtkToolItem-struct">GtkToolItem</link>;
<link linkend="GtkToolItem">GtkToolItem</link> *       <link linkend="gtk-tool-item-new">gtk_tool_item_new</link>                   (void);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-homogeneous">gtk_tool_item_set_homogeneous</link>       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> homogeneous);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-homogeneous">gtk_tool_item_get_homogeneous</link>       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-expand">gtk_tool_item_set_expand</link>            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> expand);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-expand">gtk_tool_item_get_expand</link>            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-tooltip">gtk_tool_item_set_tooltip</link>           (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="GtkTooltips">GtkTooltips</link> *tooltips,
                                                         const <link linkend="gchar">gchar</link> *tip_text,
                                                         const <link linkend="gchar">gchar</link> *tip_private);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-tooltip-text">gtk_tool_item_set_tooltip_text</link>      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-tooltip-markup">gtk_tool_item_set_tooltip_markup</link>    (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *markup);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-use-drag-window">gtk_tool_item_set_use_drag_window</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> use_drag_window);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-use-drag-window">gtk_tool_item_get_use_drag_window</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-visible-horizontal">gtk_tool_item_set_visible_horizontal</link>
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> visible_horizontal);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-visible-horizontal">gtk_tool_item_get_visible_horizontal</link>
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-visible-vertical">gtk_tool_item_set_visible_vertical</link>  (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> visible_vertical);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-visible-vertical">gtk_tool_item_get_visible_vertical</link>  (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-is-important">gtk_tool_item_set_is_important</link>      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> is_important);
<link linkend="gboolean">gboolean</link>            <link linkend="gtk-tool-item-get-is-important">gtk_tool_item_get_is_important</link>      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="GtkIconSize">GtkIconSize</link>         <link linkend="gtk-tool-item-get-icon-size">gtk_tool_item_get_icon_size</link>         (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="GtkOrientation">GtkOrientation</link>      <link linkend="gtk-tool-item-get-orientation">gtk_tool_item_get_orientation</link>       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="GtkToolbarStyle">GtkToolbarStyle</link>     <link linkend="gtk-tool-item-get-toolbar-style">gtk_tool_item_get_toolbar_style</link>     (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="GtkReliefStyle">GtkReliefStyle</link>      <link linkend="gtk-tool-item-get-relief-style">gtk_tool_item_get_relief_style</link>      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gtk-tool-item-retrieve-proxy-menu-item">gtk_tool_item_retrieve_proxy_menu_item</link>
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gtk-tool-item-get-proxy-menu-item">gtk_tool_item_get_proxy_menu_item</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *menu_item_id);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-set-proxy-menu-item">gtk_tool_item_set_proxy_menu_item</link>   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *menu_item_id,
                                                         <link linkend="GtkWidget">GtkWidget</link> *menu_item);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-rebuild-menu">gtk_tool_item_rebuild_menu</link>          (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
<link linkend="void">void</link>                <link linkend="gtk-tool-item-toolbar-reconfigured">gtk_tool_item_toolbar_reconfigured</link>  (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GtkToolItem.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----GtkToolItem
                                       +----<link linkend="GtkToolButton">GtkToolButton</link>
                                       +----<link linkend="GtkSeparatorToolItem">GtkSeparatorToolItem</link>
</synopsis>
</refsect1>



<refsect1 id="GtkToolItem.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkToolItem implements
 <link linkend="GtkActivatable">GtkActivatable</link>,  <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
</refsect1>


<refsect1 id="GtkToolItem.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GtkToolItem--is-important">is-important</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkToolItem--visible-horizontal">visible-horizontal</link>&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="GtkToolItem--visible-vertical">visible-vertical</link>&quot;         <link linkend="gboolean">gboolean</link>              : Read / Write
</synopsis>
</refsect1>

<refsect1 id="GtkToolItem.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
  &quot;<link linkend="GtkToolItem-create-menu-proxy">create-menu-proxy</link>&quot;                              : Run Last
  &quot;<link linkend="GtkToolItem-set-tooltip">set-tooltip</link>&quot;                                    : Run Last
  &quot;<link linkend="GtkToolItem-toolbar-reconfigured">toolbar-reconfigured</link>&quot;                           : Run Last
</synopsis>
</refsect1>


<refsect1 id="GtkToolItem.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="GtkToolItem"><type>GtkToolItem</type></link><!-- -->s are widgets that can appear on a toolbar. To
create a toolbar item that contain something else than a button, use
<link linkend="gtk-tool-item-new"><function>gtk_tool_item_new()</function></link>. Use <link linkend="gtk-container-add"><function>gtk_container_add()</function></link> to add a child
widget to the tool item.
</para>
<para>
For toolbar items that contain buttons, see the <link linkend="GtkToolButton"><type>GtkToolButton</type></link>,
<link linkend="GtkToggleToolButton"><type>GtkToggleToolButton</type></link> and <link linkend="GtkRadioToolButton"><type>GtkRadioToolButton</type></link> classes.
</para>
<para>
See the <link linkend="GtkToolbar"><type>GtkToolbar</type></link> class for a description of the toolbar widget, and
<link linkend="GtkToolShell"><type>GtkToolShell</type></link> for a description of the tool shell interface.</para>
<para>
</para>
</refsect1>

<refsect1 id="GtkToolItem.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GtkToolItem-struct" role="struct">
<title>GtkToolItem</title>
<indexterm zone="GtkToolItem-struct"><primary sortas="ToolItem">GtkToolItem</primary></indexterm><programlisting>typedef struct _GtkToolItem GtkToolItem;</programlisting>
<para>
The GtkToolItem struct contains only private data.
It should only be accessed through the functions described below.</para>
<para>
</para></refsect2>
<refsect2 id="gtk-tool-item-new" role="function" condition="since:2.4">
<title>gtk_tool_item_new ()</title>
<indexterm zone="gtk-tool-item-new" role="2.4"><primary sortas="tool_item_new">gtk_tool_item_new</primary></indexterm><programlisting><link linkend="GtkToolItem">GtkToolItem</link> *       gtk_tool_item_new                   (void);</programlisting>
<para>
Creates a new <link linkend="GtkToolItem"><type>GtkToolItem</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new <link linkend="GtkToolItem"><type>GtkToolItem</type></link>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-homogeneous" role="function" condition="since:2.4">
<title>gtk_tool_item_set_homogeneous ()</title>
<indexterm zone="gtk-tool-item-set-homogeneous" role="2.4"><primary sortas="tool_item_set_homogeneous">gtk_tool_item_set_homogeneous</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_homogeneous       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> homogeneous);</programlisting>
<para>
Sets whether <parameter>tool_item</parameter> 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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>homogeneous</parameter>&#160;:</term>
<listitem><simpara> whether <parameter>tool_item</parameter> is the same size as other homogeneous items
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-homogeneous" role="function" condition="since:2.4">
<title>gtk_tool_item_get_homogeneous ()</title>
<indexterm zone="gtk-tool-item-get-homogeneous" role="2.4"><primary sortas="tool_item_get_homogeneous">gtk_tool_item_get_homogeneous</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_homogeneous       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns whether <parameter>tool_item</parameter> is the same size as other homogeneous
items. See <link linkend="gtk-tool-item-set-homogeneous"><function>gtk_tool_item_set_homogeneous()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the item is the same size as other homogeneous
items.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-expand" role="function" condition="since:2.4">
<title>gtk_tool_item_set_expand ()</title>
<indexterm zone="gtk-tool-item-set-expand" role="2.4"><primary sortas="tool_item_set_expand">gtk_tool_item_set_expand</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_expand            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> expand);</programlisting>
<para>
Sets whether <parameter>tool_item</parameter> 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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>expand</parameter>&#160;:</term>
<listitem><simpara> Whether <parameter>tool_item</parameter> is allocated extra space
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-expand" role="function" condition="since:2.4">
<title>gtk_tool_item_get_expand ()</title>
<indexterm zone="gtk-tool-item-get-expand" role="2.4"><primary sortas="tool_item_get_expand">gtk_tool_item_get_expand</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_expand            (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns whether <parameter>tool_item</parameter> is allocated extra space.
See <link linkend="gtk-tool-item-set-expand"><function>gtk_tool_item_set_expand()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>tool_item</parameter> is allocated extra space.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-tooltip" role="function" condition="deprecated:2.12: Use gtk_tool_item_set_tooltip_text() instead.|since:2.4">
<title>gtk_tool_item_set_tooltip ()</title>
<indexterm zone="gtk-tool-item-set-tooltip" role="deprecated"><primary sortas="tool_item_set_tooltip">gtk_tool_item_set_tooltip</primary></indexterm><indexterm zone="gtk-tool-item-set-tooltip" role="2.4"><primary sortas="tool_item_set_tooltip">gtk_tool_item_set_tooltip</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_tooltip           (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="GtkTooltips">GtkTooltips</link> *tooltips,
                                                         const <link linkend="gchar">gchar</link> *tip_text,
                                                         const <link linkend="gchar">gchar</link> *tip_private);</programlisting>
<warning><para><literal>gtk_tool_item_set_tooltip</literal> has been deprecated since version 2.12 and should not be used in newly-written code. Use <link linkend="gtk-tool-item-set-tooltip-text"><function>gtk_tool_item_set_tooltip_text()</function></link> instead.</para></warning>
<para>
Sets the <link linkend="GtkTooltips"><type>GtkTooltips</type></link> object to be used for <parameter>tool_item</parameter>, the
text to be displayed as tooltip on the item and the private text
to be used. See <link linkend="gtk-tooltips-set-tip"><function>gtk_tooltips_set_tip()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tooltips</parameter>&#160;:</term>
<listitem><simpara> The <link linkend="GtkTooltips"><type>GtkTooltips</type></link> object to be used
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tip_text</parameter>&#160;:</term>
<listitem><simpara> text to be used as tooltip text for <parameter>tool_item</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tip_private</parameter>&#160;:</term>
<listitem><simpara> text to be used as private tooltip text
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-tooltip-text" role="function" condition="since:2.12">
<title>gtk_tool_item_set_tooltip_text ()</title>
<indexterm zone="gtk-tool-item-set-tooltip-text" role="2.12"><primary sortas="tool_item_set_tooltip_text">gtk_tool_item_set_tooltip_text</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_tooltip_text      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<para>
Sets the text to be displayed as tooltip on the item.
See <link linkend="gtk-widget-set-tooltip-text"><function>gtk_widget_set_tooltip_text()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara> text to be used as tooltip for <parameter>tool_item</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gtk-tool-item-set-tooltip-markup" role="function" condition="since:2.12">
<title>gtk_tool_item_set_tooltip_markup ()</title>
<indexterm zone="gtk-tool-item-set-tooltip-markup" role="2.12"><primary sortas="tool_item_set_tooltip_markup">gtk_tool_item_set_tooltip_markup</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_tooltip_markup    (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *markup);</programlisting>
<para>
Sets the markup text to be displayed as tooltip on the item.
See <link linkend="gtk-widget-set-tooltip-markup"><function>gtk_widget_set_tooltip_markup()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>markup</parameter>&#160;:</term>
<listitem><simpara> markup text to be used as tooltip for <parameter>tool_item</parameter>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.12</para></refsect2>
<refsect2 id="gtk-tool-item-set-use-drag-window" role="function" condition="since:2.4">
<title>gtk_tool_item_set_use_drag_window ()</title>
<indexterm zone="gtk-tool-item-set-use-drag-window" role="2.4"><primary sortas="tool_item_set_use_drag_window">gtk_tool_item_set_use_drag_window</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_use_drag_window   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> use_drag_window);</programlisting>
<para>
Sets whether <parameter>tool_item</parameter> has a drag window. When <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> the
toolitem can be used as a drag source through <link linkend="gtk-drag-source-set"><function>gtk_drag_source_set()</function></link>.
When <parameter>tool_item</parameter> has a drag window it will intercept all events,
even those that would otherwise be sent to a child of <parameter>tool_item</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>use_drag_window</parameter>&#160;:</term>
<listitem><simpara> Whether <parameter>tool_item</parameter> has a drag window.
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-use-drag-window" role="function" condition="since:2.4">
<title>gtk_tool_item_get_use_drag_window ()</title>
<indexterm zone="gtk-tool-item-get-use-drag-window" role="2.4"><primary sortas="tool_item_get_use_drag_window">gtk_tool_item_get_use_drag_window</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_use_drag_window   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns whether <parameter>tool_item</parameter> has a drag window. See
<link linkend="gtk-tool-item-set-use-drag-window"><function>gtk_tool_item_set_use_drag_window()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>tool_item</parameter> uses a drag window.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-visible-horizontal" role="function" condition="since:2.4">
<title>gtk_tool_item_set_visible_horizontal ()</title>
<indexterm zone="gtk-tool-item-set-visible-horizontal" role="2.4"><primary sortas="tool_item_set_visible_horizontal">gtk_tool_item_set_visible_horizontal</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_visible_horizontal
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> visible_horizontal);</programlisting>
<para>
Sets whether <parameter>tool_item</parameter> is visible when the toolbar is docked horizontally.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>visible_horizontal</parameter>&#160;:</term>
<listitem><simpara> Whether <parameter>tool_item</parameter> is visible when in horizontal mode
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-visible-horizontal" role="function" condition="since:2.4">
<title>gtk_tool_item_get_visible_horizontal ()</title>
<indexterm zone="gtk-tool-item-get-visible-horizontal" role="2.4"><primary sortas="tool_item_get_visible_horizontal">gtk_tool_item_get_visible_horizontal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_visible_horizontal
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns whether the <parameter>tool_item</parameter> is visible on toolbars that are
docked horizontally.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>tool_item</parameter> is visible on toolbars that are
docked horizontally.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-visible-vertical" role="function" condition="since:2.4">
<title>gtk_tool_item_set_visible_vertical ()</title>
<indexterm zone="gtk-tool-item-set-visible-vertical" role="2.4"><primary sortas="tool_item_set_visible_vertical">gtk_tool_item_set_visible_vertical</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_visible_vertical  (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> visible_vertical);</programlisting>
<para>
Sets whether <parameter>tool_item</parameter> 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 <parameter>visible_vertical</parameter> is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>
<parameter>tool_item</parameter> will not appear on toolbars that are docked vertically.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>visible_vertical</parameter>&#160;:</term>
<listitem><simpara> whether <parameter>tool_item</parameter> is visible when the toolbar
is in vertical mode
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-visible-vertical" role="function" condition="since:2.4">
<title>gtk_tool_item_get_visible_vertical ()</title>
<indexterm zone="gtk-tool-item-get-visible-vertical" role="2.4"><primary sortas="tool_item_get_visible_vertical">gtk_tool_item_get_visible_vertical</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_visible_vertical  (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns whether <parameter>tool_item</parameter> is visible when the toolbar is docked vertically.
See <link linkend="gtk-tool-item-set-visible-vertical"><function>gtk_tool_item_set_visible_vertical()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Whether <parameter>tool_item</parameter> is visible when the toolbar is docked vertically

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-is-important" role="function" condition="since:2.4">
<title>gtk_tool_item_set_is_important ()</title>
<indexterm zone="gtk-tool-item-set-is-important" role="2.4"><primary sortas="tool_item_set_is_important">gtk_tool_item_set_is_important</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_is_important      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         <link linkend="gboolean">gboolean</link> is_important);</programlisting>
<para>
Sets whether <parameter>tool_item</parameter> should be considered important. The <link linkend="GtkToolButton"><type>GtkToolButton</type></link>
class uses this property to determine whether to show or hide its label
when the toolbar style is <link linkend="GTK-TOOLBAR-BOTH-HORIZ--CAPS"><literal>GTK_TOOLBAR_BOTH_HORIZ</literal></link>. The result is that
only tool buttons with the "is_important" property set have labels, an
effect known as "priority text"</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>is_important</parameter>&#160;:</term>
<listitem><simpara> whether the tool item should be considered important
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-is-important" role="function" condition="since:2.4">
<title>gtk_tool_item_get_is_important ()</title>
<indexterm zone="gtk-tool-item-get-is-important" role="2.4"><primary sortas="tool_item_get_is_important">gtk_tool_item_get_is_important</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            gtk_tool_item_get_is_important      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns whether <parameter>tool_item</parameter> is considered important. See
<link linkend="gtk-tool-item-set-is-important"><function>gtk_tool_item_set_is_important()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>tool_item</parameter> is considered important.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-icon-size" role="function" condition="since:2.4">
<title>gtk_tool_item_get_icon_size ()</title>
<indexterm zone="gtk-tool-item-get-icon-size" role="2.4"><primary sortas="tool_item_get_icon_size">gtk_tool_item_get_icon_size</primary></indexterm><programlisting><link linkend="GtkIconSize">GtkIconSize</link>         gtk_tool_item_get_icon_size         (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns the icon size used for <parameter>tool_item</parameter>. Custom subclasses of
<link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function to find out what size icons
they should use.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkIconSize"><type>GtkIconSize</type></link> indicating the icon size used for <parameter>tool_item</parameter>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-orientation" role="function" condition="since:2.4">
<title>gtk_tool_item_get_orientation ()</title>
<indexterm zone="gtk-tool-item-get-orientation" role="2.4"><primary sortas="tool_item_get_orientation">gtk_tool_item_get_orientation</primary></indexterm><programlisting><link linkend="GtkOrientation">GtkOrientation</link>      gtk_tool_item_get_orientation       (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns the orientation used for <parameter>tool_item</parameter>. Custom subclasses of
<link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function to find out what size icons
they should use.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkOrientation"><type>GtkOrientation</type></link> indicating the orientation
used for <parameter>tool_item</parameter>

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-toolbar-style" role="function" condition="since:2.4">
<title>gtk_tool_item_get_toolbar_style ()</title>
<indexterm zone="gtk-tool-item-get-toolbar-style" role="2.4"><primary sortas="tool_item_get_toolbar_style">gtk_tool_item_get_toolbar_style</primary></indexterm><programlisting><link linkend="GtkToolbarStyle">GtkToolbarStyle</link>     gtk_tool_item_get_toolbar_style     (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns the toolbar style used for <parameter>tool_item</parameter>. Custom subclasses of
<link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function in the handler of the
GtkToolItem::toolbar_reconfigured signal to find out in what style
the toolbar is displayed and change themselves accordingly 
</para>
<para>
Possibilities are:
<itemizedlist>
<listitem> GTK_TOOLBAR_BOTH, meaning the tool item should show
both an icon and a label, stacked vertically </listitem>
<listitem> GTK_TOOLBAR_ICONS, meaning the toolbar shows
only icons </listitem>
<listitem> GTK_TOOLBAR_TEXT, meaning the tool item should only
show text</listitem>
<listitem> GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
both an icon and a label, arranged horizontally (however, note the 
<link linkend="GtkToolButton-has-text-horizontally"><type>"has_text_horizontally"</type></link> that makes tool buttons not
show labels when the toolbar style is GTK_TOOLBAR_BOTH_HORIZ.
</listitem>
</itemizedlist></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> A <link linkend="GtkToolbarStyle"><type>GtkToolbarStyle</type></link> indicating the toolbar style used
for <parameter>tool_item</parameter>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-relief-style" role="function" condition="since:2.4">
<title>gtk_tool_item_get_relief_style ()</title>
<indexterm zone="gtk-tool-item-get-relief-style" role="2.4"><primary sortas="tool_item_get_relief_style">gtk_tool_item_get_relief_style</primary></indexterm><programlisting><link linkend="GtkReliefStyle">GtkReliefStyle</link>      gtk_tool_item_get_relief_style      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns the relief style of <parameter>tool_item</parameter>. See <link linkend="gtk-button-set-relief-style"><function>gtk_button_set_relief_style()</function></link>.
Custom subclasses of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> should call this function in the handler
of the <link linkend="GtkToolItem-toolbar-reconfigured"><type>"toolbar_reconfigured"</type></link> signal to find out the
relief style of buttons.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a <link linkend="GtkReliefStyle"><type>GtkReliefStyle</type></link> indicating the relief style used
for <parameter>tool_item</parameter>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-retrieve-proxy-menu-item" role="function" condition="since:2.4">
<title>gtk_tool_item_retrieve_proxy_menu_item ()</title>
<indexterm zone="gtk-tool-item-retrieve-proxy-menu-item" role="2.4"><primary sortas="tool_item_retrieve_proxy_menu_item">gtk_tool_item_retrieve_proxy_menu_item</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gtk_tool_item_retrieve_proxy_menu_item
                                                        (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Returns the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that was last set by
<link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link>, ie. the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>
that is going to appear in the overflow menu.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> that is going to appear in the
overflow menu for <parameter>tool_item</parameter>.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-get-proxy-menu-item" role="function" condition="since:2.4">
<title>gtk_tool_item_get_proxy_menu_item ()</title>
<indexterm zone="gtk-tool-item-get-proxy-menu-item" role="2.4"><primary sortas="tool_item_get_proxy_menu_item">gtk_tool_item_get_proxy_menu_item</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gtk_tool_item_get_proxy_menu_item   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *menu_item_id);</programlisting>
<para>
If <parameter>menu_item_id</parameter> matches the string passed to
<link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link> return the corresponding <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link>.
</para>
<para>
Custom subclasses of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> should use this function to update
their menu item when the <link linkend="GtkToolItem"><type>GtkToolItem</type></link> changes. That the
<parameter>menu_item_id</parameter><!-- -->s must match ensures that a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> will not
inadvertently change a menu item that they did not create.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link> 
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_item_id</parameter>&#160;:</term>
<listitem><simpara> a string used to identify the menu item
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> The <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> passed to
<link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link>, if the <parameter>menu_item_id</parameter><!-- -->s match.

</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-set-proxy-menu-item" role="function" condition="since:2.4">
<title>gtk_tool_item_set_proxy_menu_item ()</title>
<indexterm zone="gtk-tool-item-set-proxy-menu-item" role="2.4"><primary sortas="tool_item_set_proxy_menu_item">gtk_tool_item_set_proxy_menu_item</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_set_proxy_menu_item   (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                         const <link linkend="gchar">gchar</link> *menu_item_id,
                                                         <link linkend="GtkWidget">GtkWidget</link> *menu_item);</programlisting>
<para>
Sets the <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> used in the toolbar overflow menu. The
<parameter>menu_item_id</parameter> is used to identify the caller of this function and
should also be used with <link linkend="gtk-tool-item-get-proxy-menu-item"><function>gtk_tool_item_get_proxy_menu_item()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_item_id</parameter>&#160;:</term>
<listitem><simpara> a string used to identify <parameter>menu_item</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>menu_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkMenuItem"><type>GtkMenuItem</type></link> to be used in the overflow menu
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.4</para></refsect2>
<refsect2 id="gtk-tool-item-rebuild-menu" role="function" condition="since:2.6">
<title>gtk_tool_item_rebuild_menu ()</title>
<indexterm zone="gtk-tool-item-rebuild-menu" role="2.6"><primary sortas="tool_item_rebuild_menu">gtk_tool_item_rebuild_menu</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_rebuild_menu          (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Calling this function signals to the toolbar that the
overflow menu item for <parameter>tool_item</parameter> has changed. If the
overflow menu is visible when this function it called,
the menu will be rebuilt.
</para>
<para>
The function must be called when the tool item
changes what it will do in response to the "create_menu_proxy"
signal.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.6</para></refsect2>
<refsect2 id="gtk-tool-item-toolbar-reconfigured" role="function" condition="since:2.14">
<title>gtk_tool_item_toolbar_reconfigured ()</title>
<indexterm zone="gtk-tool-item-toolbar-reconfigured" role="2.14"><primary sortas="tool_item_toolbar_reconfigured">gtk_tool_item_toolbar_reconfigured</primary></indexterm><programlisting><link linkend="void">void</link>                gtk_tool_item_toolbar_reconfigured  (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item);</programlisting>
<para>
Emits the signal <link linkend="GtkToolItem-toolbar-reconfigured"><type>"toolbar_reconfigured"</type></link> on <parameter>tool_item</parameter>.
<link linkend="GtkToolbar"><type>GtkToolbar</type></link> and other <link linkend="GtkToolShell"><type>GtkToolShell</type></link> implementations use this function
to notify children, when some aspect of their configuration changes.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> a <link linkend="GtkToolItem"><type>GtkToolItem</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 2.14</para></refsect2>

</refsect1>
<refsect1 id="GtkToolItem.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkToolItem--is-important" role="property"><title>The <literal>&quot;is-important&quot;</literal> property</title>
<indexterm zone="GtkToolItem--is-important"><primary sortas="ToolItem:is-important">GtkToolItem:is-important</primary></indexterm><programlisting>  &quot;is-important&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Whether the toolbar item is considered important. When TRUE, toolbar buttons show text in GTK_TOOLBAR_BOTH_HORIZ mode.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2 id="GtkToolItem--visible-horizontal" role="property"><title>The <literal>&quot;visible-horizontal&quot;</literal> property</title>
<indexterm zone="GtkToolItem--visible-horizontal"><primary sortas="ToolItem:visible-horizontal">GtkToolItem:visible-horizontal</primary></indexterm><programlisting>  &quot;visible-horizontal&quot;       <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Whether the toolbar item is visible when the toolbar is in a horizontal orientation.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2 id="GtkToolItem--visible-vertical" role="property"><title>The <literal>&quot;visible-vertical&quot;</literal> property</title>
<indexterm zone="GtkToolItem--visible-vertical"><primary sortas="ToolItem:visible-vertical">GtkToolItem:visible-vertical</primary></indexterm><programlisting>  &quot;visible-vertical&quot;         <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>Whether the toolbar item is visible when the toolbar is in a vertical orientation.</para><para>Default value: TRUE</para>
</refsect2>
</refsect1>

<refsect1 id="GtkToolItem.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="GtkToolItem-create-menu-proxy" role="signal"><title>The <literal>&quot;create-menu-proxy&quot;</literal> signal</title>
<indexterm zone="GtkToolItem-create-menu-proxy"><primary sortas="ToolItem::create-menu-proxy">GtkToolItem::create-menu-proxy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last</programlisting>
<para>
This signal is emitted when the toolbar needs information from <parameter>tool_item</parameter>
about whether the item should appear in the toolbar overflow menu. In
response the tool item should either
<itemizedlist>
<listitem>call <link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link> with a <link linkend="NULL--CAPS"><literal>NULL</literal></link>
pointer and return <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> to indicate that the item should not appear
in the overflow menu
</listitem>
<listitem> call <link linkend="gtk-tool-item-set-proxy-menu-item"><function>gtk_tool_item_set_proxy_menu_item()</function></link> with a new menu
item and return <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>, or
</listitem>
<listitem> return <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> to indicate that the signal was not
handled by the item. This means that
the item will not appear in the overflow menu unless a later handler
installs a menu item.
</listitem>
</itemizedlist>
</para>
<para>
The toolbar may cache the result of this signal. When the tool item changes
how it will respond to this signal it must call <link linkend="gtk-tool-item-rebuild-menu"><function>gtk_tool_item_rebuild_menu()</function></link>
to invalidate the cache and ensure that the toolbar rebuilds its overflow
menu.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> the object the signal was emitted on
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the signal was handled, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if not
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkToolItem-set-tooltip" role="signal"><title>The <literal>&quot;set-tooltip&quot;</literal> signal</title>
<indexterm zone="GtkToolItem-set-tooltip" role="deprecated"><primary sortas="ToolItem::set-tooltip">GtkToolItem::set-tooltip</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                        <link linkend="GtkTooltips">GtkTooltips</link> *tooltips,
                                                        <link linkend="gchar">gchar</link>       *tip_text,
                                                        <link linkend="gchar">gchar</link>       *tip_private,
                                                        <link linkend="gpointer">gpointer</link>     user_data)        : Run Last</programlisting>
<para>
This signal is emitted when the toolitem's tooltip changes.
Application developers can use <link linkend="gtk-tool-item-set-tooltip"><function>gtk_tool_item_set_tooltip()</function></link> to
set the item's tooltip.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> the object the signal was emitted on
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tooltips</parameter>&#160;:</term>
<listitem><simpara> the <link linkend="GtkTooltips"><type>GtkTooltips</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tip_text</parameter>&#160;:</term>
<listitem><simpara> the tooltip text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tip_private</parameter>&#160;:</term>
<listitem><simpara> the tooltip private text
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the signal was handled, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if not

</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2 id="GtkToolItem-toolbar-reconfigured" role="signal"><title>The <literal>&quot;toolbar-reconfigured&quot;</literal> signal</title>
<indexterm zone="GtkToolItem-toolbar-reconfigured"><primary sortas="ToolItem::toolbar-reconfigured">GtkToolItem::toolbar-reconfigured</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="GtkToolItem">GtkToolItem</link> *tool_item,
                                                        <link linkend="gpointer">gpointer</link>     user_data)      : Run Last</programlisting>
<para>
This signal is emitted when some property of the toolbar that the
item is a child of changes. For custom subclasses of <link linkend="GtkToolItem"><type>GtkToolItem</type></link>,
the default handler of this signal use the functions
<itemizedlist>
<listitem><link linkend="gtk-tool-shell-get-orientation"><function>gtk_tool_shell_get_orientation()</function></link></listitem>
<listitem><link linkend="gtk-tool-shell-get-style"><function>gtk_tool_shell_get_style()</function></link></listitem>
<listitem><link linkend="gtk-tool-shell-get-icon-size"><function>gtk_tool_shell_get_icon_size()</function></link></listitem>
<listitem><link linkend="gtk-tool-shell-get-relief-style"><function>gtk_tool_shell_get_relief_style()</function></link></listitem>
</itemizedlist>
to find out what the toolbar should look like and change
themselves accordingly.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>tool_item</parameter>&#160;:</term>
<listitem><simpara> the object the signal was emitted on
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>


<refsect1 id="GtkToolItem.see-also">
<title>See Also</title>
<variablelist>
  <varlistentry>
    <term><link linkend="GtkToolbar"><type>GtkToolbar</type></link></term>
    <listitem><para>The toolbar widget</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><link linkend="GtkToolButton"><type>GtkToolButton</type></link></term>
    <listitem><para>A subclass of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> that displays buttons on
        the toolbar</para></listitem>
  </varlistentry>
  <varlistentry>
    <term><link linkend="GtkSeparatorToolItem"><type>GtkSeparatorToolItem</type></link></term>
    <listitem><para>A subclass of <link linkend="GtkToolItem"><type>GtkToolItem</type></link> that separates groups of
        items on a toolbar</para></listitem>
  </varlistentry>
</variablelist>
</refsect1>

</refentry>
