File: class-gtkseparatortoolitem.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 (34 lines) | stat: -rw-r--r-- 9,835 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
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.SeparatorToolItem</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-gtkseparatormenuitem.html" title="gtk.SeparatorMenuItem"><link rel="next" href="class-gtksettings.html" title="gtk.Settings"></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.SeparatorToolItem</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkseparatormenuitem.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtksettings.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkseparatortoolitem"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.SeparatorToolItem</h2><p>gtk.SeparatorToolItem &#8212; a toolbar item that separates groups of other toolbar
items (new in PyGTK 2.4)</p></div><div class="refsect1" lang="en"><a name="id3501959"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.SeparatorToolItem</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtktoolitem.html" title="gtk.ToolItem">gtk.ToolItem</a></span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a href="class-gtkseparatortoolitem.html#constructor-gtkseparatortoolitem" title="Constructor">gtk.SeparatorToolItem</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkseparatortoolitem.html#method-gtkseparatortoolitem--get-draw" title="gtk.SeparatorToolItem.get_draw">get_draw</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkseparatortoolitem.html#method-gtkseparatortoolitem--set-draw" title="gtk.SeparatorToolItem.set_draw">set_draw</a></span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>draw</tt></b></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3502039"></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-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem">gtk.SeparatorToolItem</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3502094"></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">"draw"</td><td valign="top">Read-Write</td><td valign="top">If <tt class="literal">TRUE</tt>, the separator is
	      drawn. Available in GTK+ 2.4.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3502168"></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.4 and above.</p></div><p>A <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a>
is a <a href="class-gtktoolitem.html" title="gtk.ToolItem"><tt class="classname">gtk.ToolItem</tt></a> that
separates groups of other <a href="class-gtktoolitem.html" title="gtk.ToolItem"><tt class="classname">gtk.ToolItem</tt></a>
objects. Depending on the theme, a <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a>
will often look like a vertical line on horizontally docked toolbars.</p><p>If the <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a>
is set to expand (using the <a href="class-gtktoolitem.html#method-gtktoolitem--set-expand" title="gtk.ToolItem.set_expand"><tt class="methodname">gtk.ToolItem.set_expand</tt>()</a>
method) and the "draw" property is <tt class="literal">FALSE</tt>, a <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a>
will act as a "spring" that forces other items to the ends of the
toolbar.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkseparatortoolitem"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.SeparatorToolItem</span>(<span class="methodparam"></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 new <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a>

Since: 2.4</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.4 and above.</p></div><p>Create a new <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a></p></div><div class="refsect1" lang="en"><a name="id3502324"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkseparatortoolitem--get-draw"></a><h3>gtk.SeparatorToolItem.get_draw</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_draw</span>(<span class="methodparam"></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><tt class="literal">TRUE</tt> if
	  <i class="parameter"><tt>separator_tool_item</tt></i> is drawn as a line, or
	  just blank.</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.4 and above.</p></div><p>The <tt class="methodname">get_draw</tt>() method returns
<tt class="literal">TRUE</tt> if the separator tool item is drawn as a line or
<tt class="literal">FALSE</tt>, if it's just blank. See the <a href="class-gtkseparatortoolitem.html#method-gtkseparatortoolitem--set-draw" title="gtk.SeparatorToolItem.set_draw"><tt class="methodname">set_draw()</tt></a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkseparatortoolitem--set-draw"></a><h3>gtk.SeparatorToolItem.set_draw</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_draw</span>(<span class="methodparam"><span class="parameter"><b class="parameter"><tt>draw</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>draw</tt></b>:</span></td><td>if <tt class="literal">TRUE</tt> the <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a>
	  is drawn as a vertical line</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.4 and above.</p></div><p>The <tt class="methodname">set_draw</tt>() method sets the "draw"
property to the value of <i class="parameter"><tt>draw</tt></i>. If
<i class="parameter"><tt>draw</tt></i> is <tt class="literal">TRUE</tt> the <a href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><tt class="classname">gtk.SeparatorToolItem</tt></a>
is drawn as a vertical line; if <tt class="literal">FALSE</tt>, just blank.
Setting the "draw" property to <tt class="literal">FALSE</tt> along with passing
TRUE to the <a href="class-gtktoolitem.html#method-gtktoolitem--set-expand" title="gtk.ToolItem.set_expand"><tt class="methodname">gtk.ToolItem.set_expand</tt>()</a>
is useful to create an item that forces following items to the end of the
toolbar.</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-gtkseparatormenuitem.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-gtksettings.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.SeparatorMenuItem</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.Settings</td></tr></table></div></body></html>