<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="class-gtktoolshell">
    <refnamediv>
        <refname>gtk.ToolShell</refname>
        <refpurpose>Interface for containers containing GtkToolItem widgets.</refpurpose>
    </refnamediv>

    <refsect1>
        <title>Synopsis</title>

    <classsynopsis language="python">
        <ooclass><classname>gtk.ToolShell</classname></ooclass>
        <ooclass><classname><link linkend="class-ginterface">gobject.GInterface</link></classname></ooclass>
    
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtktoolshell--get-icon-size">get_icon_size</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtktoolshell--get-orientation">get_orientation</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtktoolshell--get-relief-style">get_relief_style</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtktoolshell--get-style">get_style</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    <methodsynopsis language="python">
        <methodname><link linkend="method-gtktoolshell--rebuild-menu">rebuild_menu</link></methodname>
        <methodparam></methodparam>
    </methodsynopsis>
    
    </classsynopsis>
    </refsect1>

    <refsect1>
        <title>Ancestry</title>

<synopsis>+-- <link linkend="class-ginterface">gobject.GInterface</link>
  +-- <link linkend="class-gtktoolshell">gtk.ToolShell</link>
</synopsis>

    </refsect1>

    <refsect1>
        <title>Known Implementation</title>
        <para>
            <link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link>
            is implementated by 
            <link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>,
            <link linkend="class-gtktoolitemgroup"><classname>gtk.ToolItemGroup</classname></link>
        </para>
    </refsect1>

    <refsect1>
        <title>Description</title>

        <para>
            The <link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link>
            interface allows container widgets to provide additional information when embedding GtkToolItem widgets. 
            see_also: <link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link>,
            <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
        </para>
    </refsect1>

    <refsect1>
        <title>Methods</title>

        <refsect2 id="method-gtktoolshell--get-icon-size">
            <title>gtk.ToolShell.get_icon_size</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_icon_size</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>The current size for icons of shell.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>
    
            <para>
                The <methodname>get_icon_size</methodname>() method retrieves the
                icon size for the tool shell. Tool items must not call this
                function directly, but rely on
                <methodname><link linkend="method-gtktoolitem--get-icon-size">gtk.ToolItem.get_icon_size</link></methodname>()
                instead.
            </para>
        </refsect2>

        <refsect2 id="method-gtktoolshell--get-orientation">
            <title>gtk.ToolShell.get_orientation</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_orientation</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>The current orientation of shell.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>
    
            <para>
                The <methodname>get_orientation</methodname>() method retrieves the
                current orientation for the tool shell. Tool items must not call
                this function directly, but rely on
                <methodname><link linkend="method-gtktoolitem--get-orientation">gtk.ToolItem.get_orientation</link></methodname>()
                instead.
            </para>
        </refsect2>

        <refsect2 id="method-gtktoolshell--get-relief-style">
            <title>gtk.ToolShell.get_relief_style</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_relief_style</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>The relief style of buttons on shell.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>
    
            <para>
                The <methodname>get_relief_style</methodname>() method returns the relief
                style of buttons on shell. Tool items must not call this function directly, but rely on 
                <methodname><link linkend="method-gtktoolitem--get-relief-style">gtk.ToolItem.get_relief_style</link></methodname>()
                instead.
            </para>
        </refsect2>

        <refsect2 id="method-gtktoolshell--get-style">
            <title>gtk.ToolShell.get_style</title>

            <programlisting><methodsynopsis language="python">
                <methodname>get_style</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem><simpara>The current style of shell.</simpara></listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>
    
            <para>
                The <methodname>get_style</methodname>() method retrieves whether the tool
                shell has text, icons, or both. Tool items must not call this function directly, but rely on 
                <methodname><link linkend="method-gtktoolitem--get-style">gtk.ToolItem.get_style</link></methodname>()
                instead.
            </para>
        </refsect2>

        <refsect2 id="method-gtktoolshell--rebuild-menu">
            <title>gtk.ToolShell.rebuild_menu</title>

            <programlisting><methodsynopsis language="python">
                <methodname>rebuild_menu</methodname>
                <methodparam></methodparam>
            </methodsynopsis></programlisting>
            
            <variablelist>
                <varlistentry>
                    <term><emphasis>Returns</emphasis>&nbsp;:</term>
                        <listitem>
                        </listitem>
                </varlistentry>
            </variablelist>

            <note>
                <para>This method is available in PyGTK 2.14 and above.</para>
            </note>
    
            <para>
                The <methodname>rebuild_menu</methodname>() method calling this function signals the
                tool shell that the overflow menu item for tool items have changed.
                If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.
                Tool items must not call this function directly, but rely on
                <methodname><link linkend="method-gtktoolitem--get-relief-style">gtk.ToolItem.get_relief_style</link></methodname>()
                instead.
            </para>
        </refsect2>
    </refsect1>
</refentry>
