/usr/share/gtk-doc/html/pygtk/class-gtkscrolledwindow.html

<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.ScrolledWindow</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><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-gtkscrollbar.html" title="gtk.Scrollbar"><link rel="next" href="class-gtkselectiondata.html" title="gtk.SelectionData"></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.ScrolledWindow</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkscrollbar.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkselectiondata.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.ScrolledWindow"><a name="class-gtkscrolledwindow"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.ScrolledWindow</h2><p>gtk.ScrolledWindow — adds scrollbars to its child widget.</p></div><div class="refsect1" title="Synopsis"><a name="id3886002"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.ScrolledWindow</span></span>(<span class="ooclass"><span class="classname"><a class="link" href="class-gtkbin.html" title="gtk.Bin">gtk.Bin</a></span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#constructor-gtkscrolledwindow" title="Constructor">gtk.ScrolledWindow</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-gtkscrolledwindow.html#method-gtkscrolledwindow--set-hadjustment" title="gtk.ScrolledWindow.set_hadjustment">set_hadjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hadjustment</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--set-vadjustment" title="gtk.ScrolledWindow.set_vadjustment">set_vadjustment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>vadjustment</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--get-hadjustment" title="gtk.ScrolledWindow.get_hadjustment">get_hadjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--get-vadjustment" title="gtk.ScrolledWindow.get_vadjustment">get_vadjustment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--get-hscrollbar" title="gtk.ScrolledWindow.get_hscrollbar">get_hscrollbar</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--get-vscrollbar" title="gtk.ScrolledWindow.get_vscrollbar">get_vscrollbar</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--set-policy" title="gtk.ScrolledWindow.set_policy">set_policy</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hscrollbar_policy</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>vscrollbar_policy</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--get-policy" title="gtk.ScrolledWindow.get_policy">get_policy</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hscrollbar_policy</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>vscrollbar_policy</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--set-placement" title="gtk.ScrolledWindow.set_placement">set_placement</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>window_placement</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--get-placement" title="gtk.ScrolledWindow.get_placement">get_placement</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--set-shadow-type" title="gtk.ScrolledWindow.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-gtkscrolledwindow.html#method-gtkscrolledwindow--get-shadow-type" title="gtk.ScrolledWindow.get_shadow_type">get_shadow_type</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--add-with-viewport" title="gtk.ScrolledWindow.add_with_viewport">add_with_viewport</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Ancestry"><a name="id3886423"></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-gtkscrolledwindow.html" title="gtk.ScrolledWindow">gtk.ScrolledWindow</a>
</pre></div><div class="refsect1" title="Implemented Interfaces"><a name="id3886473"></a><h2>Implemented Interfaces</h2><p>
			<a class="link" href="class-gtkscrolledwindow.html" title="gtk.ScrolledWindow"><code class="classname">gtk.ScrolledWindow</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" title="gtk.ScrolledWindow Properties"><a name="properties-gtkscrolledwindow"></a><h2>gtk.ScrolledWindow 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><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="4in"></colgroup><tbody><tr valign="top"><td valign="top">"hadjustment"</td><td valign="top">Read-Write-Construct</td><td valign="top">The <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
for the horizontal position.</td></tr><tr valign="top"><td valign="top">hscrollbar-policy""</td><td valign="top">Read-Write</td><td valign="top">The horizontal scrollbar display policy; one of:
<code class="literal">gtk.POLICY_ALWAYS</code>,
<code class="literal">gtk.POLICY_AUTOMATIC</code> or
<code class="literal">gtk.POLICY_NEVER</code>.</td></tr><tr valign="top"><td valign="top">"shadow-type"</td><td valign="top">Read-Write</td><td valign="top">The style of bevel around the contents; one of:
<code class="literal">gtk.SHADOW_NONE</code>, <code class="literal">gtk.SHADOW_IN</code>,
<code class="literal">gtk.SHADOW_OUT</code>, <code class="literal">gtk.SHADOW_ETCHED_IN</code>,
<code class="literal">gtk.SHADOW_ETCHED_OUT</code>.</td></tr><tr valign="top"><td valign="top">"vadjustment"</td><td valign="top">Read-Write-Construct</td><td valign="top">The <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
for the vertical position.</td></tr><tr valign="top"><td valign="top">"vscrollbar-policy"</td><td valign="top">Read-Write</td><td valign="top">The vertical scrollbar display policy; one of:
<code class="literal">gtk.POLICY_ALWAYS</code>,
<code class="literal">gtk.POLICY_AUTOMATIC</code> or
<code class="literal">gtk.POLICY_NEVER</code>.</td></tr><tr valign="top"><td valign="top">"window-placement"</td><td valign="top">Read-Write</td><td valign="top">Where the contents are located with respect to the
scrollbars; one of: <code class="literal">gtk.CORNER_TOP_LEFT</code>,
<code class="literal">gtk.CORNER_BOTTOM_LEFT</code>,
<code class="literal">gtk.CORNER_TOP_RIGHT</code>,
<code class="literal">gtk.CORNER_BOTTOM_RIGHT</code>.</td></tr><tr valign="top"><td valign="top">"window-placement-set"</td><td valign="top">Read-Write</td><td valign="top">If <code class="literal">True</code> "window-placement" should be
          used to determine the location of the contents with respect to the
          scrollbars.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ScrolledWindow Style Properties"><a name="style-properties-gtkscrolledwindow"></a><h2>gtk.ScrolledWindow 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 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="4in"></colgroup><tbody><tr valign="top"><td valign="top">"scrollbar-spacing"</td><td valign="top">Read</td><td valign="top">The number of pixels between the scrollbars and the
	      scrolled window. Available in <code class="literal">GTK+</code> 2.2 and
	      above.</td></tr><tr valign="top"><td valign="top">"scrollbar-within-bevel"</td><td valign="top">Read</td><td valign="top">Whether to place scrollbars within the scrolled window's bevel.
          Default value: <code class="literal">False</code>
          Available in <code class="literal">GTK+</code> 2.12 and
	      above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="gtk.ScrolledWindow Signal Prototypes"><a name="signal-prototypes-gtkscrolledwindow"></a><h2>gtk.ScrolledWindow 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-gtkscrolledwindow.html#signal-gtkscrolledwindow--move-focus-out" title='The "move-focus-out" gtk.ScrolledWindow Signal'>move-focus-out</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolledwindow</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>direction</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><tr><td><p><span class="term">"<a class="link" href="class-gtkscrolledwindow.html#signal-gtkscrolledwindow--scroll-child" title='The "scroll-child" gtk.ScrolledWindow Signal'>scroll-child</a>"</span></p></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolledwindow</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolltype</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>horizontal</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" title="Description"><a name="id3887148"></a><h2>Description</h2><p>A <a class="link" href="class-gtkscrolledwindow.html" title="gtk.ScrolledWindow"><code class="classname">gtk.ScrolledWindow</code></a> 
is a subclass of <a class="link" href="class-gtkbin.html" title="gtk.Bin"><code class="classname">gtk.Bin</code></a> that  adds
scrollbars to a single child widget and optionally draws a beveled frame
around the child widget. The scrolled window can work in two ways:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">Some widgets have native scrolling support using "slots" to
hold <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
objects. Widgets with native scroll support include <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>,
<a class="link" href="class-gtktextview.html" title="gtk.TextView"><code class="classname">gtk.TextView</code></a>, and
<a class="link" href="class-gtklayout.html" title="gtk.Layout"><code class="classname">gtk.Layout</code></a>.</li><li class="listitem">Widgets that lack native scrolling support use the <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>
widget that acts as an adapter class, implementing scrollability for child
widgets that lack their own scrolling capabilities. Use <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a> to
scroll child widgets such as <a class="link" href="class-gtktable.html" title="gtk.Table"><code class="classname">gtk.Table</code></a>, <a class="link" href="class-gtkbox.html" title="gtk.Box"><code class="classname">gtk.Box</code></a>, and so
on.</li></ul></div><p>If a widget has native scrolling abilities, it can be added to the
<a class="link" href="class-gtkscrolledwindow.html" title="gtk.ScrolledWindow"><code class="classname">gtk.ScrolledWindow</code></a> 
with the <a class="link" href="class-gtkcontainer.html#method-gtkcontainer--add" title="gtk.Container.add"><code class="methodname">gtk.Container.add</code>()</a> 
method. If a widget does not, you must first add the widget to a <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>, then
add the <a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a> to
the scrolled window. The convenience method <a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--add-with-viewport" title="gtk.ScrolledWindow.add_with_viewport"><code class="methodname">add_with_viewport</code>()</a> 
does exactly this, so you can ignore the presence of the viewport.</p><p>The position of the scrollbars is controlled by the scroll
adjustments. The <a class="link" href="class-gtkscrolledwindow.html" title="gtk.ScrolledWindow"><code class="classname">gtk.ScrolledWindow</code></a> 
uses the attributes in an adjustment (see <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>)
as follows:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">the <code class="literal">adjustment.lower</code> attribute is the
minimum value of the scroll region</li><li class="listitem">the <code class="literal">adjustment.upper</code> attribute is the
maximum value of the scroll region</li><li class="listitem">the <code class="literal">adjustment.value</code> attribute
represents the position of the scrollbar, which must be between
<code class="literal">adjustment.lower</code> and <code class="literal">adjustment.upper</code>
- <code class="literal">adjustment.page_size</code></li><li class="listitem">the <code class="literal">adjustment.page_size</code> attribute
represents the size of the visible scrollable area</li><li class="listitem">the <code class="literal">adjustment.step_increment</code> attribute
is the distance to scroll when the small stepper arrows are
clicked</li><li class="listitem">the <code class="literal">adjustment.page_increment</code> attribute
is the distance to scroll when the <span class="keycap"><strong>Page Up</strong></span> or <span class="keycap"><strong>Page
Down</strong></span> keys are pressed</li></ul></div><p>If a <a class="link" href="class-gtkscrolledwindow.html" title="gtk.ScrolledWindow"><code class="classname">gtk.ScrolledWindow</code></a> 
doesn't behave quite as you would like, or doesn't have exactly the right
layout, it's very possible to set up your own scrolling with <a class="link" href="class-gtkscrollbar.html" title="gtk.Scrollbar"><code class="classname">gtk.Scrollbar</code></a> and
for example a <a class="link" href="class-gtktable.html" title="gtk.Table"><code class="classname">gtk.Table</code></a>.</p></div><div class="refsect1" title="Constructor"><a name="constructor-gtkscrolledwindow"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.ScrolledWindow</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></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>hadjustment</code></strong> :</span></p></td><td>the horizontal <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
or None</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>vadjustment</code></strong> :</span></p></td><td>a
vertical <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
or None</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gtkscrolledwindow.html" title="gtk.ScrolledWindow"><code class="classname">gtk.ScrolledWindow</code></a> 
widget</td></tr></tbody></table><p>Creates a new scrolled window with the horizontal and vertical
<a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>
specified by <em class="parameter"><code>hadjustment</code></em> and
<em class="parameter"><code>vadjustment</code></em> respectively. These will be shared with
the scrollbars and the child widget to keep the bars in sync with the child.
If <em class="parameter"><code>hadjustment</code></em> and <em class="parameter"><code>vadjustment</code></em>
are <code class="literal">None</code> or not specified the scrolled window will create
them for you.</p></div><div class="refsect1" title="Methods"><a name="id3887660"></a><h2>Methods</h2><div class="refsect2" title="gtk.ScrolledWindow.set_hadjustment"><a name="method-gtkscrolledwindow--set-hadjustment"></a><h3>gtk.ScrolledWindow.set_hadjustment</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_hadjustment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hadjustment</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>hadjustment</code></strong> :</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></tbody></table><p>The <code class="methodname">set_hadjustment</code>() method sets the
horizontal adjustment (and the "hadjustment" property) to the value of
<em class="parameter"><code>hadjustment</code></em>. <em class="parameter"><code>hadjustment</code></em> must
be a <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>.</p></div><div class="refsect2" title="gtk.ScrolledWindow.set_vadjustment"><a name="method-gtkscrolledwindow--set-vadjustment"></a><h3>gtk.ScrolledWindow.set_vadjustment</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_vadjustment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>vadjustment</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>vadjustment</code></strong> :</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></tbody></table><p>The <code class="methodname">set_vadjustment</code>() method sets the
vertical adjustment (and the "vadjustment" property) to the value of
<em class="parameter"><code>vadjustment</code></em>. <em class="parameter"><code>vadjustment</code></em> must
be a <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a>.</p></div><div class="refsect2" title="gtk.ScrolledWindow.get_hadjustment"><a name="method-gtkscrolledwindow--get-hadjustment"></a><h3>gtk.ScrolledWindow.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 <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a></td></tr></tbody></table><p>The <code class="methodname">get_hadjustment</code>() method returns
the value of the "hadjustment" property which is a reference to the
horizontal adjustment.</p></div><div class="refsect2" title="gtk.ScrolledWindow.get_vadjustment"><a name="method-gtkscrolledwindow--get-vadjustment"></a><h3>gtk.ScrolledWindow.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 <a class="link" href="class-gtkadjustment.html" title="gtk.Adjustment"><code class="classname">gtk.Adjustment</code></a></td></tr></tbody></table><p>The <code class="methodname">get_vadjustment</code>() method returns
the value of the "vadjustment" property which is a reference to the vertical
adjustment.</p></div><div class="refsect2" title="gtk.ScrolledWindow.get_hscrollbar"><a name="method-gtkscrolledwindow--get-hscrollbar"></a><h3>gtk.ScrolledWindow.get_hscrollbar</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_hscrollbar</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 scrollbar of the scrolled window
or <code class="literal">None</code> if it does not exist.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_hscrollbar</code>() method returns the
<a class="link" href="class-gtkhscrollbar.html" title="gtk.HScrollbar"><code class="classname">gtk.HScrollbar</code></a>
for the scrolled window or <code class="literal">None</code> if there is no horizontal
scrollbar.</p></div><div class="refsect2" title="gtk.ScrolledWindow.get_vscrollbar"><a name="method-gtkscrolledwindow--get-vscrollbar"></a><h3>gtk.ScrolledWindow.get_vscrollbar</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_vscrollbar</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 scrollbar of the scrolled window
or <code class="literal">None</code> if it does not exist.</td></tr></tbody></table><div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.8 and above.</p></div><p>The <code class="methodname">get_vscrollbar</code>() method returns the
<a class="link" href="class-gtkvscrollbar.html" title="gtk.VScrollbar"><code class="classname">gtk.VScrollbar</code></a>
for the scrolled window or <code class="literal">None</code> if there is no vertical
scrollbar.</p></div><div class="refsect2" title="gtk.ScrolledWindow.set_policy"><a name="method-gtkscrolledwindow--set-policy"></a><h3>gtk.ScrolledWindow.set_policy</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_policy</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>hscrollbar_policy</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>vscrollbar_policy</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>hscrollbar_policy</code></strong> :</span></p></td><td>the policy for the horizontal
scrollbar</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>vscrollbar_policy</code></strong> :</span></p></td><td>the policy for the vertical
scrollbar</td></tr></tbody></table><p>The <code class="methodname">set_policy</code>() method sets the
"hscrollbar_policy" and "vscrollbar_policy" properties to the value of
<em class="parameter"><code>hscrollbar_policy</code></em> and
<em class="parameter"><code>vscrollbar_policy</code></em> respectively. The policy determines
when the scrollbar should be displayed. The policy value is one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">gtk.POLICY_ALWAYS</span></p></td><td>the scrollbar is always present</td></tr><tr><td><p><span class="term">gtk.POLICY_AUTOMATIC</span></p></td><td>the scrollbar is present only if needed i.e. the
contents are larget than the window</td></tr><tr><td><p><span class="term">gtk.POLICY_NEVER</span></p></td><td>the scrollbar is never present</td></tr></tbody></table><p></p></div><div class="refsect2" title="gtk.ScrolledWindow.get_policy"><a name="method-gtkscrolledwindow--get-policy"></a><h3>gtk.ScrolledWindow.get_policy</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_policy</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>&gt; :</span></p></td><td>a tuple containing the horizontal and vertical
scrollbar policies</td></tr></tbody></table><p>The <code class="methodname">get_policy</code>() method returns a tuple
containing the horizontal and vertical scrollbar policies. See the <a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--set-policy" title="gtk.ScrolledWindow.set_policy"><code class="methodname">set_policy</code>()</a> method for more detail.</p></div><div class="refsect2" title="gtk.ScrolledWindow.set_placement"><a name="method-gtkscrolledwindow--set-placement"></a><h3>gtk.ScrolledWindow.set_placement</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_placement</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>window_placement</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>window_placement</code></strong> :</span></p></td><td>the placement of the contents with respect to
the scrollbars</td></tr></tbody></table><p>The <code class="methodname">set_placement</code>() method sets the
"window-placement" property to the value specified by
<em class="parameter"><code>window_placement</code></em>. The window placement determines the
location of the child widget with respect to the scrollbars.
<em class="parameter"><code>window_placement</code></em> must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">gtk.CORNER_TOP_LEFT</span></p></td><td>Place the scrollbars on the right and bottom of the
widget (default behavior).</td></tr><tr><td><p><span class="term">gtk.CORNER_BOTTOM_LEFT</span></p></td><td>Place the scrollbars on the top and right of the
widget.</td></tr><tr><td><p><span class="term">gtk.CORNER_TOP_RIGHT</span></p></td><td>Place the scrollbars on the left and bottom of the
widget.</td></tr><tr><td><p><span class="term">gtk.CORNER_BOTTOM_RIGHT</span></p></td><td>Place the scrollbars on the top and left of the
widget.</td></tr></tbody></table><p></p></div><div class="refsect2" title="gtk.ScrolledWindow.get_placement"><a name="method-gtkscrolledwindow--get-placement"></a><h3>gtk.ScrolledWindow.get_placement</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_placement</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 current placement
value.</td></tr></tbody></table><p>The <code class="methodname">get_placement</code>() method returns the
value of the "window-placement" property that determines the placement of
the scrollbars with respect to the scrolled window. See the <a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--set-placement" title="gtk.ScrolledWindow.set_placement"><code class="methodname">set_placement</code>()</a> 
method for more detail.</p></div><div class="refsect2" title="gtk.ScrolledWindow.set_shadow_type"><a name="method-gtkscrolledwindow--set-shadow-type"></a><h3>gtk.ScrolledWindow.set_shadow_type</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_shadow_type</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>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>type</code></strong> :</span></p></td><td>the kind of bevel shadow to draw around the
scrolled window contents</td></tr></tbody></table><p>The <code class="methodname">set_shadow_type</code>() method sets the
value of the "shadow-type" property to the value of
<em class="parameter"><code>shadow_type</code></em>. <em class="parameter"><code>shadow_type</code></em>
determines the type of bevel shadow drawn around the contents of the
scrolled window. The shadow type must be one of:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term">gtk.SHADOW_NONE</span></p></td><td>No outline.</td></tr><tr><td><p><span class="term">gtk.SHADOW_IN</span></p></td><td>The outline is beveled inward.</td></tr><tr><td><p><span class="term">gtk.SHADOW_OUT</span></p></td><td>The outline is beveled outward.</td></tr><tr><td><p><span class="term">gtk.SHADOW_ETCHED_IN</span></p></td><td>The outline is an inward etched bevel.</td></tr><tr><td><p><span class="term">gtk.SHADOW_ETCHED_OUT</span></p></td><td>The outline is an outward etched bevel.</td></tr></tbody></table><p></p></div><div class="refsect2" title="gtk.ScrolledWindow.get_shadow_type"><a name="method-gtkscrolledwindow--get-shadow-type"></a><h3>gtk.ScrolledWindow.get_shadow_type</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_shadow_type</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 current shadow type</td></tr></tbody></table><p>The <code class="methodname">get_shadow_type</code>() method returns
the value of the "shadow-type" property that determines the shadow type of
the scrolled window. See the <a class="link" href="class-gtkscrolledwindow.html#method-gtkscrolledwindow--set-shadow-type" title="gtk.ScrolledWindow.set_shadow_type"><code class="methodname">set_shadow_type</code>()</a> 
method for more detail.</p></div><div class="refsect2" title="gtk.ScrolledWindow.add_with_viewport"><a name="method-gtkscrolledwindow--add-with-viewport"></a><h3>gtk.ScrolledWindow.add_with_viewport</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">add_with_viewport</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>child</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>child</code></strong> :</span></p></td><td>the widget to be scrolled</td></tr></tbody></table><p>The <code class="methodname">add_with_viewport</code>() method is used
to add a widget (specified by <em class="parameter"><code>child</code></em>) without native
scrolling capabilities to the scrolled window. This is a convenience
function that is equivalent to adding <em class="parameter"><code>child</code></em> to a
<a class="link" href="class-gtkviewport.html" title="gtk.Viewport"><code class="classname">gtk.Viewport</code></a>, then
adding the viewport to the scrolled window. If a child has native scrolling
(e.g. <a class="link" href="class-gtktextview.html" title="gtk.TextView"><code class="classname">gtk.TextView</code></a>,
<a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a>,
<a class="link" href="class-gtklayout.html" title="gtk.Layout"><code class="classname">gtk.Layout</code></a>),
use <a class="link" href="class-gtkcontainer.html#method-gtkcontainer--add" title="gtk.Container.add"><code class="methodname">gtk.Container.add</code>()</a> 
instead of this method.</p><p>The viewport scrolls the child by moving its <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a>,
and takes the size of the child to be the size of its toplevel <a class="link" href="class-gdkwindow.html" title="gtk.gdk.Window"><code class="classname">gtk.gdk.Window</code></a>.
This will be wrong for most widgets that support native scrolling. For
example, if you add a widget such as <a class="link" href="class-gtktreeview.html" title="gtk.TreeView"><code class="classname">gtk.TreeView</code></a> with
a viewport, the whole widget will scroll, including the column
headings.</p></div></div><div class="refsect1" title="Signals"><a name="id3889036"></a><h2>Signals</h2><div class="refsect2" title='The "move-focus-out" gtk.ScrolledWindow Signal'><a name="signal-gtkscrolledwindow--move-focus-out"></a><h3>The "move-focus-out" gtk.ScrolledWindow Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolledwindow</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>direction</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>scrolledwindow</code></em> :</span></p></td><td>the scrolledwindow that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>direction</code></em> :</span></p></td><td>the direction that the focus is moving either
<code class="literal">gtk.DIR_TAB_FORWARD</code> or
<code class="literal">gtk.DIR_TAB_BACKWARD</code>.</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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "move-focus-out" signal is emitted when the user presses
<span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Tab</strong></span> or <span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Shift</strong></span>+<span class="keycap"><strong>Tab</strong></span> to move the focus out of the scrolled window. The
<em class="parameter"><code>direction</code></em> is either
<code class="literal">gtk.DIR_TAB_FORWARD</code> or
<code class="literal">gtk.DIR_TAB_BACKWARD</code></p></div><div class="refsect2" title='The "scroll-child" gtk.ScrolledWindow Signal'><a name="signal-gtkscrolledwindow--scroll-child"></a><h3>The "scroll-child" gtk.ScrolledWindow Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolledwindow</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>scrolltype</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>horizontal</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>scrolledwindow</code></em> :</span></p></td><td>the scrolledwindow that received the
signal</td></tr><tr><td><p><span class="term"><em class="parameter"><code>scrolltype</code></em> :</span></p></td><td>the scroll type; one of:
<code class="literal">gtk.SCROLL_STEP_BACKWARD</code>,
<code class="literal">gtk.SCROLL_STEP_FORWARD</code>,
<code class="literal">gtk.SCROLL_PAGE_BACKWARD</code>,
<code class="literal">gtk.SCROLL_PAGE_FORWARD</code>,
<code class="literal">gtk.SCROLL_PAGE_UP</code>,
<code class="literal">gtk.SCROLL_PAGE_DOWN</code>, <code class="literal">gtk.SCROLL_START</code>
or <code class="literal">gtk.SCROLL_END</code>.</td></tr><tr><td><p><span class="term"><em class="parameter"><code>horizontal</code></em> :</span></p></td><td>if True scroll in the horizontal
direction</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
with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
method</td></tr><tr><td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td><td>additional user parameters (if
any)</td></tr></tbody></table><p>The "scroll-child" signal is emitted when the child widget is
being scrolled by a keyboard action. The default key bindings with resulting
<em class="parameter"><code>scrolltype</code></em> and <em class="parameter"><code>horizontal</code></em>
arguments are:</p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Left Arrow</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_STEP_BACKWARD</code> -
horizontal</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Right Arrow</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_STEP_FORWARD</code> -
horizontal</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Up Arrow</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_STEP_BACKWARD</code> -
vertical</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Down Arrow</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_STEP_FORWARD</code> -
vertical</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Page Up</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_PAGE_BACKWARD</code> -
horizontal</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Page Down</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_PAGE_FORWARD</code> -
horizontal</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Page Up</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_PAGE_BACKWARD</code> -
vertical</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Page Down</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_PAGE_FORWARD</code> -
vertical</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>Home</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_START</code> -
horizontal</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Control</strong></span>+<span class="keycap"><strong>End</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_END</code> -
horizontal</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>Home</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_START</code> -
vertical</td></tr><tr><td><p><span class="term"><span class="keycap"><strong>End</strong></span></span></p></td><td><code class="literal">gtk.SCROLL_END</code> - vertical</td></tr></tbody></table><p></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-gtkscrollbar.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-gtkselectiondata.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Scrollbar </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.SelectionData</td></tr></table></div></body></html>
python-gtk2-doc 2.24.0-4 / usr / share / gtk-doc / html / pygtk / class-gtkscrolledwindow.html
