gtktoolbar.sgml 7.29 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<!-- ##### SECTION Title ##### -->
GtkToolbar

<!-- ##### SECTION Short_Description ##### -->
create bars of buttons and other widgets.

<!-- ##### SECTION Long_Description ##### -->
<para>
A toolbar is created with a call to gtk_toolbar_new().
</para>
<para>
Buttons with text and/or images are added with gtk_toolbar_append_item(), gtk_toolbar_prepend_item(), and gtk_toolbar_insert_item().
</para>
<para>
Any of #GtkToggleButton, #GtkRadioButton, or an arbitrary widget can be added to the toolbar with gtk_toolbar_append_element(), gtk_toolbar_prepend_element(), and gtk_toolbar_insert_element().
</para>
<para>
18
Widgets can be visibly grouped by adding gaps between widgets using gtk_toolbar_append_space(), gtk_toolbar_prepend_space(), and gtk_toolbar_insert_space().
Owen Taylor's avatar
Owen Taylor committed
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
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
<varlistentry>
<term>#GtkToolTips</term>
<listitem><para>Change the properties of a #GtkToolbar's #GtkTooltips.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkTipsQuery</term>
<listitem><para>Make use of the private tips of toolbar elements.</para></listitem>
</varlistentry>
</variablelist>
</para>

<!-- ##### STRUCT GtkToolbar ##### -->
<para>
<structfield>num_children</structfield> is an integer specifying how many toolbar items the #GtkToolbar contains. <structfield>children</structfield> is a #GList of the child widgets of the toolbar.
</para>
<para>
<structfield>orientation</structfield>
</para>


<!-- ##### ENUM GtkToolbarChildType ##### -->
<para>
46
47
#GtkToolbarChildType is used to set the type of new elements that are added 
to a #GtkToolbar.
Owen Taylor's avatar
Owen Taylor committed
48
49
</para>

50
51
@GTK_TOOLBAR_CHILD_SPACE: a space in the style of the toolbar's #GtkToolbarSpaceStyle.
@GTK_TOOLBAR_CHILD_BUTTON: a #GtkButton.
52
53
54
@GTK_TOOLBAR_CHILD_TOGGLEBUTTON: a #GtkToggleButton.
@GTK_TOOLBAR_CHILD_RADIOBUTTON: a #GtkRadioButton.
@GTK_TOOLBAR_CHILD_WIDGET: a standard #GtkWidget.
Owen Taylor's avatar
Owen Taylor committed
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

<!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
<para>

</para>

@GTK_TOOLBAR_SPACE_EMPTY: 
@GTK_TOOLBAR_SPACE_LINE: 

<!-- ##### STRUCT GtkToolbarChild ##### -->
<para>

</para>

@type: 
@widget: 
@icon: 
@label: 

<!-- ##### FUNCTION gtk_toolbar_new ##### -->
<para>
76

Owen Taylor's avatar
Owen Taylor committed
77
78
</para>

79
@Returns: the newly-created toolbar.
Owen Taylor's avatar
Owen Taylor committed
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
<!-- ##### FUNCTION gtk_toolbar_insert ##### -->
<para>

</para>

@toolbar: 
@item: 
@pos: 


<!-- ##### FUNCTION gtk_toolbar_get_item_index ##### -->
<para>

</para>

@toolbar: 
@item: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_n_items ##### -->
<para>

</para>

@toolbar: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_nth_item ##### -->
<para>

</para>

@toolbar: 
@n: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_drop_index ##### -->
<para>

</para>

@toolbar: 
@x: 
@y: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_set_show_arrow ##### -->
<para>

</para>

@toolbar: 
@show_arrow: 


<!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
<para>
143

144
145
</para>

146
147
@toolbar:
@orientation:
148
149
150
151


<!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### -->
<para>
152

153
154
</para>

155
156
@toolbar:
@enable:
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


<!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
<para>

</para>

@toolbar: 


<!-- ##### FUNCTION gtk_toolbar_get_show_arrow ##### -->
<para>

</para>

@toolbar: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_orientation ##### -->
<para>

</para>

@toolbar: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
<para>

</para>

@toolbar: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
<para>

</para>

@toolbar: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_tooltips ##### -->
<para>

</para>

@toolbar: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_get_relief_style ##### -->
<para>

</para>

@toolbar: 
@Returns: 


Owen Taylor's avatar
Owen Taylor committed
221
222
<!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
<para>
223

Owen Taylor's avatar
Owen Taylor committed
224
225
</para>

226
227
228
229
230
231
232
233
@toolbar:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
Owen Taylor's avatar
Owen Taylor committed
234
235
236
237


<!-- ##### FUNCTION gtk_toolbar_prepend_item ##### -->
<para>
238

Owen Taylor's avatar
Owen Taylor committed
239
240
</para>

241
242
243
244
245
246
247
248
@toolbar:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
Owen Taylor's avatar
Owen Taylor committed
249
250
251
252


<!-- ##### FUNCTION gtk_toolbar_insert_item ##### -->
<para>
253

Owen Taylor's avatar
Owen Taylor committed
254
255
</para>

256
257
258
259
260
261
262
263
264
@toolbar:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@position:
@Returns:
Owen Taylor's avatar
Owen Taylor committed
265
266
267
268


<!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
<para>
269

Owen Taylor's avatar
Owen Taylor committed
270
271
</para>

272
@toolbar:
Owen Taylor's avatar
Owen Taylor committed
273
274
275
276


<!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
<para>
277

Owen Taylor's avatar
Owen Taylor committed
278
279
</para>

280
@toolbar:
Owen Taylor's avatar
Owen Taylor committed
281
282
283
284


<!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
<para>
285

Owen Taylor's avatar
Owen Taylor committed
286
287
</para>

288
289
@toolbar:
@position:
Owen Taylor's avatar
Owen Taylor committed
290
291
292
293


<!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
<para>
294

Owen Taylor's avatar
Owen Taylor committed
295
</para>
296
<para>
297

298
</para>
Owen Taylor's avatar
Owen Taylor committed
299

300
301
302
303
304
305
306
307
308
309
@toolbar:
@type:
@widget:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
Owen Taylor's avatar
Owen Taylor committed
310
311
312
313


<!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
<para>
314

Owen Taylor's avatar
Owen Taylor committed
315
</para>
316
317
:<para>
I
318
</para>
Owen Taylor's avatar
Owen Taylor committed
319

320
321
322
323
324
325
326
327
328
329
@toolbar:
@type:
@widget:
@text:
@tooltip_text:
@tooltip_private_text:
@icon:
@callback:
@user_data:
@Returns:
Owen Taylor's avatar
Owen Taylor committed
330
331
332
333
334
335
336


<!-- ##### FUNCTION gtk_toolbar_insert_element ##### -->
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
337
338
339
@toolbar: 
@type: 
@widget: 
340
341
@text: 
@tooltip_text: 
Owen Taylor's avatar
Owen Taylor committed
342
343
@tooltip_private_text: 
@icon: 
344
@callback: 
Owen Taylor's avatar
Owen Taylor committed
345
346
347
@user_data: 
@position: 
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
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


<!-- ##### FUNCTION gtk_toolbar_append_widget ##### -->
<para>

</para>

@toolbar: 
@widget: 
@tooltip_text: 
@tooltip_private_text: 


<!-- ##### FUNCTION gtk_toolbar_prepend_widget ##### -->
<para>

</para>

@toolbar: 
@widget: 
@tooltip_text: 
@tooltip_private_text: 


<!-- ##### FUNCTION gtk_toolbar_insert_widget ##### -->
<para>

</para>

@toolbar: 
@widget: 
@tooltip_text: 
@tooltip_private_text: 
@position: 


<!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
<para>
386

Owen Taylor's avatar
Owen Taylor committed
387
388
</para>

389
390
@toolbar:
@style:
Owen Taylor's avatar
Owen Taylor committed
391
392


Havoc Pennington's avatar
Havoc Pennington committed
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
<para>

</para>

@toolbar: 
@stock_id: 
@tooltip_text: 
@tooltip_private_text: 
@callback: 
@user_data: 
@position: 
@Returns: 


<!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
<para>

</para>

@toolbar: 
@icon_size: 


417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
<!-- ##### FUNCTION gtk_toolbar_remove_space ##### -->
<para>

</para>

@toolbar: 
@position: 


<!-- ##### FUNCTION gtk_toolbar_unset_style ##### -->
<para>

</para>

@toolbar: 


Owen Taylor's avatar
Owen Taylor committed
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
<!-- ##### SIGNAL GtkToolbar::focus-home-or-end ##### -->
<para>

</para>

@toolbar: the object which received the signal.
@arg1: 
@Returns: 

<!-- ##### SIGNAL GtkToolbar::move-focus ##### -->
<para>

</para>

@toolbar: the object which received the signal.
@arg1: 
@Returns: 

Owen Taylor's avatar
Owen Taylor committed
452
453
<!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
<para>
454

Owen Taylor's avatar
Owen Taylor committed
455
456
457
458
459
</para>

@toolbar: the object which received the signal.
@orientation: the new #GtkOrientation of the toolbar.

Owen Taylor's avatar
Owen Taylor committed
460
461
462
463
464
465
<!-- ##### SIGNAL GtkToolbar::popup-context-menu ##### -->
<para>

</para>

@toolbar: the object which received the signal.
466
@Returns: 
Owen Taylor's avatar
Owen Taylor committed
467

Owen Taylor's avatar
Owen Taylor committed
468
469
<!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
<para>
470

Owen Taylor's avatar
Owen Taylor committed
471
472
</para>

473
474
@toolbar:
@style:
Owen Taylor's avatar
Owen Taylor committed
475

476
477
478
479
480
<!-- ##### ARG GtkToolbar:orientation ##### -->
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
481
482
483
484
485
<!-- ##### ARG GtkToolbar:show-arrow ##### -->
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
486
<!-- ##### ARG GtkToolbar:toolbar-style ##### -->
487
488
489
490
<para>

</para>

Owen Taylor's avatar
Owen Taylor committed
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
<!-- ##### ARG GtkToolbar:expand ##### -->
<para>

</para>

<!-- ##### ARG GtkToolbar:homogeneous ##### -->
<para>

</para>

<!-- ##### ARG GtkToolbar:pack-end ##### -->
<para>

</para>

506
<!-- ##### ARG GtkToolbar:button-relief ##### -->
507
508
509
510
<para>

</para>

511
<!-- ##### ARG GtkToolbar:internal-padding ##### -->
512
513
514
515
<para>

</para>

516
<!-- ##### ARG GtkToolbar:shadow-type ##### -->
517
518
519
520
<para>

</para>

Owen Taylor's avatar
Update.    
Owen Taylor committed
521
<!-- ##### ARG GtkToolbar:space-size ##### -->
522
523
524
525
<para>

</para>

526
<!-- ##### ARG GtkToolbar:space-style ##### -->
527
528
529
530
<para>

</para>