← Back to branch summary

~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gtkarrow.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-01-07 11:08:47 UTC
  • mfrom: (1.2.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/class-gtkarrow.html
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Arrow</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-gtkalignment.html" title="gtk.Alignment"><link rel="next" href="class-gtkaspectframe.html" title="gtk.AspectFrame"></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.Arrow</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkalignment.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkaspectframe.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkarrow"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Arrow</h2><p>gtk.Arrow — produces an arrow pointing in one of the four cardinal
2
 
directions.</p></div><div class="refsect1" lang="en"><a name="id3044190"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Arrow</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkmisc.html" title="gtk.Misc">gtk.Misc</a></span></span>):
3
 
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkarrow.html#constructor-gtkarrow" title="Constructor">gtk.Arrow</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkarrow.html#method-gtkarrow--set" title="gtk.Arrow.set">set</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3141490"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Arrow</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.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="prev" href="class-gtkalignment.html" title="gtk.Alignment"><link rel="next" href="class-gtkaspectframe.html" title="gtk.AspectFrame"></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.Arrow</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkalignment.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkaspectframe.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.Arrow"><a name="class-gtkarrow"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Arrow</h2><p>gtk.Arrow — produces an arrow pointing in one of the four cardinal
 
2
directions.</p></div><div class="refsect1" title="Synopsis"><a name="id3499897"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Arrow</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkmisc.html" title="gtk.Misc">gtk.Misc</a></span></span>):
 
3
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkarrow.html#constructor-gtkarrow" title="Constructor">gtk.Arrow</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkarrow.html#method-gtkarrow--set" title="gtk.Arrow.set">set</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3359834"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
4
4
  +-- <a class="link" href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
5
5
    +-- <a class="link" href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
6
6
      +-- <a class="link" href="class-gtkmisc.html" title="gtk.Misc">gtk.Misc</a>
7
7
        +-- <a class="link" href="class-gtkarrow.html" title="gtk.Arrow">gtk.Arrow</a>
8
 
</pre></div><div class="refsect1" lang="en"><a name="id3073329"></a><h2>Implemented Interfaces</h2><p>
 
8
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3394764"></a><h2>Implemented Interfaces</h2><p>
9
9
                        <a class="link" href="class-gtkarrow.html" title="gtk.Arrow"><code class="classname">gtk.Arrow</code></a>
10
10
                        implements 
11
11
                        <a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
12
 
                </p></div><div class="refsect1" lang="en"><a name="properties-gtkarrow"></a><h2>gtk.Arrow 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-gtkmisc.html#properties-gtkmisc" title="gtk.Misc Properties">gtk.Misc 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">"arrow-type"</td><td valign="top">Read/Write</td><td valign="top">The direction the arrow should point (gtk.ARROW_UP,
 
12
                </p></div><div class="refsect1" title="gtk.Arrow Properties"><a name="properties-gtkarrow"></a><h2>gtk.Arrow 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-gtkmisc.html#properties-gtkmisc" title="gtk.Misc Properties">gtk.Misc 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 width="1in"><col width="1in"><col width="4.5in"></colgroup><tbody><tr valign="top"><td valign="top">"arrow-type"</td><td valign="top">Read/Write</td><td valign="top">The direction the arrow should point (gtk.ARROW_UP,
13
13
gtk.ARROW_DOWN, gtk.ARROW_LEFT, or gtk.ARROW_RIGHT)</td></tr><tr valign="top"><td valign="top">"shadow-type"</td><td valign="top">Read/Write</td><td valign="top">Appearance of the shadow surrounding the arrow
14
14
          (<code class="literal">gtk.SHADOW IN, gtk.SHADOW OUT, gtk.ETCHED IN, or
15
 
          gtk.ETCHED OUT</code>)</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkarrow"></a><h2>gtk.Arrow 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-gtkarrow"></a><h2>gtk.Arrow 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></div><div class="refsect1" lang="en"><a name="id3161893"></a><h2>Description</h2><p>The <a class="link" href="class-gtkarrow.html" title="gtk.Arrow"><code class="classname">gtk.Arrow</code></a> is used to
 
15
          gtk.ETCHED OUT</code>)</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.Arrow Style Properties"><a name="style-properties-gtkarrow"></a><h2>gtk.Arrow 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" title="gtk.Arrow Signal Prototypes"><a name="signal-prototypes-gtkarrow"></a><h2>gtk.Arrow 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></div><div class="refsect1" title="Description"><a name="id3062766"></a><h2>Description</h2><p>The <a class="link" href="class-gtkarrow.html" title="gtk.Arrow"><code class="classname">gtk.Arrow</code></a> is used to
16
16
draw simple arrows that point in one of the four cardinal directions
17
17
(gtk.ARROW_UP, gtk.ARROW_DOWN, gtk.ARROW_LEFT, or gtk.ARROW_RIGHT). The
18
18
shadow style of the arrow can be one of gtk.SHADOW IN, gtk.SHADOW OUT,
20
20
any space alloted to it, but since it is inherited from <a class="link" href="class-gtkmisc.html" title="gtk.Misc"><code class="classname">gtk.Misc</code></a>, it can be
21
21
padded and/or aligned, to fill exactly the space desired.</p><p>Arrows are created with a call to <a class="link" href="class-gtkarrow.html#constructor-gtkarrow" title="Constructor"><code class="methodname">gtk.Arrow</code>()</a>.
22
22
The direction or style of an arrow can be changed after creation by using
23
 
<a class="link" href="class-gtkarrow.html#method-gtkarrow--set" title="gtk.Arrow.set"><code class="methodname">arrow_set</code>()</a>.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkarrow"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.Arrow</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</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>arrow_type</code></strong> :</span></p></td><td>one of the <a class="xref" href="gtk-constants.html#gtk-arrow-type-constants" title="GTK Arrow Type Constants">GTK Arrow Type Constants</a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>shadow_type</code></strong> :</span></p></td><td>one
 
23
<a class="link" href="class-gtkarrow.html#method-gtkarrow--set" title="gtk.Arrow.set"><code class="methodname">arrow_set</code>()</a>.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkarrow"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.Arrow</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</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>arrow_type</code></strong> :</span></p></td><td>one of the <a class="xref" href="gtk-constants.html#gtk-arrow-type-constants" title="GTK Arrow Type Constants">GTK Arrow Type Constants</a></td></tr><tr><td><p><span class="term"><strong class="parameter"><code>shadow_type</code></strong> :</span></p></td><td>one
24
24
of the <a class="xref" href="gtk-constants.html#gtk-shadow-type-constants" title="GTK Shadow Type Constants">GTK Shadow Type Constants</a></td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gtkarrow.html" title="gtk.Arrow"><code class="classname">gtk.Arrow</code></a>
25
25
        widget</td></tr></tbody></table><p>Creates a new arrow widget with the specified
26
26
<em class="parameter"><code>arrow_type</code></em> and
27
 
<em class="parameter"><code>arrow_shadow</code></em>.</p></div><div class="refsect1" lang="en"><a name="id3109906"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkarrow--set"></a><h3>gtk.Arrow.set</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</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>arrow_type</code></strong> :</span></p></td><td>a GtkArrowType</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>shadow_type</code></strong> :</span></p></td><td>one of the <a class="xref" href="gtk-constants.html#gtk-shadow-type-constants" title="GTK Shadow Type Constants">GTK Shadow Type Constants</a></td></tr></tbody></table><p>The <code class="methodname">set</code>() method sets the
 
27
<em class="parameter"><code>arrow_shadow</code></em>.</p></div><div class="refsect1" title="Methods"><a name="id3653942"></a><h2>Methods</h2><div class="refsect2" title="gtk.Arrow.set"><a name="method-gtkarrow--set"></a><h3>gtk.Arrow.set</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>arrow_type</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>shadow_type</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>arrow_type</code></strong> :</span></p></td><td>a GtkArrowType</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>shadow_type</code></strong> :</span></p></td><td>one of the <a class="xref" href="gtk-constants.html#gtk-shadow-type-constants" title="GTK Shadow Type Constants">GTK Shadow Type Constants</a></td></tr></tbody></table><p>The <code class="methodname">set</code>() method sets the
28
28
<em class="parameter"><code>arrow_type</code></em> and <em class="parameter"><code>shadow_type</code></em> of
29
29
the arrow widget.</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-gtkalignment.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-gtkaspectframe.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Alignment </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.AspectFrame</td></tr></table></div></body></html>