File: class-gtkseparatortoolitem.html

package info (click to toggle)
pygtk 2.12.1-6
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 25,776 kB
  • ctags: 8,213
  • sloc: xml: 168,600; python: 14,328; sh: 9,131; ansic: 2,724; makefile: 1,141
file content (38 lines) | stat: -rw-r--r-- 12,126 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=utf-8"><title>gtk.SeparatorToolItem</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" 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 class="refnamediv"><h2>gtk.SeparatorToolItem</h2><p>gtk.SeparatorToolItem — a toolbar item that separates groups of other toolbar
items (new in PyGTK 2.4)</p></div><div class="refsect1" lang="en"><a name="id3480484"></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 class="link" href="class-gtktoolitem.html" title="gtk.ToolItem">gtk.ToolItem</a></span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a class="link" 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 class="link" 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 class="link" href="class-gtkseparatortoolitem.html#method-gtkseparatortoolitem--set-draw" title="gtk.SeparatorToolItem.set_draw">set_draw</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3480581"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
  +-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
    +-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
      +-- <a class="link" href="class-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
        +-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
          +-- <a class="link" href="class-gtktoolitem.html" title="gtk.ToolItem">gtk.ToolItem</a>
            +-- <a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem">gtk.SeparatorToolItem</a>
</pre></div><div class="refsect1" lang="en"><a name="id3480639"></a><h2>Implemented Interfaces</h2><p>
			<a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></a>
			implements 
			<a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
		</p></div><div class="refsect1" lang="en"><a name="properties-gtkseparatortoolitem"></a><h2>gtk.SeparatorToolItem Properties</h2><p><a class="link" href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a class="link" href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><p><a class="link" href="class-gtkcontainer.html#properties-gtkcontainer" title="gtk.Container Properties">gtk.Container Properties</a></p><p><a class="link" href="class-gtktoolitem.html#properties-gtktoolitem" title="gtk.ToolItem Properties">gtk.ToolItem Properties</a></p><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 <code class="literal">True</code>, 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="style-properties-gtkseparatortoolitem"></a><h2>gtk.SeparatorToolItem Style Properties</h2><p><a class="link" href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkseparatortoolitem"></a><h2>gtk.SeparatorToolItem Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a class="link" href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a class="link" href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a class="link" href="class-gtkcontainer.html#signal-prototypes-gtkcontainer" title="gtk.Container Signal Prototypes">gtk.Container Signal Prototypes</a></p><p><a class="link" href="class-gtktoolitem.html#signal-prototypes-gtktoolitem" title="gtk.ToolItem Signal Prototypes">gtk.ToolItem Signal Prototypes</a></p></div><div class="refsect1" lang="en"><a name="id3480848"></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 class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></a>
is a <a class="link" href="class-gtktoolitem.html" title="gtk.ToolItem"><code class="classname">gtk.ToolItem</code></a> that
separates groups of other <a class="link" href="class-gtktoolitem.html" title="gtk.ToolItem"><code class="classname">gtk.ToolItem</code></a>
objects. Depending on the theme, a <a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></a>
will often look like a vertical line on horizontally docked toolbars.</p><p>If the <a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></a>
is set to expand (using the <a class="link" href="class-gtktoolitem.html#method-gtktoolitem--set-expand" title="gtk.ToolItem.set_expand"><code class="methodname">gtk.ToolItem.set_expand</code>()</a>
method) and the "draw" property is <code class="literal">False</code>, a <a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></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><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.SeparatorToolItem</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the new <a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></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 class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></a></p></div><div class="refsect1" lang="en"><a name="id3481013"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkseparatortoolitem--get-draw"></a><h3>gtk.SeparatorToolItem.get_draw</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_draw</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if
	  <em class="parameter"><code>separator_tool_item</code></em> 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 <code class="methodname">get_draw</code>() method returns
<code class="literal">True</code> if the separator tool item is drawn as a line or
<code class="literal">False</code>, if it's just blank. See the <a class="link" href="class-gtkseparatortoolitem.html#method-gtkseparatortoolitem--set-draw" title="gtk.SeparatorToolItem.set_draw"><code class="methodname">set_draw()</code></a>
method.</p></div><div class="refsect2" lang="en"><a name="method-gtkseparatortoolitem--set-draw"></a><h3>gtk.SeparatorToolItem.set_draw</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_draw</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>draw</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>draw</code></strong> :</span></p></td><td>if <code class="literal">True</code> the <a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></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 <code class="methodname">set_draw</code>() method sets the "draw"
property to the value of <em class="parameter"><code>draw</code></em>. If
<em class="parameter"><code>draw</code></em> is <code class="literal">True</code> the <a class="link" href="class-gtkseparatortoolitem.html" title="gtk.SeparatorToolItem"><code class="classname">gtk.SeparatorToolItem</code></a>
is drawn as a vertical line; if <code class="literal">False</code>, just blank.
Setting the "draw" property to <code class="literal">False</code> along with passing
True to the <a class="link" href="class-gtktoolitem.html#method-gtktoolitem--set-expand" title="gtk.ToolItem.set_expand"><code class="methodname">gtk.ToolItem.set_expand</code>()</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>