]> Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkcontainer.sgml
Add docs.
[~andy/gtk] / docs / reference / gtk / tmpl / gtkcontainer.sgml
1 <!-- ##### SECTION Title ##### -->
2 GtkContainer
3
4 <!-- ##### SECTION Short_Description ##### -->
5 Base class for widgets which contain other widgets
6
7 <!-- ##### SECTION Long_Description ##### -->
8 <para id="child-properties">
9 <structname>GtkContainer</structname> introduces <firstterm>child 
10 properties</firstterm> - these are object properties that are not specific
11 to either the container or the contained widget, but rather to their relation.
12 Typical examples of child properties are the position or pack-type of a widget
13 which is contained in a #GtkBox.</para>
14 <para>
15 Use gtk_container_class_install_child_property() to install child properties 
16 for a container class and gtk_container_class_find_child_property() or
17 gtk_container_class_list_child_properties() to get information about existing
18 child properties.
19 </para>
20 <para>
21 To set the value of a child property, use gtk_container_child_set_property(), 
22 gtk_container_child_set() or gtk_container_child_set_valist(). 
23 To obtain the value of a child property, use 
24 gtk_container_child_get_property(), gtk_container_child_get() or
25 gtk_container_child_get_valist(). To emit notification about child property 
26 changes, use gtk_widget_child_notify().
27 </para>
28 <!-- ##### SECTION See_Also ##### -->
29 <para>
30
31 </para>
32
33 <!-- ##### STRUCT GtkContainer ##### -->
34 <para>
35
36 </para>
37
38
39 <!-- ##### MACRO GTK_IS_RESIZE_CONTAINER ##### -->
40 <para>
41
42 </para>
43
44 @widget: 
45
46
47 <!-- ##### MACRO GTK_CONTAINER_WARN_INVALID_CHILD_PROPERTY_ID ##### -->
48 <para>
49
50 </para>
51
52 @object: 
53 @property_id: 
54 @pspec: 
55
56
57 <!-- ##### MACRO gtk_container_border_width ##### -->
58 <para>
59 Does the same as gtk_container_get_border_width().
60 </para>
61
62 @Deprecated: Use gtk_container_get_border_width() instead.
63
64
65 <!-- ##### FUNCTION gtk_container_add ##### -->
66 <para>
67
68 </para>
69
70 @container: 
71 @widget: 
72
73
74 <!-- ##### FUNCTION gtk_container_remove ##### -->
75 <para>
76
77 </para>
78
79 @container: 
80 @widget: 
81
82
83 <!-- ##### FUNCTION gtk_container_add_with_properties ##### -->
84 <para>
85
86 </para>
87
88 @container: 
89 @widget: 
90 @first_prop_name: 
91 @Varargs: 
92
93
94 <!-- ##### FUNCTION gtk_container_get_resize_mode ##### -->
95 <para>
96
97 </para>
98
99 @container: 
100 @Returns: 
101
102
103 <!-- ##### FUNCTION gtk_container_set_resize_mode ##### -->
104 <para>
105
106 </para>
107
108 @container: 
109 @resize_mode: 
110
111
112 <!-- ##### FUNCTION gtk_container_check_resize ##### -->
113 <para>
114
115 </para>
116
117 @container: 
118
119
120 <!-- ##### FUNCTION gtk_container_foreach ##### -->
121 <para>
122
123 </para>
124
125 @container: 
126 @callback: 
127 @callback_data: 
128
129
130 <!-- ##### FUNCTION gtk_container_foreach_full ##### -->
131 <para>
132
133 </para>
134
135 @container: 
136 @callback: 
137 @marshal: 
138 @callback_data: 
139 @notify: 
140 @Deprecated: Use gtk_container_foreach() instead.
141
142
143 <!-- ##### MACRO gtk_container_children ##### -->
144 <para>
145 Does the same as gtk_container_get_children().
146 </para>
147
148 @Returns: 
149 @Deprecated: Use gtk_container_get_children() instead.
150
151
152 <!-- ##### FUNCTION gtk_container_get_children ##### -->
153 <para>
154
155 </para>
156
157 @container: 
158 @Returns: 
159
160
161 <!-- ##### FUNCTION gtk_container_set_reallocate_redraws ##### -->
162 <para>
163
164 </para>
165
166 @container: 
167 @needs_redraws: 
168
169
170 <!-- ##### FUNCTION gtk_container_set_focus_child ##### -->
171 <para>
172
173 </para>
174
175 @container: 
176 @child: 
177
178
179 <!-- ##### FUNCTION gtk_container_get_focus_vadjustment ##### -->
180 <para>
181
182 </para>
183
184 @container: 
185 @Returns: 
186
187
188 <!-- ##### FUNCTION gtk_container_set_focus_vadjustment ##### -->
189 <para>
190
191 </para>
192
193 @container: 
194 @adjustment: 
195
196
197 <!-- ##### FUNCTION gtk_container_get_focus_hadjustment ##### -->
198 <para>
199
200 </para>
201
202 @container: 
203 @Returns: 
204
205
206 <!-- ##### FUNCTION gtk_container_set_focus_hadjustment ##### -->
207 <para>
208
209 </para>
210
211 @container: 
212 @adjustment: 
213
214
215 <!-- ##### FUNCTION gtk_container_resize_children ##### -->
216 <para>
217
218 </para>
219
220 @container: 
221
222
223 <!-- ##### FUNCTION gtk_container_child_type ##### -->
224 <para>
225
226 </para>
227
228 @container: 
229 @Returns: 
230
231
232 <!-- ##### FUNCTION gtk_container_child_get ##### -->
233 <para>
234
235 </para>
236
237 @container: 
238 @child: 
239 @first_prop_name: 
240 @Varargs: 
241
242
243 <!-- ##### FUNCTION gtk_container_child_set ##### -->
244 <para>
245
246 </para>
247
248 @container: 
249 @child: 
250 @first_prop_name: 
251 @Varargs: 
252 <!-- # Unused Parameters # -->
253 @first_arg_name: 
254
255
256 <!-- ##### FUNCTION gtk_container_child_get_property ##### -->
257 <para>
258
259 </para>
260
261 @container: 
262 @child: 
263 @property_name: 
264 @value: 
265
266
267 <!-- ##### FUNCTION gtk_container_child_set_property ##### -->
268 <para>
269
270 </para>
271
272 @container: 
273 @child: 
274 @property_name: 
275 @value: 
276
277
278 <!-- ##### FUNCTION gtk_container_child_get_valist ##### -->
279 <para>
280
281 </para>
282
283 @container: 
284 @child: 
285 @first_property_name: 
286 @var_args: 
287
288
289 <!-- ##### FUNCTION gtk_container_child_set_valist ##### -->
290 <para>
291
292 </para>
293
294 @container: 
295 @child: 
296 @first_property_name: 
297 @var_args: 
298
299
300 <!-- ##### FUNCTION gtk_container_forall ##### -->
301 <para>
302
303 </para>
304
305 @container: 
306 @callback: 
307 @callback_data: 
308
309
310 <!-- ##### FUNCTION gtk_container_get_border_width ##### -->
311 <para>
312
313 </para>
314
315 @container: 
316 @Returns: 
317
318
319 <!-- ##### FUNCTION gtk_container_set_border_width ##### -->
320 <para>
321
322 </para>
323
324 @container: 
325 @border_width: 
326
327
328 <!-- ##### FUNCTION gtk_container_propagate_expose ##### -->
329 <para>
330
331 </para>
332
333 @container: 
334 @child: 
335 @event: 
336
337
338 <!-- ##### FUNCTION gtk_container_get_focus_chain ##### -->
339 <para>
340
341 </para>
342
343 @container: 
344 @focusable_widgets: 
345 @Returns: 
346
347
348 <!-- ##### FUNCTION gtk_container_set_focus_chain ##### -->
349 <para>
350
351 </para>
352
353 @container: 
354 @focusable_widgets: 
355
356
357 <!-- ##### FUNCTION gtk_container_unset_focus_chain ##### -->
358 <para>
359
360 </para>
361
362 @container: 
363
364
365 <!-- ##### FUNCTION gtk_container_class_find_child_property ##### -->
366 <para>
367
368 </para>
369
370 @cclass: 
371 @property_name: 
372 @Returns: 
373 <!-- # Unused Parameters # -->
374 @class: 
375
376
377 <!-- ##### FUNCTION gtk_container_class_install_child_property ##### -->
378 <para>
379
380 </para>
381
382 @cclass: 
383 @property_id: 
384 @pspec: 
385 <!-- # Unused Parameters # -->
386 @class: 
387
388
389 <!-- ##### FUNCTION gtk_container_class_list_child_properties ##### -->
390 <para>
391
392 </para>
393
394 @cclass: 
395 @n_properties: 
396 @Returns: 
397 <!-- # Unused Parameters # -->
398 @class: 
399
400
401 <!-- ##### SIGNAL GtkContainer::add ##### -->
402 <para>
403
404 </para>
405
406 @container: the object which received the signal.
407 @widget: 
408
409 <!-- ##### SIGNAL GtkContainer::check-resize ##### -->
410 <para>
411
412 </para>
413
414 @container: the object which received the signal.
415
416 <!-- ##### SIGNAL GtkContainer::remove ##### -->
417 <para>
418
419 </para>
420
421 @container: the object which received the signal.
422 @widget: 
423
424 <!-- ##### SIGNAL GtkContainer::set-focus-child ##### -->
425 <para>
426
427 </para>
428
429 @container: the object which received the signal.
430 @widget: 
431
432 <!-- ##### ARG GtkContainer:border-width ##### -->
433 <para>
434
435 </para>
436
437 <!-- ##### ARG GtkContainer:child ##### -->
438 <para>
439
440 </para>
441
442 <!-- ##### ARG GtkContainer:resize-mode ##### -->
443 <para>
444
445 </para>
446