Initial packaging to sync OBS with git/gerrit
[profile/ivi/gtk3.git] / docs / reference / gtk / html / GtkScrollable.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GtkScrollable</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
8 <link rel="up" href="ScrollingWidgets.html" title="Scrolling">
9 <link rel="prev" href="GtkScrolledWindow.html" title="GtkScrolledWindow">
10 <link rel="next" href="Printing.html" title="Printing">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="GtkScrolledWindow.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ScrollingWidgets.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GTK+ 3 Reference Manual</th>
21 <td><a accesskey="n" href="Printing.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GtkScrollable.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#GtkScrollable.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#GtkScrollable.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#GtkScrollable.prerequisites" class="shortcut">Prerequisites</a>
31                    | 
32                   <a href="#GtkScrollable.implementations" class="shortcut">Known Implementations</a>
33                    | 
34                   <a href="#GtkScrollable.properties" class="shortcut">Properties</a>
35 </td></tr>
36 </table>
37 <div class="refentry">
38 <a name="GtkScrollable"></a><div class="titlepage"></div>
39 <div class="refnamediv"><table width="100%"><tr>
40 <td valign="top">
41 <h2><span class="refentrytitle"><a name="GtkScrollable.top_of_page"></a>GtkScrollable</span></h2>
42 <p>GtkScrollable — An interface for scrollable widgets</p>
43 </td>
44 <td valign="top" align="right"></td>
45 </tr></table></div>
46 <div class="refsynopsisdiv">
47 <a name="GtkScrollable.synopsis"></a><h2>Synopsis</h2>
48 <pre class="synopsis">
49 #include &lt;gtk/gtk.h&gt;
50
51                     <a class="link" href="GtkScrollable.html#GtkScrollable-struct" title="GtkScrollable">GtkScrollable</a>;
52 <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="returnvalue">GtkAdjustment</span></a> *     <a class="link" href="GtkScrollable.html#gtk-scrollable-get-hadjustment" title="gtk_scrollable_get_hadjustment ()">gtk_scrollable_get_hadjustment</a>      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);
53 <span class="returnvalue">void</span>                <a class="link" href="GtkScrollable.html#gtk-scrollable-set-hadjustment" title="gtk_scrollable_set_hadjustment ()">gtk_scrollable_set_hadjustment</a>      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
54                                                          <em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *hadjustment</code></em>);
55 <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="returnvalue">GtkAdjustment</span></a> *     <a class="link" href="GtkScrollable.html#gtk-scrollable-get-vadjustment" title="gtk_scrollable_get_vadjustment ()">gtk_scrollable_get_vadjustment</a>      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);
56 <span class="returnvalue">void</span>                <a class="link" href="GtkScrollable.html#gtk-scrollable-set-vadjustment" title="gtk_scrollable_set_vadjustment ()">gtk_scrollable_set_vadjustment</a>      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
57                                                          <em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *vadjustment</code></em>);
58 enum                <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy">GtkScrollablePolicy</a>;
59 <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="returnvalue">GtkScrollablePolicy</span></a> <a class="link" href="GtkScrollable.html#gtk-scrollable-get-hscroll-policy" title="gtk_scrollable_get_hscroll_policy ()">gtk_scrollable_get_hscroll_policy</a>   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);
60 <span class="returnvalue">void</span>                <a class="link" href="GtkScrollable.html#gtk-scrollable-set-hscroll-policy" title="gtk_scrollable_set_hscroll_policy ()">gtk_scrollable_set_hscroll_policy</a>   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
61                                                          <em class="parameter"><code><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> policy</code></em>);
62 <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="returnvalue">GtkScrollablePolicy</span></a> <a class="link" href="GtkScrollable.html#gtk-scrollable-get-vscroll-policy" title="gtk_scrollable_get_vscroll_policy ()">gtk_scrollable_get_vscroll_policy</a>   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);
63 <span class="returnvalue">void</span>                <a class="link" href="GtkScrollable.html#gtk-scrollable-set-vscroll-policy" title="gtk_scrollable_set_vscroll_policy ()">gtk_scrollable_set_vscroll_policy</a>   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
64                                                          <em class="parameter"><code><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> policy</code></em>);
65 </pre>
66 </div>
67 <div class="refsect1">
68 <a name="GtkScrollable.object-hierarchy"></a><h2>Object Hierarchy</h2>
69 <pre class="synopsis">
70   GInterface
71    +----GtkScrollable
72 </pre>
73 </div>
74 <div class="refsect1">
75 <a name="GtkScrollable.prerequisites"></a><h2>Prerequisites</h2>
76 <p>
77 GtkScrollable requires
78  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
79 </div>
80 <div class="refsect1">
81 <a name="GtkScrollable.implementations"></a><h2>Known Implementations</h2>
82 <p>
83 GtkScrollable is implemented by
84  <a class="link" href="GtkIconView.html" title="GtkIconView">GtkIconView</a>,  <a class="link" href="GtkLayout.html" title="GtkLayout">GtkLayout</a>,  <a class="link" href="GtkTextView.html" title="GtkTextView">GtkTextView</a>,  <a class="link" href="GtkToolPalette.html" title="GtkToolPalette">GtkToolPalette</a>,  <a class="link" href="GtkTreeView.html" title="GtkTreeView">GtkTreeView</a> and  <a class="link" href="GtkViewport.html" title="GtkViewport">GtkViewport</a>.</p>
85 </div>
86 <div class="refsect1">
87 <a name="GtkScrollable.properties"></a><h2>Properties</h2>
88 <pre class="synopsis">
89   "<a class="link" href="GtkScrollable.html#GtkScrollable--hadjustment" title='The "hadjustment" property'>hadjustment</a>"              <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>*        : Read / Write / Construct
90   "<a class="link" href="GtkScrollable.html#GtkScrollable--hscroll-policy" title='The "hscroll-policy" property'>hscroll-policy</a>"           <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>   : Read / Write
91   "<a class="link" href="GtkScrollable.html#GtkScrollable--vadjustment" title='The "vadjustment" property'>vadjustment</a>"              <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>*        : Read / Write / Construct
92   "<a class="link" href="GtkScrollable.html#GtkScrollable--vscroll-policy" title='The "vscroll-policy" property'>vscroll-policy</a>"           <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>   : Read / Write
93 </pre>
94 </div>
95 <div class="refsect1">
96 <a name="GtkScrollable.description"></a><h2>Description</h2>
97 <p>
98 <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> is an interface that is implemented by widgets with native
99 scrolling ability.
100 </p>
101 <p>
102 To implement this interface you should override the
103 <a class="link" href="GtkScrollable.html#GtkScrollable--hadjustment" title='The "hadjustment" property'><span class="type">"hadjustment"</span></a> and <a class="link" href="GtkScrollable.html#GtkScrollable--vadjustment" title='The "vadjustment" property'><span class="type">"vadjustment"</span></a> properties.
104 </p>
105 <p>
106 </p>
107 <div class="refsect2">
108 <a name="id1179144"></a><h3>Creating a scrollable widget</h3>
109 <p>
110 All scrollable widgets should do the following.
111 </p>
112 <p>
113 </p>
114 <div class="orderedlist"><ol class="orderedlist" type="1">
115 <li class="listitem"><p>
116       When a parent widget sets the scrollable child widget's adjustments, the widget should populate the adjustments'
117       <a class="link" href="GtkAdjustment.html#GtkAdjustment--lower" title='The "lower" property'><span class="type">"lower"</span></a>, <a class="link" href="GtkAdjustment.html#GtkAdjustment--upper" title='The "upper" property'><span class="type">"upper"</span></a>,
118       <a class="link" href="GtkAdjustment.html#GtkAdjustment--step-increment" title='The "step-increment" property'><span class="type">"step-increment"</span></a>, <a class="link" href="GtkAdjustment.html#GtkAdjustment--page-increment" title='The "page-increment" property'><span class="type">"page-increment"</span></a> and
119       <a class="link" href="GtkAdjustment.html#GtkAdjustment--page-size" title='The "page-size" property'><span class="type">"page-size"</span></a> properties and connect to the
120       <a class="link" href="GtkAdjustment.html#GtkAdjustment-value-changed" title='The "value-changed" signal'><span class="type">"value-changed"</span></a> signal.
121     </p></li>
122 <li class="listitem"><p>
123       Because its preferred size is the size for a fully expanded widget,
124       the scrollable widget must be able to cope with underallocations.
125       This means that it must accept any value passed to its
126       <a class="link" href="GtkWidget.html#GtkWidgetClass.size-allocate"><code class="function">GtkWidgetClass.size_allocate()</code></a> function.
127     </p></li>
128 <li class="listitem"><p>
129       When the parent allocates space to the scrollable child widget, the widget should update
130       the adjustments' properties with new values.
131     </p></li>
132 <li class="listitem"><p>
133       When any of the adjustments emits the <a class="link" href="GtkAdjustment.html#GtkAdjustment-value-changed" title='The "value-changed" signal'><span class="type">"value-changed"</span></a> signal,
134       the scrollable widget should scroll its contents.
135     </p></li>
136 </ol></div>
137 <p>
138 </p>
139 </div>
140 <p>
141 </p>
142 </div>
143 <div class="refsect1">
144 <a name="GtkScrollable.details"></a><h2>Details</h2>
145 <div class="refsect2">
146 <a name="GtkScrollable-struct"></a><h3>GtkScrollable</h3>
147 <pre class="programlisting">typedef struct _GtkScrollable GtkScrollable;</pre>
148 </div>
149 <hr>
150 <div class="refsect2">
151 <a name="gtk-scrollable-get-hadjustment"></a><h3>gtk_scrollable_get_hadjustment ()</h3>
152 <pre class="programlisting"><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="returnvalue">GtkAdjustment</span></a> *     gtk_scrollable_get_hadjustment      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);</pre>
153 <p>
154 Retrieves the <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> used for horizontal scrolling.
155 </p>
156 <div class="variablelist"><table border="0">
157 <col align="left" valign="top">
158 <tbody>
159 <tr>
160 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
161 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
162 </td>
163 </tr>
164 <tr>
165 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
166 <td>horizontal <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
167 </td>
168 </tr>
169 </tbody>
170 </table></div>
171 <p class="since">Since 3.0</p>
172 </div>
173 <hr>
174 <div class="refsect2">
175 <a name="gtk-scrollable-set-hadjustment"></a><h3>gtk_scrollable_set_hadjustment ()</h3>
176 <pre class="programlisting"><span class="returnvalue">void</span>                gtk_scrollable_set_hadjustment      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
177                                                          <em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *hadjustment</code></em>);</pre>
178 <p>
179 Sets the horizontal adjustment of the <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>.
180 </p>
181 <div class="variablelist"><table border="0">
182 <col align="left" valign="top">
183 <tbody>
184 <tr>
185 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
186 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
187 </td>
188 </tr>
189 <tr>
190 <td><p><span class="term"><em class="parameter"><code>hadjustment</code></em> :</span></p></td>
191 <td>a <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
192 </td>
193 </tr>
194 </tbody>
195 </table></div>
196 <p class="since">Since 3.0</p>
197 </div>
198 <hr>
199 <div class="refsect2">
200 <a name="gtk-scrollable-get-vadjustment"></a><h3>gtk_scrollable_get_vadjustment ()</h3>
201 <pre class="programlisting"><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="returnvalue">GtkAdjustment</span></a> *     gtk_scrollable_get_vadjustment      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);</pre>
202 <p>
203 Retrieves the <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> used for vertical scrolling.
204 </p>
205 <div class="variablelist"><table border="0">
206 <col align="left" valign="top">
207 <tbody>
208 <tr>
209 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
210 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
211 </td>
212 </tr>
213 <tr>
214 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
215 <td>vertical <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
216 </td>
217 </tr>
218 </tbody>
219 </table></div>
220 <p class="since">Since 3.0</p>
221 </div>
222 <hr>
223 <div class="refsect2">
224 <a name="gtk-scrollable-set-vadjustment"></a><h3>gtk_scrollable_set_vadjustment ()</h3>
225 <pre class="programlisting"><span class="returnvalue">void</span>                gtk_scrollable_set_vadjustment      (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
226                                                          <em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *vadjustment</code></em>);</pre>
227 <p>
228 Sets the vertical adjustment of the <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>.
229 </p>
230 <div class="variablelist"><table border="0">
231 <col align="left" valign="top">
232 <tbody>
233 <tr>
234 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
235 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
236 </td>
237 </tr>
238 <tr>
239 <td><p><span class="term"><em class="parameter"><code>vadjustment</code></em> :</span></p></td>
240 <td>a <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
241 </td>
242 </tr>
243 </tbody>
244 </table></div>
245 <p class="since">Since 3.0</p>
246 </div>
247 <hr>
248 <div class="refsect2">
249 <a name="GtkScrollablePolicy"></a><h3>enum GtkScrollablePolicy</h3>
250 <pre class="programlisting">typedef enum {
251   GTK_SCROLL_MINIMUM = 0,
252   GTK_SCROLL_NATURAL
253 } GtkScrollablePolicy;
254 </pre>
255 <p>
256 Defines the policy to be used in a scrollable widget when updating
257 the scrolled window adjustments in a given orientation.
258 </p>
259 <div class="variablelist"><table border="0">
260 <col align="left" valign="top">
261 <tbody>
262 <tr>
263 <td><p><a name="GTK-SCROLL-MINIMUM:CAPS"></a><span class="term"><code class="literal">GTK_SCROLL_MINIMUM</code></span></p></td>
264 <td>Scrollable adjustments are based on the minimum size
265 </td>
266 </tr>
267 <tr>
268 <td><p><a name="GTK-SCROLL-NATURAL:CAPS"></a><span class="term"><code class="literal">GTK_SCROLL_NATURAL</code></span></p></td>
269 <td>Scrollable adjustments are based on the natural size
270 </td>
271 </tr>
272 </tbody>
273 </table></div>
274 </div>
275 <hr>
276 <div class="refsect2">
277 <a name="gtk-scrollable-get-hscroll-policy"></a><h3>gtk_scrollable_get_hscroll_policy ()</h3>
278 <pre class="programlisting"><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="returnvalue">GtkScrollablePolicy</span></a> gtk_scrollable_get_hscroll_policy   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);</pre>
279 <p>
280 Gets the horizontal <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.
281 </p>
282 <div class="variablelist"><table border="0">
283 <col align="left" valign="top">
284 <tbody>
285 <tr>
286 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
287 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
288 </td>
289 </tr>
290 <tr>
291 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
292 <td>The horizontal <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.</td>
293 </tr>
294 </tbody>
295 </table></div>
296 <p class="since">Since 3.0</p>
297 </div>
298 <hr>
299 <div class="refsect2">
300 <a name="gtk-scrollable-set-hscroll-policy"></a><h3>gtk_scrollable_set_hscroll_policy ()</h3>
301 <pre class="programlisting"><span class="returnvalue">void</span>                gtk_scrollable_set_hscroll_policy   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
302                                                          <em class="parameter"><code><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> policy</code></em>);</pre>
303 <p>
304 Sets the <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> to determine whether
305 horizontal scrolling should start below the minimum width or
306 below the natural width.
307 </p>
308 <div class="variablelist"><table border="0">
309 <col align="left" valign="top">
310 <tbody>
311 <tr>
312 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
313 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
314 </td>
315 </tr>
316 <tr>
317 <td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
318 <td>the horizontal <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>
319 </td>
320 </tr>
321 </tbody>
322 </table></div>
323 <p class="since">Since 3.0</p>
324 </div>
325 <hr>
326 <div class="refsect2">
327 <a name="gtk-scrollable-get-vscroll-policy"></a><h3>gtk_scrollable_get_vscroll_policy ()</h3>
328 <pre class="programlisting"><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="returnvalue">GtkScrollablePolicy</span></a> gtk_scrollable_get_vscroll_policy   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>);</pre>
329 <p>
330 Gets the vertical <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.
331 </p>
332 <div class="variablelist"><table border="0">
333 <col align="left" valign="top">
334 <tbody>
335 <tr>
336 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
337 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
338 </td>
339 </tr>
340 <tr>
341 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
342 <td>The vertical <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.</td>
343 </tr>
344 </tbody>
345 </table></div>
346 <p class="since">Since 3.0</p>
347 </div>
348 <hr>
349 <div class="refsect2">
350 <a name="gtk-scrollable-set-vscroll-policy"></a><h3>gtk_scrollable_set_vscroll_policy ()</h3>
351 <pre class="programlisting"><span class="returnvalue">void</span>                gtk_scrollable_set_vscroll_policy   (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
352                                                          <em class="parameter"><code><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> policy</code></em>);</pre>
353 <p>
354 Sets the <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> to determine whether
355 vertical scrolling should start below the minimum height or
356 below the natural height.
357 </p>
358 <div class="variablelist"><table border="0">
359 <col align="left" valign="top">
360 <tbody>
361 <tr>
362 <td><p><span class="term"><em class="parameter"><code>scrollable</code></em> :</span></p></td>
363 <td>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>
364 </td>
365 </tr>
366 <tr>
367 <td><p><span class="term"><em class="parameter"><code>policy</code></em> :</span></p></td>
368 <td>the vertical <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>
369 </td>
370 </tr>
371 </tbody>
372 </table></div>
373 <p class="since">Since 3.0</p>
374 </div>
375 </div>
376 <div class="refsect1">
377 <a name="GtkScrollable.property-details"></a><h2>Property Details</h2>
378 <div class="refsect2">
379 <a name="GtkScrollable--hadjustment"></a><h3>The <code class="literal">"hadjustment"</code> property</h3>
380 <pre class="programlisting">  "hadjustment"              <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>*        : Read / Write / Construct</pre>
381 <p>
382 Horizontal <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> of the scrollable widget. This adjustment is
383 shared between the scrollable widget and its parent.
384 </p>
385 <p class="since">Since 3.0</p>
386 </div>
387 <hr>
388 <div class="refsect2">
389 <a name="GtkScrollable--hscroll-policy"></a><h3>The <code class="literal">"hscroll-policy"</code> property</h3>
390 <pre class="programlisting">  "hscroll-policy"           <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>   : Read / Write</pre>
391 <p>
392 Determines whether horizontal scrolling should start once the scrollable
393 widget is allocated less than its minimum width or less than its natural width.
394 </p>
395 <p>Default value: GTK_SCROLL_MINIMUM</p>
396 <p class="since">Since 3.0</p>
397 </div>
398 <hr>
399 <div class="refsect2">
400 <a name="GtkScrollable--vadjustment"></a><h3>The <code class="literal">"vadjustment"</code> property</h3>
401 <pre class="programlisting">  "vadjustment"              <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>*        : Read / Write / Construct</pre>
402 <p>
403 Verical <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> of the scrollable widget. This adjustment is shared
404 between the scrollable widget and its parent.
405 </p>
406 <p class="since">Since 3.0</p>
407 </div>
408 <hr>
409 <div class="refsect2">
410 <a name="GtkScrollable--vscroll-policy"></a><h3>The <code class="literal">"vscroll-policy"</code> property</h3>
411 <pre class="programlisting">  "vscroll-policy"           <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>   : Read / Write</pre>
412 <p>
413 Determines whether vertical scrolling should start once the scrollable
414 widget is allocated less than its minimum height or less than its natural height.
415 </p>
416 <p>Default value: GTK_SCROLL_MINIMUM</p>
417 <p class="since">Since 3.0</p>
418 </div>
419 </div>
420 </div>
421 <div class="footer">
422 <hr>
423           Generated by GTK-Doc V1.18</div>
424 </body>
425 </html>