summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml
blob: a35292772b123f1a613fc3650e466696d9406124 (plain)
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
<!-- ##### SECTION Title ##### -->
GtkScrolledWindow

<!-- ##### SECTION Short_Description ##### -->
Adds scrollbars to its child widget

<!-- ##### SECTION Long_Description ##### -->
<para>
#GtkScrolledWindow is a #GtkBin subclass: it's a container 
the accepts a single child widget. #GtkScrolledWindow adds scrollbars
to the child widget and optionally draws a beveled frame around the 
child widget.
</para>

<para>
The scrolled window can work in two ways. Some widgets have native
scrolling support; these widgets have "slots" for #GtkAdjustment
objects. 
<footnote><para>The scrolled window installs #GtkAdjustment objects in
the child window's slots using the set_scroll_adjustments_signal,
found in #GtkWidgetClass. (Conceptually, these widgets implement a
"Scrollable" interface; because GTK+ 1.2 lacked interface support in
the object system, this interface is hackily implemented as a signal
in #GtkWidgetClass. The GTK+ 2.0 object system would allow a clean
implementation, but it wasn't worth breaking the
API.)</para></footnote>
Widgets with native scroll support include #GtkTreeView, #GtkTextView, 
and #GtkLayout.
</para>

<para>
For widgets that lack native scrolling support, the #GtkViewport
widget acts as an adaptor class, implementing scrollability for child
widgets that lack their own scrolling capabilities. Use #GtkViewport
to scroll child widgets such as #GtkTable, #GtkBox, and so on.
</para>

<para>
If a widget has native scrolling abilities, it can be added to the
#GtkScrolledWindow with gtk_container_add(). If a widget does not, you
must first add the widget to a #GtkViewport, then add the #GtkViewport
to the scrolled window. The convenience function
gtk_scrolled_window_add_with_viewport() does exactly this, so you can
ignore the presence of the viewport.
</para>

<para>
The position of the scrollbars is controlled by the scroll
adjustments. See #GtkAdjustment for the fields in an adjustment - for
#GtkScrollbar, used by #GtkScrolledWindow, the "value" field
represents the position of the scrollbar, which must be between the
"lower" field and "upper - page_size." The "page_size" field
represents the size of the visible scrollable area. The
"step_increment" and "page_increment" fields are used when the user
asks to step down (using the small stepper arrows) or page down (using
for example the PageDown key).
</para>

<para>
If a #GtkScrolledWindow 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 #GtkScrollbar and for example a #GtkTable.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GtkViewport, #GtkAdjustment, #GtkWidgetClass
</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### SECTION Image ##### -->


<!-- ##### STRUCT GtkScrolledWindow ##### -->
<para>
There are no public fields in the #GtkScrolledWindow struct; it should 
only be accessed using the functions below.
</para>


<!-- ##### SIGNAL GtkScrolledWindow::move-focus-out ##### -->
<para>

</para>

@scrolledwindow: 
@arg1: 

<!-- ##### SIGNAL GtkScrolledWindow::scroll-child ##### -->
<para>

</para>

@scrolledwindow: 
@arg1: 
@arg2: 
@Returns: 

<!-- ##### ARG GtkScrolledWindow:hadjustment ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:hscrollbar-policy ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:shadow-type ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:vadjustment ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:vscrollbar-policy ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:window-placement ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:window-placement-set ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:scrollbar-spacing ##### -->
<para>

</para>

<!-- ##### ARG GtkScrolledWindow:scrollbars-within-bevel ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_scrolled_window_new ##### -->
<para>

</para>

@hadjustment: 
@vadjustment: 
@Returns: 


<!-- ##### FUNCTION gtk_scrolled_window_get_hadjustment ##### -->
<para>

</para>

@scrolled_window: 
@Returns: 


<!-- ##### FUNCTION gtk_scrolled_window_get_vadjustment ##### -->
<para>

</para>

@scrolled_window: 
@Returns: 


<!-- ##### FUNCTION gtk_scrolled_window_get_hscrollbar ##### -->
<para>

</para>

@scrolled_window: 
@Returns: 


<!-- ##### FUNCTION gtk_scrolled_window_get_vscrollbar ##### -->
<para>

</para>

@scrolled_window: 
@Returns: 


<!-- ##### FUNCTION gtk_scrolled_window_set_policy ##### -->
<para>

</para>

@scrolled_window: 
@hscrollbar_policy: 
@vscrollbar_policy: 


<!-- ##### FUNCTION gtk_scrolled_window_add_with_viewport ##### -->
<para>

</para>

@scrolled_window: 
@child: 


<!-- ##### FUNCTION gtk_scrolled_window_set_placement ##### -->
<para>

</para>

@scrolled_window: 
@window_placement: 


<!-- ##### FUNCTION gtk_scrolled_window_unset_placement ##### -->
<para>

</para>

@scrolled_window: 


<!-- ##### FUNCTION gtk_scrolled_window_set_shadow_type ##### -->
<para>

</para>

@scrolled_window: 
@type: 


<!-- ##### FUNCTION gtk_scrolled_window_set_hadjustment ##### -->
<para>

</para>

@scrolled_window: 
@hadjustment: 


<!-- ##### FUNCTION gtk_scrolled_window_set_vadjustment ##### -->
<para>

</para>

@scrolled_window: 
@vadjustment: 


<!-- ##### FUNCTION gtk_scrolled_window_get_placement ##### -->
<para>

</para>

@scrolled_window: 
@Returns: 


<!-- ##### FUNCTION gtk_scrolled_window_get_policy ##### -->
<para>

</para>

@scrolled_window: 
@hscrollbar_policy: 
@vscrollbar_policy: 


<!-- ##### FUNCTION gtk_scrolled_window_get_shadow_type ##### -->
<para>

</para>

@scrolled_window: 
@Returns: