1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkScrollable: GTK+ 3 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
<link rel="up" href="ScrollingWidgets.html" title="Scrolling">
<link rel="prev" href="GtkScrolledWindow.html" title="GtkScrolledWindow">
<link rel="next" href="Printing.html" title="Printing">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GtkScrollable.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkScrollable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#GtkScrollable.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#GtkScrollable.implementations" class="shortcut">Known Implementations</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GtkScrollable.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ScrollingWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GtkScrolledWindow.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Printing.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkScrollable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkScrollable.top_of_page"></a>GtkScrollable</span></h2>
<p>GtkScrollable — An interface for scrollable widgets</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkScrollable.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="returnvalue">GtkAdjustment</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-get-hadjustment" title="gtk_scrollable_get_hadjustment ()">gtk_scrollable_get_hadjustment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-set-hadjustment" title="gtk_scrollable_set_hadjustment ()">gtk_scrollable_set_hadjustment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="returnvalue">GtkAdjustment</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-get-vadjustment" title="gtk_scrollable_get_vadjustment ()">gtk_scrollable_get_vadjustment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-set-vadjustment" title="gtk_scrollable_set_vadjustment ()">gtk_scrollable_set_vadjustment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="returnvalue">GtkScrollablePolicy</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-get-hscroll-policy" title="gtk_scrollable_get_hscroll_policy ()">gtk_scrollable_get_hscroll_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-set-hscroll-policy" title="gtk_scrollable_set_hscroll_policy ()">gtk_scrollable_set_hscroll_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="returnvalue">GtkScrollablePolicy</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-get-vscroll-policy" title="gtk_scrollable_get_vscroll_policy ()">gtk_scrollable_get_vscroll_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-set-vscroll-policy" title="gtk_scrollable_set_vscroll_policy ()">gtk_scrollable_set_vscroll_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GtkScrollable.html#gtk-scrollable-get-border" title="gtk_scrollable_get_border ()">gtk_scrollable_get_border</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkScrollable.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *</td>
<td class="property_name"><a class="link" href="GtkScrollable.html#GtkScrollable--hadjustment" title="The “hadjustment” property">hadjustment</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollable.html#GtkScrollable--hscroll-policy" title="The “hscroll-policy” property">hscroll-policy</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *</td>
<td class="property_name"><a class="link" href="GtkScrollable.html#GtkScrollable--vadjustment" title="The “vadjustment” property">vadjustment</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollable.html#GtkScrollable--vscroll-policy" title="The “vscroll-policy” property">vscroll-policy</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkScrollable.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GtkScrollable.html#GtkScrollable-struct" title="GtkScrollable">GtkScrollable</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy">GtkScrollablePolicy</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkScrollable.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> GtkScrollable
</pre>
</div>
<div class="refsect1">
<a name="GtkScrollable.prerequisites"></a><h2>Prerequisites</h2>
<p>
GtkScrollable requires
<a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>.</p>
</div>
<div class="refsect1">
<a name="GtkScrollable.implementations"></a><h2>Known Implementations</h2>
<p>
GtkScrollable is implemented by
<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>
</div>
<div class="refsect1">
<a name="GtkScrollable.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkScrollable.description"></a><h2>Description</h2>
<p><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> is an interface that is implemented by widgets with native
scrolling ability.</p>
<p>To implement this interface you should override the
<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.</p>
<div class="refsect3">
<a name="id-1.3.16.4.10.4"></a><h4>Creating a scrollable widget</h4>
<p>All scrollable widgets should do the following.</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>When a parent widget sets the scrollable child widget’s adjustments,
the widget should populate the adjustments’
<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>,
<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
<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
<a class="link" href="GtkAdjustment.html#GtkAdjustment-value-changed" title="The “value-changed” signal"><span class="type">“value-changed”</span></a> signal.</p></li>
<li class="listitem"><p>Because its preferred size is the size for a fully expanded widget,
the scrollable widget must be able to cope with underallocations.
This means that it must accept any value passed to its
<a class="link" href="GtkWidget.html#GtkWidgetClass.size-allocate"><code class="function">GtkWidgetClass.size_allocate()</code></a> function.</p></li>
<li class="listitem"><p>When the parent allocates space to the scrollable child widget,
the widget should update the adjustments’ properties with new values.</p></li>
<li class="listitem"><p>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,
the scrollable widget should scroll its contents.</p></li>
</ul></div>
</div>
</div>
<div class="refsect1">
<a name="GtkScrollable.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-scrollable-get-hadjustment"></a><h3>gtk_scrollable_get_hadjustment ()</h3>
<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>
<p>Retrieves the <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> used for horizontal scrolling.</p>
<div class="refsect3">
<a name="gtk-scrollable-get-hadjustment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-scrollable-get-hadjustment.returns"></a><h4>Returns</h4>
<p> horizontal <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-set-hadjustment"></a><h3>gtk_scrollable_set_hadjustment ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *hadjustment</code></em>);</pre>
<p>Sets the horizontal adjustment of the <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>.</p>
<div class="refsect3">
<a name="gtk-scrollable-set-hadjustment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>hadjustment</p></td>
<td class="parameter_description"><p> a <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-get-vadjustment"></a><h3>gtk_scrollable_get_vadjustment ()</h3>
<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>
<p>Retrieves the <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> used for vertical scrolling.</p>
<div class="refsect3">
<a name="gtk-scrollable-get-vadjustment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-scrollable-get-vadjustment.returns"></a><h4>Returns</h4>
<p> vertical <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-set-vadjustment"></a><h3>gtk_scrollable_set_vadjustment ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *vadjustment</code></em>);</pre>
<p>Sets the vertical adjustment of the <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a>.</p>
<div class="refsect3">
<a name="gtk-scrollable-set-vadjustment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>vadjustment</p></td>
<td class="parameter_description"><p> a <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-get-hscroll-policy"></a><h3>gtk_scrollable_get_hscroll_policy ()</h3>
<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>
<p>Gets the horizontal <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.</p>
<div class="refsect3">
<a name="gtk-scrollable-get-hscroll-policy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-scrollable-get-hscroll-policy.returns"></a><h4>Returns</h4>
<p> The horizontal <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-set-hscroll-policy"></a><h3>gtk_scrollable_set_hscroll_policy ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> policy</code></em>);</pre>
<p>Sets the <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> to determine whether
horizontal scrolling should start below the minimum width or
below the natural width.</p>
<div class="refsect3">
<a name="gtk-scrollable-set-hscroll-policy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>policy</p></td>
<td class="parameter_description"><p>the horizontal <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-get-vscroll-policy"></a><h3>gtk_scrollable_get_vscroll_policy ()</h3>
<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>
<p>Gets the vertical <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.</p>
<div class="refsect3">
<a name="gtk-scrollable-get-vscroll-policy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-scrollable-get-vscroll-policy.returns"></a><h4>Returns</h4>
<p> The vertical <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a>.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-set-vscroll-policy"></a><h3>gtk_scrollable_set_vscroll_policy ()</h3>
<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>,
<em class="parameter"><code><a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> policy</code></em>);</pre>
<p>Sets the <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a> to determine whether
vertical scrolling should start below the minimum height or
below the natural height.</p>
<div class="refsect3">
<a name="gtk-scrollable-set-vscroll-policy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>policy</p></td>
<td class="parameter_description"><p>the vertical <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-scrollable-get-border"></a><h3>gtk_scrollable_get_border ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gtk_scrollable_get_border (<em class="parameter"><code><a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a> *scrollable</code></em>,
<em class="parameter"><code><a class="link" href="GtkStyleContext.html#GtkBorder"><span class="type">GtkBorder</span></a> *border</code></em>);</pre>
<p>Returns the size of a non-scrolling border around the
outside of the scrollable. An example for this would
be treeview headers. GTK+ can use this information to
display overlayed graphics, like the overshoot indication,
at the right position.</p>
<div class="refsect3">
<a name="gtk-scrollable-get-border.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>scrollable</p></td>
<td class="parameter_description"><p>a <a class="link" href="GtkScrollable.html" title="GtkScrollable"><span class="type">GtkScrollable</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>border</p></td>
<td class="parameter_description"><p> return location for the results. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gtk-scrollable-get-border.returns"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>border</code></em>
has been set</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-16.html#api-index-3.16">3.16</a></p>
</div>
</div>
<div class="refsect1">
<a name="GtkScrollable.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkScrollable-struct"></a><h3>GtkScrollable</h3>
<pre class="programlisting">typedef struct _GtkScrollable GtkScrollable;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollablePolicy"></a><h3>enum GtkScrollablePolicy</h3>
<p>Defines the policy to be used in a scrollable widget when updating
the scrolled window adjustments in a given orientation.</p>
<div class="refsect3">
<a name="GtkScrollablePolicy.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GTK-SCROLL-MINIMUM:CAPS"></a>GTK_SCROLL_MINIMUM</p></td>
<td class="enum_member_description">
<p>Scrollable adjustments are based on the minimum size</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GTK-SCROLL-NATURAL:CAPS"></a>GTK_SCROLL_NATURAL</p></td>
<td class="enum_member_description">
<p>Scrollable adjustments are based on the natural size</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GtkScrollable.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GtkScrollable--hadjustment"></a><h3>The <code class="literal">“hadjustment”</code> property</h3>
<pre class="programlisting"> “hadjustment” <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *</pre>
<p>Horizontal <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> of the scrollable widget. This adjustment is
shared between the scrollable widget and its parent.</p>
<p>Flags: Read / Write / Construct</p>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollable--hscroll-policy"></a><h3>The <code class="literal">“hscroll-policy”</code> property</h3>
<pre class="programlisting"> “hscroll-policy” <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a></pre>
<p>Determines whether horizontal scrolling should start once the scrollable
widget is allocated less than its minimum width or less than its natural width.</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_SCROLL_MINIMUM</p>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollable--vadjustment"></a><h3>The <code class="literal">“vadjustment”</code> property</h3>
<pre class="programlisting"> “vadjustment” <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *</pre>
<p>Verical <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> of the scrollable widget. This adjustment is shared
between the scrollable widget and its parent.</p>
<p>Flags: Read / Write / Construct</p>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollable--vscroll-policy"></a><h3>The <code class="literal">“vscroll-policy”</code> property</h3>
<pre class="programlisting"> “vscroll-policy” <a class="link" href="GtkScrollable.html#GtkScrollablePolicy" title="enum GtkScrollablePolicy"><span class="type">GtkScrollablePolicy</span></a></pre>
<p>Determines whether vertical scrolling should start once the scrollable
widget is allocated less than its minimum height or less than its natural height.</p>
<p>Flags: Read / Write</p>
<p>Default value: GTK_SCROLL_MINIMUM</p>
<p class="since">Since: <a class="link" href="api-index-3-0.html#api-index-3.0">3.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>
|