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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkScrollbar: 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="ScrollingWidgets.html" title="Scrolling">
<link rel="next" href="GtkScrolledWindow.html" title="GtkScrolledWindow">
<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="#GtkScrollbar.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GtkScrollbar.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GtkScrollbar.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_style_properties"> <span class="dim">|</span>
<a href="#GtkScrollbar.style-properties" class="shortcut">Style 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="ScrollingWidgets.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GtkScrolledWindow.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GtkScrollbar"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkScrollbar.top_of_page"></a>GtkScrollbar</span></h2>
<p>GtkScrollbar — A Scrollbar</p>
</td>
<td class="gallery_image" valign="top" align="right"><img src="scrollbar.png"></td>
</tr></table></div>
<div class="refsect1">
<a name="GtkScrollbar.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="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
</td>
<td class="function_name">
<a class="link" href="GtkScrollbar.html#gtk-scrollbar-new" title="gtk_scrollbar_new ()">gtk_scrollbar_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkScrollbar.style-properties"></a><h2>Style Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="style_properties_type">
<col width="300px" class="style_properties_name">
<col width="200px" class="style_properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollbar.html#GtkScrollbar--s-fixed-slider-length" title="The “fixed-slider-length” style property">fixed-slider-length</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollbar.html#GtkScrollbar--s-has-backward-stepper" title="The “has-backward-stepper” style property">has-backward-stepper</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollbar.html#GtkScrollbar--s-has-forward-stepper" title="The “has-forward-stepper” style property">has-forward-stepper</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollbar.html#GtkScrollbar--s-has-secondary-backward-stepper" title="The “has-secondary-backward-stepper” style property">has-secondary-backward-stepper</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollbar.html#GtkScrollbar--s-has-secondary-forward-stepper" title="The “has-secondary-forward-stepper” style property">has-secondary-forward-stepper</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="GtkScrollbar.html#GtkScrollbar--s-min-slider-length" title="The “min-slider-length” style property">min-slider-length</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkScrollbar.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">struct</td>
<td class="function_name"><a class="link" href="GtkScrollbar.html#GtkScrollbar-struct" title="struct GtkScrollbar">GtkScrollbar</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GtkScrollbar.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
<span class="lineart">╰──</span> <a class="link" href="GtkRange.html" title="GtkRange">GtkRange</a>
<span class="lineart">╰──</span> GtkScrollbar
<span class="lineart">├──</span> <a class="link" href="GtkHScrollbar.html" title="GtkHScrollbar">GtkHScrollbar</a>
<span class="lineart">╰──</span> <a class="link" href="GtkVScrollbar.html" title="GtkVScrollbar">GtkVScrollbar</a>
</pre>
</div>
<div class="refsect1">
<a name="GtkScrollbar.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkScrollbar implements
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkScrollbar.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gtk/gtk.h>
</pre>
</div>
<div class="refsect1">
<a name="GtkScrollbar.description"></a><h2>Description</h2>
<p>The <a class="link" href="GtkScrollbar.html" title="GtkScrollbar"><span class="type">GtkScrollbar</span></a> widget is a horizontal or vertical scrollbar,
depending on the value of the <a class="link" href="gtk3-Orientable.html#GtkOrientable--orientation" title="The “orientation” property"><span class="type">“orientation”</span></a> property.</p>
<p>The position of the thumb in a scrollbar is controlled by the scroll
adjustments. See <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> for the fields in an adjustment - for
<a class="link" href="GtkScrollbar.html" title="GtkScrollbar"><span class="type">GtkScrollbar</span></a>, the <a class="link" href="GtkAdjustment.html#GtkAdjustment--value" title="The “value” property"><span class="type">“value”</span></a> field represents the position
of the scrollbar, which must be between the <a class="link" href="GtkAdjustment.html#GtkAdjustment--lower" title="The “lower” property"><span class="type">“lower”</span></a> field
and <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--page-size" title="The “page-size” property"><span class="type">“page-size”</span></a>. The
<a class="link" href="GtkAdjustment.html#GtkAdjustment--page-size" title="The “page-size” property"><span class="type">“page-size”</span></a> field represents the size of the visible
scrollable area. The <a class="link" href="GtkAdjustment.html#GtkAdjustment--step-increment" title="The “step-increment” property"><span class="type">“step-increment”</span></a> and
<a class="link" href="GtkAdjustment.html#GtkAdjustment--page-increment" title="The “page-increment” property"><span class="type">“page-increment”</span></a> fields are properties when the user asks to
step down (using the small stepper arrows) or page down (using for
example the <code class="literal">Page Down</code> key).</p>
<div class="refsect2">
<a name="id-1.3.16.2.9.4"></a><h3>CSS nodes</h3>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8</pre></td>
<td class="listing_code"><pre class="programlisting">scrollbar<span class="gtkdoc opt">[.</span>fine<span class="gtkdoc opt">-</span>tune<span class="gtkdoc opt">]</span>
╰── contents
├── <span class="gtkdoc opt">[</span>button<span class="gtkdoc opt">.</span>up<span class="gtkdoc opt">]</span>
├── <span class="gtkdoc opt">[</span>button<span class="gtkdoc opt">.</span>down<span class="gtkdoc opt">]</span>
├── trough
│ ╰── slider
├── <span class="gtkdoc opt">[</span>button<span class="gtkdoc opt">.</span>up<span class="gtkdoc opt">]</span>
╰── <span class="gtkdoc opt">[</span>button<span class="gtkdoc opt">.</span>down<span class="gtkdoc opt">]</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>GtkScrollbar has a main CSS node with name scrollbar and a subnode for its
contents, with subnodes named trough and slider.</p>
<p>The main node gets the style class .fine-tune added when the scrollbar is
in 'fine-tuning' mode.</p>
<p>If steppers are enabled, they are represented by up to four additional
subnodes with name button. These get the style classes .up and .down to
indicate in which direction they are moving.</p>
<p>Other style classes that may be added to scrollbars inside <a class="link" href="GtkScrolledWindow.html" title="GtkScrolledWindow"><span class="type">GtkScrolledWindow</span></a>
include the positional classes (.left, .right, .top, .bottom) and style
classes related to overlay scrolling (.overlay-indicator, .dragging, .hovering).</p>
</div>
</div>
<div class="refsect1">
<a name="GtkScrollbar.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gtk-scrollbar-new"></a><h3>gtk_scrollbar_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *
gtk_scrollbar_new (<em class="parameter"><code><a class="link" href="gtk3-Standard-Enumerations.html#GtkOrientation" title="enum GtkOrientation"><span class="type">GtkOrientation</span></a> orientation</code></em>,
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *adjustment</code></em>);</pre>
<p>Creates a new scrollbar with the given orientation.</p>
<div class="refsect3">
<a name="gtk-scrollbar-new.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>orientation</p></td>
<td class="parameter_description"><p>the scrollbar’s orientation.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>adjustment</p></td>
<td class="parameter_description"><p> the <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> to use, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to create a new adjustment. </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>
<div class="refsect3">
<a name="gtk-scrollbar-new.returns"></a><h4>Returns</h4>
<p> the new <a class="link" href="GtkScrollbar.html" title="GtkScrollbar"><span class="type">GtkScrollbar</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>
</div>
<div class="refsect1">
<a name="GtkScrollbar.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GtkScrollbar-struct"></a><h3>struct GtkScrollbar</h3>
<pre class="programlisting">struct GtkScrollbar;</pre>
</div>
</div>
<div class="refsect1">
<a name="GtkScrollbar.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2">
<a name="GtkScrollbar--s-fixed-slider-length"></a><h3>The <code class="literal">“fixed-slider-length”</code> style property</h3>
<pre class="programlisting"> “fixed-slider-length” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Don't change slider size, just lock it to the minimum length.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollbar--s-has-backward-stepper"></a><h3>The <code class="literal">“has-backward-stepper”</code> style property</h3>
<pre class="programlisting"> “has-backward-stepper” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Display the standard backward arrow button.</p>
<p>Flags: Read</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollbar--s-has-forward-stepper"></a><h3>The <code class="literal">“has-forward-stepper”</code> style property</h3>
<pre class="programlisting"> “has-forward-stepper” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Display the standard forward arrow button.</p>
<p>Flags: Read</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollbar--s-has-secondary-backward-stepper"></a><h3>The <code class="literal">“has-secondary-backward-stepper”</code> style property</h3>
<pre class="programlisting"> “has-secondary-backward-stepper” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Display a second backward arrow button on the opposite end of the scrollbar.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollbar--s-has-secondary-forward-stepper"></a><h3>The <code class="literal">“has-secondary-forward-stepper”</code> style property</h3>
<pre class="programlisting"> “has-secondary-forward-stepper” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Display a second forward arrow button on the opposite end of the scrollbar.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="GtkScrollbar--s-min-slider-length"></a><h3>The <code class="literal">“min-slider-length”</code> style property</h3>
<pre class="programlisting"> “min-slider-length” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>Minimum length of scrollbar slider.</p>
<div class="warning">
<p><code class="literal">GtkScrollbar:min-slider-length</code> has been deprecated since version 3.20 and should not be used in newly-written code.</p>
<p>Use min-height/min-width CSS properties on the slider
element instead. The value of this style property is ignored.</p>
</div>
<p>Flags: Read</p>
<p>Allowed values: >= 0</p>
<p>Default value: 21</p>
</div>
</div>
<div class="refsect1">
<a name="GtkScrollbar.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>, <a class="link" href="GtkScrolledWindow.html" title="GtkScrolledWindow"><span class="type">GtkScrolledWindow</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>
|
