<?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-gtkmenutoolbutton">
  <refnamediv>
    <refname>gtk.MenuToolButton</refname>
    <refpurpose>A <link
linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
containing a button with an additional dropdown menu (new in PyGTK
2.6)</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

<classsynopsis language="python">
  <ooclass><classname>gtk.MenuToolButton</classname></ooclass>
  <ooclass><classname><link linkend="class-gtktoolbutton">gtk.ToolButton</link></classname></ooclass>
<constructorsynopsis language="python">
    <methodname><link linkend="constructor-gtkmenutoolbutton1">gtk.MenuToolButton</link></methodname>
    <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
  </constructorsynopsis>
<constructorsynopsis language="python">
    <methodname><link linkend="constructor-gtkmenutoolbutton2">gtk.MenuToolButton</link></methodname>
    <methodparam><parameter role="keyword">icon_widget</parameter></methodparam>
    <methodparam><parameter role="keyword">label</parameter></methodparam>
  </constructorsynopsis>
<methodsynopsis language="python">
    <methodname><link linkend="method-gtkmenutoolbutton--set-menu">set_menu</link></methodname>
    <methodparam><parameter role="keyword">menu</parameter></methodparam>
  </methodsynopsis>
<methodsynopsis language="python">
    <methodname><link linkend="method-gtkmenutoolbutton--get-menu">get_menu</link></methodname>
    <methodparam></methodparam>
  </methodsynopsis>
<methodsynopsis language="python">
    <methodname><link linkend="method-gtkmenutoolbutton--set-arrow-tooltip">set_arrow_tooltip</link></methodname>
    <methodparam><parameter role="keyword">tooltips</parameter></methodparam>
    <methodparam><parameter role="keyword">tip_text</parameter></methodparam>
    <methodparam><parameter role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
  </methodsynopsis>
<methodsynopsis language="python">
    <methodname><link linkend="method-gtkmenutoolbutton--set-arrow-tooltip-markup">set_arrow_tooltip_markup</link></methodname>
    <methodparam><parameter role="keyword">markup</parameter></methodparam>
  </methodsynopsis>
<methodsynopsis language="python">
    <methodname><link linkend="method-gtkmenutoolbutton--set-arrow-tooltip-text">set_arrow_tooltip_text</link></methodname>
    <methodparam><parameter role="keyword">text</parameter></methodparam>
  </methodsynopsis>
</classsynopsis>

</refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
        +-- <link linkend="class-gtkbin">gtk.Bin</link>
          +-- <link linkend="class-gtktoolitem">gtk.ToolItem</link>
            +-- <link linkend="class-gtktoolbutton">gtk.ToolButton</link>
              +-- <link linkend="class-gtkmenutoolbutton">gtk.MenuToolButton</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>

  <refsect1 id="properties-gtkmenutoolbutton">
    <title>gtk.MenuToolButton Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container Properties</link></para>
    <para><link linkend="properties-gtktoolitem">gtk.ToolItem Properties</link></para>
    <para><link linkend="properties-gtktoolbutton">gtk.ToolButton Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"menu"</entry>
	      <entry>Read-Write</entry>
	      <entry>The dropdown <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>.</entry>
	    </row>

	  </tbody>
	</tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="style-properties-gtkmenutoolbutton">
    <title>gtk.MenuToolButton Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
    <para><link linkend="style-properties-gtktoolbutton">gtk.ToolButton Style Properties</link></para>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkmenutoolbutton">
    <title>gtk.MenuToolButton Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtktoolitem">gtk.ToolItem Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtktoolbutton">gtk.ToolButton Signal Prototypes</link></para>

    <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-gtkmenutoolbutton--show-menu">show-menu</link>"</term>
        <listitem>
          <methodsynopsis language="python"><methodname>callback</methodname>
            <methodparam><parameter>menutoolbutton</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <note>
      <para>This widget is available in PyGTK 2.6 and above.</para>
    </note>

    <para>A <link
linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
is a <link
linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link> that
contains a button and a small additional button with an arrow. When clicked,
the arrow button pops up a dropdown menu.</para>

  </refsect1>

  <refsect1>
    <title>Constructor</title>

    <refsect2 id="constructor-gtkmenutoolbutton1">
      <title>gtk.MenuToolButton</title>

      <programlisting><constructorsynopsis language="python">
          <methodname>gtk.MenuToolButton</methodname>
          <methodparam><parameter
                         role="keyword">stock_id</parameter></methodparam>
        </constructorsynopsis></programlisting>
      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">stock_id</parameter>&nbsp;:</term>
          <listitem><simpara></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link
linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This constructor is available in PyGTK 2.6 and above.</para>
      </note>

      <para>Creates a new <link
linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
using from the stock item specified by <parameter>stock_id</parameter>. The
new <link
linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
will contain the icon and label associated with
<parameter>stock_id</parameter>.</para>

    </refsect2>

    <refsect2 id="constructor-gtkmenutoolbutton2">
      <title>gtk.MenuToolButton</title>

      <programlisting><constructorsynopsis language="python">
          <methodname>gtk.MenuToolButton</methodname>
          <methodparam><parameter
                         role="keyword">icon_widget</parameter></methodparam>
          <methodparam><parameter
                         role="keyword">label</parameter></methodparam>
        </constructorsynopsis></programlisting>
      <variablelist>
        <varlistentry>
          <term><parameter role="keyword">icon_widget</parameter>&nbsp;:</term>
          <listitem><simpara>a widget that will be used as icon widget,
or <literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><parameter role="keyword">label</parameter>&nbsp;:</term>
          <listitem><simpara>a string that will be used as label, or
<literal>None</literal></simpara></listitem>
        </varlistentry>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a new <link
linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link></simpara></listitem>
        </varlistentry>
      </variablelist>

      <note>
        <para>This constructor is available in PyGTK 2.6 and above.</para>
      </note>

      <para>Creates a new <link
linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>
using the icon specified by <parameter>icon_widget</parameter> and the label
specified by <parameter>label</parameter>.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkmenutoolbutton--set-menu">
      <title>gtk.MenuToolButton.set_menu</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_menu</methodname>
	  <methodparam><parameter
			 role="keyword">menu</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">menu</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link linkend="class-gtkmenu"><classname>gtk.Menu</classname></link></simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>set_menu</methodname>() method sets the "menu"
property to the <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link> specified by
<parameter>menu</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkmenutoolbutton--get-menu">
      <title>gtk.MenuToolButton.get_menu</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_menu</methodname>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the associated <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link></simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.6 and above.</para>
      </note>

      <para>The <methodname>get_menu</methodname>() method returns the value
of the "menu" property that contains the associated <link
linkend="class-gtkmenu"><classname>gtk.Menu</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkmenutoolbutton--set-arrow-tooltip">
      <title>gtk.MenuToolButton.set_arrow_tooltip</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_arrow_tooltip</methodname>
	  <methodparam><parameter
			 role="keyword">tooltips</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">tip_text</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">tip_private</parameter><initializer>None</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">tooltips</parameter>&nbsp;:</term>
	  <listitem><simpara>A <link
linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
object.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">tip_text</parameter>&nbsp;:</term>
	  <listitem><simpara>The text to use as the tooltip or
<literal>None</literal></simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">tip_private</parameter>&nbsp;:</term>
	  <listitem><simpara>Opitonal private tooltip text or
<literal>None</literal>. Defaults to
<literal>None</literal>.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <warning>
        <para>This method is deprecated in PyGTK 2.12 and above.</para>
      </warning>

      <para>The <methodname>set_arrow_tooltip</methodname>() method sets the
tooltip data specified by <parameter>tip_text</parameter> for the arrow
button using the <link
linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
object specified by <parameter>tooltips</parameter>.</para>

    </refsect2>
    
    <refsect2 id="method-gtkmenutoolbutton--set-arrow-tooltip-markup">
        <title>gtk.MenuToolButton.set_arrow_tooltip_markup</title>

        <programlisting><methodsynopsis language="python">
        <methodname>set_arrow_tooltip_markup</methodname>
            <methodparam><parameter role="keyword">markup</parameter></methodparam>
        </methodsynopsis></programlisting>
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">markup</parameter>&nbsp;:</term>
                <listitem><simpara>Markup text to be used as tooltip text
                for button's arrow button.</simpara></listitem>
            </varlistentry>
        </variablelist>

        <note>
            <para>This method is available in PyGTK 2.12 and above.</para>
        </note>

        <para>
            The <methodname>set_arrow_tooltip_markup</methodname>() method sets the tooltip
            markup to be used as tooltip for the arrow button which pops up the menu. See
            <methodname><link linkend="method-gtktoolitem--set-tooltip">gtk.ToolItem.set_tooltip</link></methodname>()
            for setting a tooltip on the whole
            <link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>.
        </para>
    </refsect2>

    <refsect2 id="method-gtkmenutoolbutton--set-arrow-tooltip-text">
        <title>gtk.MenuToolButton.set_arrow_tooltip_text</title>

        <programlisting><methodsynopsis language="python">
        <methodname>set_arrow_tooltip_text</methodname>
            <methodparam><parameter role="keyword">text</parameter></methodparam>
        </methodsynopsis></programlisting>
        <variablelist>
            <varlistentry>
                <term><parameter role="keyword">text</parameter>&nbsp;:</term>
                <listitem><simpara>Text to be used as tooltip text for button's
                arrow button.</simpara></listitem>
            </varlistentry>
        </variablelist>

        <note>
            <para>This method is available in PyGTK 2.12 and above.</para>
        </note>

        <para>
            The <methodname>set_arrow_tooltip_markup</methodname>() method sets the tooltip
            text to be used as tooltip for the arrow button which pops up the menu. See
            <methodname><link linkend="method-gtktoolitem--set-tooltip">gtk.ToolItem.set_tooltip</link></methodname>()
            for setting a tooltip on the whole
            <link linkend="class-gtkmenutoolbutton"><classname>gtk.MenuToolButton</classname></link>.
        </para>
    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkmenutoolbutton--show-menu">
      <title>The "show-menu" gtk.MenuToolButton Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>menutoolbutton</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>menutoolbutton</parameter>&nbsp;:</term>
	  <listitem><simpara>the menutoolbutton that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This signal is available in GTK+ 2.6 and above.</para>
      </note>

      <para>The "show-menu" signal is emitted before the dropdown menu is
displayed.</para>

    </refsect2>

  </refsect1>

</refentry>
