Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktoolbar.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkToolbar
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Create bars of buttons and other widgets.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A toolbar is created with a call to gtk_toolbar_new().
  10 </para>
  11 <para>
  12 A toolbar can contain instances of a subclass of #GtkToolItem. To add
  13 a #GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove
  14 an item from the toolbar use gtk_container_remove(). To add a button
  15 to the toolbar, add an instance of #GtkToolButton.
  16 </para>
  17 <para>
  18 Toolbar items can be visually grouped by adding instances of
  19 #GtkSeparatorToolItem to the toolbar. If a #GtkSeparatorToolItem has
  20 the "expand" property set to #TRUE and the "draw" property set to
  21 #FALSE the effect is to force all following items to the end of the
  22 toolbar.
  23 </para>
  24 <para>
  25 Creating a context menu for the toolbar can be done by connecting to
  26 the #GtkToolbar::popup-context-menu signal.
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30 <para>
  31 <variablelist>
  32
  33 <varlistentry>
  34 <term>#GtkToolItem</term>
  35 <listitem><para>Base class of widgets that can be added to a toolbar.</para></listitem>
  36 </varlistentry>
  37
  38 </variablelist>
  39 </para>
  40
  41 <!-- ##### STRUCT GtkToolbar ##### -->
  42 <para>
  43 The #GtkToolbar struct only contains private data and should only be
  44 accessed through the function described below.
  45 </para>
  46
  47 @num_children:
  48 @children:
  49 @orientation:
  50 @style:
  51 @icon_size:
  52 @tooltips:
  53
  54 <!-- ##### SIGNAL GtkToolbar::focus-home-or-end ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @toolbar: the object which received the signal.
  60 @arg1:
  61 @Returns:
  62
  63 <!-- ##### SIGNAL GtkToolbar::move-focus ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @toolbar: the object which received the signal.
  69 @arg1:
  70 @Returns:
  71
  72 <!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @toolbar: the object which received the signal.
  78 @orientation: the new #GtkOrientation of the toolbar.
  79
  80 <!-- ##### SIGNAL GtkToolbar::popup-context-menu ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @toolbar: the object which received the signal.
  86 @Returns:
  87 @:
  88 @:
  89 @Returns:
  90 @:
  91 @Returns:
  92 @Returns:
  93
  94 <!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @toolbar:
 100 @style:
 101
 102 <!-- ##### ARG GtkToolbar:orientation ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG GtkToolbar:show-arrow ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG GtkToolbar:toolbar-style ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### ARG GtkToolbar:expand ##### -->
 118 <para>
 119
 120 </para>
 121
 122 <!-- ##### ARG GtkToolbar:homogeneous ##### -->
 123 <para>
 124
 125 </para>
 126
 127 <!-- ##### ARG GtkToolbar:button-relief ##### -->
 128 <para>
 129
 130 </para>
 131
 132 <!-- ##### ARG GtkToolbar:internal-padding ##### -->
 133 <para>
 134
 135 </para>
 136
 137 <!-- ##### ARG GtkToolbar:shadow-type ##### -->
 138 <para>
 139
 140 </para>
 141
 142 <!-- ##### ARG GtkToolbar:space-size ##### -->
 143 <para>
 144
 145 </para>
 146
 147 <!-- ##### ARG GtkToolbar:space-style ##### -->
 148 <para>
 149
 150 </para>
 151
 152 <!-- ##### ENUM GtkToolbarChildType ##### -->
 153 <para>
 154 #GtkToolbarChildType is used to set the type of new elements that are added
 155 to a #GtkToolbar.
 156 </para>
 157
 158 @GTK_TOOLBAR_CHILD_SPACE: a space in the style of the toolbar's #GtkToolbarSpaceStyle.
 159 @GTK_TOOLBAR_CHILD_BUTTON: a #GtkButton.
 160 @GTK_TOOLBAR_CHILD_TOGGLEBUTTON: a #GtkToggleButton.
 161 @GTK_TOOLBAR_CHILD_RADIOBUTTON: a #GtkRadioButton.
 162 @GTK_TOOLBAR_CHILD_WIDGET: a standard #GtkWidget.
 163
 164 <!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @GTK_TOOLBAR_SPACE_EMPTY:
 170 @GTK_TOOLBAR_SPACE_LINE:
 171
 172 <!-- ##### STRUCT GtkToolbarChild ##### -->
 173 <para>
 174
 175 </para>
 176
 177 @type:
 178 @widget:
 179 @icon:
 180 @label:
 181
 182 <!-- ##### FUNCTION gtk_toolbar_new ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @Returns: the newly-created toolbar.
 188
 189
 190 <!-- ##### FUNCTION gtk_toolbar_insert ##### -->
 191 <para>
 192
 193 </para>
 194
 195 @toolbar:
 196 @item:
 197 @pos:
 198
 199
 200 <!-- ##### FUNCTION gtk_toolbar_get_item_index ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @toolbar:
 206 @item:
 207 @Returns:
 208
 209
 210 <!-- ##### FUNCTION gtk_toolbar_get_n_items ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @toolbar:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION gtk_toolbar_get_nth_item ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @toolbar:
 225 @n:
 226 @Returns:
 227
 228
 229 <!-- ##### FUNCTION gtk_toolbar_get_drop_index ##### -->
 230 <para>
 231
 232 </para>
 233
 234 @toolbar:
 235 @x:
 236 @y:
 237 @Returns:
 238
 239
 240 <!-- ##### FUNCTION gtk_toolbar_set_drop_highlight_item ##### -->
 241 <para>
 242
 243 </para>
 244
 245 @toolbar:
 246 @tool_item:
 247 @index_:
 248 <!-- # Unused Parameters # -->
 249 @index:
 250
 251
 252 <!-- ##### FUNCTION gtk_toolbar_set_show_arrow ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @toolbar:
 258 @show_arrow:
 259
 260
 261 <!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @toolbar:
 267 @orientation:
 268
 269
 270 <!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @toolbar:
 276 @enable:
 277
 278
 279 <!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @toolbar:
 285
 286
 287 <!-- ##### FUNCTION gtk_toolbar_get_show_arrow ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @toolbar:
 293 @Returns:
 294
 295
 296 <!-- ##### FUNCTION gtk_toolbar_get_orientation ##### -->
 297 <para>
 298
 299 </para>
 300
 301 @toolbar:
 302 @Returns:
 303
 304
 305 <!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
 306 <para>
 307
 308 </para>
 309
 310 @toolbar:
 311 @Returns:
 312
 313
 314 <!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
 315 <para>
 316
 317 </para>
 318
 319 @toolbar:
 320 @Returns:
 321
 322
 323 <!-- ##### FUNCTION gtk_toolbar_get_tooltips ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @toolbar:
 329 @Returns:
 330
 331
 332 <!-- ##### FUNCTION gtk_toolbar_get_relief_style ##### -->
 333 <para>
 334
 335 </para>
 336
 337 @toolbar:
 338 @Returns:
 339
 340
 341 <!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @toolbar:
 347 @text:
 348 @tooltip_text:
 349 @tooltip_private_text:
 350 @icon:
 351 @callback:
 352 @user_data:
 353 @Returns:
 354
 355
 356 <!-- ##### FUNCTION gtk_toolbar_prepend_item ##### -->
 357 <para>
 358
 359 </para>
 360
 361 @toolbar:
 362 @text:
 363 @tooltip_text:
 364 @tooltip_private_text:
 365 @icon:
 366 @callback:
 367 @user_data:
 368 @Returns:
 369
 370
 371 <!-- ##### FUNCTION gtk_toolbar_insert_item ##### -->
 372 <para>
 373
 374 </para>
 375
 376 @toolbar:
 377 @text:
 378 @tooltip_text:
 379 @tooltip_private_text:
 380 @icon:
 381 @callback:
 382 @user_data:
 383 @position:
 384 @Returns:
 385
 386
 387 <!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @toolbar:
 393
 394
 395 <!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
 396 <para>
 397
 398 </para>
 399
 400 @toolbar:
 401
 402
 403 <!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
 404 <para>
 405
 406 </para>
 407
 408 @toolbar:
 409 @position:
 410
 411
 412 <!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
 413 <para>
 414
 415 </para>
 416 <para>
 417
 418 </para>
 419
 420 @toolbar:
 421 @type:
 422 @widget:
 423 @text:
 424 @tooltip_text:
 425 @tooltip_private_text:
 426 @icon:
 427 @callback:
 428 @user_data:
 429 @Returns:
 430
 431
 432 <!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @toolbar:
 438 @type:
 439 @widget:
 440 @text:
 441 @tooltip_text:
 442 @tooltip_private_text:
 443 @icon:
 444 @callback:
 445 @user_data:
 446 @Returns:
 447
 448
 449 <!-- ##### FUNCTION gtk_toolbar_insert_element ##### -->
 450 <para>
 451
 452 </para>
 453
 454 @toolbar:
 455 @type:
 456 @widget:
 457 @text:
 458 @tooltip_text:
 459 @tooltip_private_text:
 460 @icon:
 461 @callback:
 462 @user_data:
 463 @position:
 464 @Returns:
 465
 466
 467 <!-- ##### FUNCTION gtk_toolbar_append_widget ##### -->
 468 <para>
 469
 470 </para>
 471
 472 @toolbar:
 473 @widget:
 474 @tooltip_text:
 475 @tooltip_private_text:
 476
 477
 478 <!-- ##### FUNCTION gtk_toolbar_prepend_widget ##### -->
 479 <para>
 480
 481 </para>
 482
 483 @toolbar:
 484 @widget:
 485 @tooltip_text:
 486 @tooltip_private_text:
 487
 488
 489 <!-- ##### FUNCTION gtk_toolbar_insert_widget ##### -->
 490 <para>
 491
 492 </para>
 493
 494 @toolbar:
 495 @widget:
 496 @tooltip_text:
 497 @tooltip_private_text:
 498 @position:
 499
 500
 501 <!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
 502 <para>
 503
 504 </para>
 505
 506 @toolbar:
 507 @style:
 508
 509
 510 <!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
 511 <para>
 512
 513 </para>
 514
 515 @toolbar:
 516 @stock_id:
 517 @tooltip_text:
 518 @tooltip_private_text:
 519 @callback:
 520 @user_data:
 521 @position:
 522 @Returns:
 523
 524
 525 <!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
 526 <para>
 527
 528 </para>
 529
 530 @toolbar:
 531 @icon_size:
 532
 533
 534 <!-- ##### FUNCTION gtk_toolbar_remove_space ##### -->
 535 <para>
 536
 537 </para>
 538
 539 @toolbar:
 540 @position:
 541
 542
 543 <!-- ##### FUNCTION gtk_toolbar_unset_style ##### -->
 544 <para>
 545
 546 </para>
 547
 548 @toolbar:
 549
 550