File: class-gtkmenutoolbutton.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,304 kB
  • ctags: 3,741
  • sloc: makefile: 38
file content (38 lines) | stat: -rw-r--r-- 15,870 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.MenuToolButton</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="previous" href="class-gtkmenushell.html" title="gtk.MenuShell"><link rel="next" href="class-gtkmessagedialog.html" title="gtk.MessageDialog"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.MenuToolButton</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkmenushell.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtkmessagedialog.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkmenutoolbutton"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.MenuToolButton</h2><p>gtk.MenuToolButton &#8212; A <a href="class-gtktoolitem.html" title="gtk.ToolItem"><tt class="classname">gtk.ToolItem</tt></a>
containing a button with an additional dropdown menu (new in PyGTK
2.6)</p></div><div class="refsect1" lang="en"><a name="id3467765"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.MenuToolButton</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtktoolbutton.html" title="gtk.ToolButton">gtk.ToolButton</a></span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a href="class-gtkmenutoolbutton.html#constructor-gtkmenutoolbutton1" title="gtk.MenuToolButton">gtk.MenuToolButton</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>stock_id</tt></b></span></span>)</code><br><code class="constructorsynopsis">    <span class="methodname"><a href="class-gtkmenutoolbutton.html#constructor-gtkmenutoolbutton2" title="gtk.MenuToolButton">gtk.MenuToolButton</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>icon_widget</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkmenutoolbutton.html#method-gtkmenutoolbutton--set-menu" title="gtk.MenuToolButton.set_menu">set_menu</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>menu</tt></b></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkmenutoolbutton.html#method-gtkmenutoolbutton--get-menu" title="gtk.MenuToolButton.get_menu">get_menu</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkmenutoolbutton.html#method-gtkmenutoolbutton--set-arrow-tooltip" title="gtk.MenuToolButton.set_arrow_tooltip">set_arrow_tooltip</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>tooltips</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>tip_text</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>tip_private</tt></b></span><span class="initializer">=None</span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3467914"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
  +-- <a href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
    +-- <a href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
      +-- <a href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
        +-- <a href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
          +-- <a href="class-gtktoolitem.html" title="gtk.ToolItem">gtk.ToolItem</a>
            +-- <a href="class-gtktoolbutton.html" title="gtk.ToolButton">gtk.ToolButton</a>
              +-- <a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton">gtk.MenuToolButton</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3467975"></a><h2>Properties</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"menu"</td><td valign="top">Read-Write</td><td valign="top">The dropdown <a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a>.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3468052"></a><h2>Signal Prototypes</h2><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"<a href="class-gtkmenutoolbutton.html#signal-gtkmenutoolbutton--show-menu" title='The "show-menu" gtk.MenuToolButton Signal'>show-menu</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>menutoolbutton</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3468104"></a><h2>Description</h2><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This widget is available in PyGTK 2.6 and above.</p></div><p>A <a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><tt class="classname">gtk.MenuToolButton</tt></a>
is a <a href="class-gtktoolitem.html" title="gtk.ToolItem"><tt class="classname">gtk.ToolItem</tt></a> that
contains a button and a small additional button with an arrow. When clicked,
the arrow button pops up a dropdown menu.</p></div><div class="refsect1" lang="en"><a name="id3468141"></a><h2>Constructor</h2><div class="refsect2" lang="en"><a name="constructor-gtkmenutoolbutton1"></a><h3>gtk.MenuToolButton</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.MenuToolButton</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>stock_id</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>stock_id</tt></b>:</span></td><td></td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><tt class="classname">gtk.MenuToolButton</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.6 and above.</p></div><p>Creates a new <a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><tt class="classname">gtk.MenuToolButton</tt></a>
using from the stock item specified by <i class="parameter"><tt>stock_id</tt></i>. The
new <a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><tt class="classname">gtk.MenuToolButton</tt></a>
will contain the icon and label associated with
<i class="parameter"><tt>stock_id</tt></i>.</p></div><div class="refsect2" lang="en"><a name="constructor-gtkmenutoolbutton2"></a><h3>gtk.MenuToolButton</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.MenuToolButton</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>icon_widget</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>label</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>icon_widget</tt></b>:</span></td><td>a widget that will be used as icon widget,
or <tt class="literal">None</tt></td></tr><tr><td><span class="term"><b class="parameter"><tt>label</tt></b>:</span></td><td>a string that will be used as label, or
<tt class="literal">None</tt></td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><tt class="classname">gtk.MenuToolButton</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This constructor is available in PyGTK 2.6 and above.</p></div><p>Creates a new <a href="class-gtkmenutoolbutton.html" title="gtk.MenuToolButton"><tt class="classname">gtk.MenuToolButton</tt></a>
using the icon specified by <i class="parameter"><tt>icon_widget</tt></i> and the label
specified by <i class="parameter"><tt>label</tt></i>.</p></div></div><div class="refsect1" lang="en"><a name="id3468384"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkmenutoolbutton--set-menu"></a><h3>gtk.MenuToolButton.set_menu</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_menu</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>menu</tt></b></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>menu</tt></b>:</span></td><td>a <a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_menu</tt>() method sets the "menu"
property to the <a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a> specified by
<i class="parameter"><tt>menu</tt></i>.</p></div><div class="refsect2" lang="en"><a name="method-gtkmenutoolbutton--get-menu"></a><h3>gtk.MenuToolButton.get_menu</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_menu</span>()</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>the associated <a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">get_menu</tt>() method returns the value
of the "menu" property that contains the associated <a href="class-gtkmenu.html" title="gtk.Menu"><tt class="classname">gtk.Menu</tt></a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkmenutoolbutton--set-arrow-tooltip"></a><h3>gtk.MenuToolButton.set_arrow_tooltip</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_arrow_tooltip</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>tooltips</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>tip_text</tt></b></span></span>, <span class="methodparam"><span class="parameter"><b class="parameter"><tt>tip_private</tt></b></span><span class="initializer">=None</span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><b class="parameter"><tt>tooltips</tt></b>:</span></td><td>A <a href="class-gtktooltips.html" title="gtk.Tooltips"><tt class="classname">gtk.Tooltips</tt></a>
object.</td></tr><tr><td><span class="term"><b class="parameter"><tt>tip_text</tt></b>:</span></td><td>The text to use as the tooltip or
<tt class="literal">None</tt></td></tr><tr><td><span class="term"><b class="parameter"><tt>tip_private</tt></b>:</span></td><td>Opitonal private tooltip text or
<tt class="literal">None</tt>. Defaults to
<tt class="literal">None</tt>.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.6 and above.</p></div><p>The <tt class="methodname">set_arrow_tooltip</tt>() method sets the
tooltip data specified by <i class="parameter"><tt>tip_text</tt></i> for the arrow
button using the <a href="class-gtktooltips.html" title="gtk.Tooltips"><tt class="classname">gtk.Tooltips</tt></a>
object specified by <i class="parameter"><tt>tooltips</tt></i>.</p></div></div><div class="refsect1" lang="en"><a name="id3468699"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkmenutoolbutton--show-menu"></a><h3>The "show-menu" gtk.MenuToolButton Signal</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><i class="parameter"><tt>menutoolbutton</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>user_param1</tt></i></span></span>, <span class="methodparam"><span class="parameter"><i class="parameter"><tt>...</tt></i></span></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><i class="parameter"><tt>menutoolbutton</tt></i>:</span></td><td>the menutoolbutton that received the
signal</td></tr><tr><td><span class="term"><i class="parameter"><tt>user_param1</tt></i>:</span></td><td>the first user parameter (if any) specified
with the <a href="class-gobject.html#method-gobject--connect" title="gobject.GObject.connect"><tt class="methodname">connect</tt>()</a>
method</td></tr><tr><td><span class="term"><i class="parameter"><tt>...</tt></i>:</span></td><td>additional user parameters (if
any)</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This signal is available in GTK+ 2.6 and above.</p></div><p>The "show-menu" signal is emitted before the dropdown menu is
displayed.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkmenushell.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gtkmessagedialog.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.MenuShell</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.MessageDialog</td></tr></table></div></body></html>