← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-06-22 16:49:42 UTC
  • mfrom: (1.2.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20090622164942-19zeltp4z0u5iw72
Tags: 2.15.2-0ubuntu1
* New upstream version:
  - Rename gtk.Statusbar.remove() to gtk.Statusbar.remove_message
  - Allow pango.Context creation 
  - Make gtk.gdk.Pixbuf.add_alpha accept integers, retaining backward
    compatibility accepting also chars 
  - Protect window obj from GC in gtk.window_get_toplevels 
  - Plug huge number of memory leaks in Pango wrappers 
  - Add gtk.gdk.WINDOWING constant 
  - Wrap gdk_pixbuf_apply_embedded_orientation 
  - Modernize constructors of seven more types 
  - Don't free a string we don't own 
  - Some docs tweaking 
* debian/control.in:
  - set vcs location
* debian/patches/02_fix_get_application_info_crash.patch:
  - the change is in the new version

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/html/class-gtkviewport.html
1
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Viewport</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-gtkvseparator.html" title="gtk.VSeparator"><link rel="next" href="class-gtkwidget.html" title="gtk.Widget"></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.Viewport</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkvseparator.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkwidget.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkviewport"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Viewport</h2><p>gtk.Viewport — a widget displaying a portion of a larger
2
 
widget.</p></div><div class="refsect1" lang="en"><a name="id3822671"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Viewport</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
3
 
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkviewport.html#constructor-gtkviewport" title="Constructor">gtk.Viewport</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hadjustment</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>vadjustment</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--get-hadjustment" title="gtk.Viewport.get_hadjustment">get_hadjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--get-vadjustment" title="gtk.Viewport.get_vadjustment">get_vadjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--set-hadjustment" title="gtk.Viewport.set_hadjustment">set_hadjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--set-vadjustment" title="gtk.Viewport.set_vadjustment">set_vadjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--set-shadow-type" title="gtk.Viewport.set_shadow_type">set_shadow_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--get-shadow-type" title="gtk.Viewport.get_shadow_type">get_shadow_type</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3822893"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
 
2
widget.</p></div><div class="refsect1" lang="en"><a name="id4023579"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Viewport</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
 
3
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkviewport.html#constructor-gtkviewport" title="Constructor">gtk.Viewport</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hadjustment</code></strong></span><span class="initializer">=None</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>vadjustment</code></strong></span><span class="initializer">=None</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--get-hadjustment" title="gtk.Viewport.get_hadjustment">get_hadjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--get-vadjustment" title="gtk.Viewport.get_vadjustment">get_vadjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--set-hadjustment" title="gtk.Viewport.set_hadjustment">set_hadjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--set-vadjustment" title="gtk.Viewport.set_vadjustment">set_vadjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>adjustment</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--set-shadow-type" title="gtk.Viewport.set_shadow_type">set_shadow_type</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>type</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkviewport.html#method-gtkviewport--get-shadow-type" title="gtk.Viewport.get_shadow_type">get_shadow_type</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id4023800"></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-gtkcontainer.html" title="gtk.Container">gtk.Container</a>
7
7
        +-- <a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a>
8
8
          +-- <a class="link" href="class-gtkviewport.html" title="gtk.Viewport">gtk.Viewport</a>
9
 
</pre></div><div class="refsect1" lang="en"><a name="id3822944"></a><h2>Implemented Interfaces</h2><p>
 
9
</pre></div><div class="refsect1" lang="en"><a name="id4023851"></a><h2>Implemented Interfaces</h2><p>
10
10
                        <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>
11
11
                        implements 
12
12
                        <a class="link" href="class-gtkbuildable.html" title="gtk.Buildable"><code class="classname">gtk.Buildable</code></a>
17
17
<code class="literal">gtk.SHADOW_OUT</code>, <code class="literal">gtk.SHADOW_ETCHED_IN</code>
18
18
or <code class="literal">gtk.SHADOW_ETCHED_OUT</code></td></tr><tr valign="top"><td valign="top">"vadjustment"</td><td valign="top">Read-Write</td><td valign="top">The <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
19
19
that determines the values of the vertical position for this
20
 
viewport.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkviewport"></a><h2>gtk.Viewport 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-gtkviewport"></a><h2>gtk.Viewport 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><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkviewport.html#signal-gtkviewport--set-scroll-adjustments" title='The "set-scroll-adjustments" gtk.Viewport Signal'>set-scroll-adjustments</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>viewport</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>hadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>vadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3823301"></a><h2>Description</h2><p>A <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>
 
20
viewport.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkviewport"></a><h2>gtk.Viewport 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-gtkviewport"></a><h2>gtk.Viewport 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><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">"<a class="link" href="class-gtkviewport.html#signal-gtkviewport--set-scroll-adjustments" title='The "set-scroll-adjustments" gtk.Viewport Signal'>set-scroll-adjustments</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>viewport</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>hadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>vadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id4024208"></a><h2>Description</h2><p>A <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>
21
21
widget provides a view into a portion of a larger widget. A <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a> is
22
22
usually used to provide adjustment capability for a widget to be used in a
23
23
<a class="link" href="class-gtkscrolledwindow.html" title="gtk.ScrolledWindow"><code class="classname">gtk.ScrolledWindow</code></a>. 
31
31
<em class="parameter"><code>hadjustment</code></em> and <em class="parameter"><code>vadjustment</code></em>
32
32
respectively. If <em class="parameter"><code>hadjustment</code></em> or
33
33
<em class="parameter"><code>vadjustment</code></em> is <code class="literal">None</code> a new
34
 
adjustment will be created.</p></div><div class="refsect1" lang="en"><a name="id3823524"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkviewport--get-hadjustment"></a><h3>gtk.Viewport.get_hadjustment</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_hadjustment</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 horizontal adjustment</td></tr></tbody></table><p>The <code class="methodname">get_hadjustment</code>() method returns
 
34
adjustment will be created.</p></div><div class="refsect1" lang="en"><a name="id4024432"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkviewport--get-hadjustment"></a><h3>gtk.Viewport.get_hadjustment</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_hadjustment</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 horizontal adjustment</td></tr></tbody></table><p>The <code class="methodname">get_hadjustment</code>() method returns
35
35
the value of the "hadjustment" property that contains the horizontal <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
36
36
of the viewport.</p></div><div class="refsect2" lang="en"><a name="method-gtkviewport--get-vadjustment"></a><h3>gtk.Viewport.get_vadjustment</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_vadjustment</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 vertical adjustment</td></tr></tbody></table><p>The <code class="methodname">get_vadjustment</code>() method returns
37
37
the value of the "vadjustment" property that contains the vertical <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
45
45
the value of the "shadow-type" property that contains the shadow type of the
46
46
<a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>. See
47
47
the <a class="link" href="class-gtkviewport.html#method-gtkviewport--set-shadow-type" title="gtk.Viewport.set_shadow_type"><code class="methodname">set_shadow_type</code>()</a> 
48
 
method for more information.</p></div></div><div class="refsect1" lang="en"><a name="id3824057"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkviewport--set-scroll-adjustments"></a><h3>The "set-scroll-adjustments" gtk.Viewport Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>viewport</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>hadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>vadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>viewport</code></em> :</span></p></td><td>the viewport that received the
 
48
method for more information.</p></div></div><div class="refsect1" lang="en"><a name="id4024964"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkviewport--set-scroll-adjustments"></a><h3>The "set-scroll-adjustments" gtk.Viewport Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>viewport</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>hadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>vadjustment</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></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"><em class="parameter"><code>viewport</code></em> :</span></p></td><td>the viewport that received the
49
49
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>hadjustment</code></em> :</span></p></td><td>the horizontal <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a></td></tr><tr><td><p><span class="term"><em class="parameter"><code>vadjustment</code></em> :</span></p></td><td>the vertical <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a></td></tr><tr><td><p><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></p></td><td>the first user parameter (if any) specified
50
50
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
51
51
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if