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 <!-- ##### SECTION Stability_Level ##### -->
  42
  43
  44 <!-- ##### STRUCT GtkToolbar ##### -->
  45 <para>
  46 The #GtkToolbar struct only contains private data and should only be
  47 accessed through the function described below.
  48 </para>
  49
  50
  51 <!-- ##### SIGNAL GtkToolbar::focus-home-or-end ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @toolbar: the object which received the signal.
  57 @arg1:
  58 @Returns:
  59
  60 <!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @toolbar: the object which received the signal.
  66 @orientation: the new #GtkOrientation of the toolbar.
  67
  68 <!-- ##### SIGNAL GtkToolbar::popup-context-menu ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @toolbar: the object which received the signal.
  74 @Returns:
  75 @Returns:
  76 @Returns:
  77 @Returns:
  78
  79 <!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @toolbar:
  85 @style:
  86
  87 <!-- ##### ARG GtkToolbar:icon-size ##### -->
  88 <para>
  89
  90 </para>
  91
  92 <!-- ##### ARG GtkToolbar:icon-size-set ##### -->
  93 <para>
  94
  95 </para>
  96
  97 <!-- ##### ARG GtkToolbar:show-arrow ##### -->
  98 <para>
  99
 100 </para>
 101
 102 <!-- ##### ARG GtkToolbar:toolbar-style ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG GtkToolbar:tooltips ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG GtkToolbar:expand ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### ARG GtkToolbar:homogeneous ##### -->
 118 <para>
 119
 120 </para>
 121
 122 <!-- ##### ARG GtkToolbar:button-relief ##### -->
 123 <para>
 124
 125 </para>
 126
 127 <!-- ##### ARG GtkToolbar:internal-padding ##### -->
 128 <para>
 129
 130 </para>
 131
 132 <!-- ##### ARG GtkToolbar:max-child-expand ##### -->
 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
 249
 250 <!-- ##### FUNCTION gtk_toolbar_set_show_arrow ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @toolbar:
 256 @show_arrow:
 257
 258
 259 <!-- ##### FUNCTION gtk_toolbar_set_orientation ##### -->
 260 <para>
 261
 262 </para>
 263
 264 @toolbar:
 265 @orientation:
 266
 267
 268 <!-- ##### FUNCTION gtk_toolbar_set_tooltips ##### -->
 269 <para>
 270
 271 </para>
 272
 273 @toolbar:
 274 @enable:
 275
 276
 277 <!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @toolbar:
 283
 284
 285 <!-- ##### FUNCTION gtk_toolbar_get_show_arrow ##### -->
 286 <para>
 287
 288 </para>
 289
 290 @toolbar:
 291 @Returns:
 292
 293
 294 <!-- ##### FUNCTION gtk_toolbar_get_orientation ##### -->
 295 <para>
 296
 297 </para>
 298
 299 @toolbar:
 300 @Returns:
 301
 302
 303 <!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @toolbar:
 309 @Returns:
 310
 311
 312 <!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @toolbar:
 318 @Returns:
 319
 320
 321 <!-- ##### FUNCTION gtk_toolbar_get_tooltips ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @toolbar:
 327 @Returns:
 328
 329
 330 <!-- ##### FUNCTION gtk_toolbar_get_relief_style ##### -->
 331 <para>
 332
 333 </para>
 334
 335 @toolbar:
 336 @Returns:
 337
 338
 339 <!-- ##### FUNCTION gtk_toolbar_append_item ##### -->
 340 <para>
 341
 342 </para>
 343
 344 @toolbar:
 345 @text:
 346 @tooltip_text:
 347 @tooltip_private_text:
 348 @icon:
 349 @callback:
 350 @user_data:
 351 @Returns:
 352
 353
 354 <!-- ##### FUNCTION gtk_toolbar_prepend_item ##### -->
 355 <para>
 356
 357 </para>
 358
 359 @toolbar:
 360 @text:
 361 @tooltip_text:
 362 @tooltip_private_text:
 363 @icon:
 364 @callback:
 365 @user_data:
 366 @Returns:
 367
 368
 369 <!-- ##### FUNCTION gtk_toolbar_insert_item ##### -->
 370 <para>
 371
 372 </para>
 373
 374 @toolbar:
 375 @text:
 376 @tooltip_text:
 377 @tooltip_private_text:
 378 @icon:
 379 @callback:
 380 @user_data:
 381 @position:
 382 @Returns:
 383
 384
 385 <!-- ##### FUNCTION gtk_toolbar_append_space ##### -->
 386 <para>
 387
 388 </para>
 389
 390 @toolbar:
 391
 392
 393 <!-- ##### FUNCTION gtk_toolbar_prepend_space ##### -->
 394 <para>
 395
 396 </para>
 397
 398 @toolbar:
 399
 400
 401 <!-- ##### FUNCTION gtk_toolbar_insert_space ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @toolbar:
 407 @position:
 408
 409
 410 <!-- ##### FUNCTION gtk_toolbar_append_element ##### -->
 411 <para>
 412
 413 </para>
 414 <para>
 415
 416 </para>
 417
 418 @toolbar:
 419 @type:
 420 @widget:
 421 @text:
 422 @tooltip_text:
 423 @tooltip_private_text:
 424 @icon:
 425 @callback:
 426 @user_data:
 427 @Returns:
 428
 429
 430 <!-- ##### FUNCTION gtk_toolbar_prepend_element ##### -->
 431 <para>
 432
 433 </para>
 434
 435 @toolbar:
 436 @type:
 437 @widget:
 438 @text:
 439 @tooltip_text:
 440 @tooltip_private_text:
 441 @icon:
 442 @callback:
 443 @user_data:
 444 @Returns:
 445
 446
 447 <!-- ##### FUNCTION gtk_toolbar_insert_element ##### -->
 448 <para>
 449
 450 </para>
 451
 452 @toolbar:
 453 @type:
 454 @widget:
 455 @text:
 456 @tooltip_text:
 457 @tooltip_private_text:
 458 @icon:
 459 @callback:
 460 @user_data:
 461 @position:
 462 @Returns:
 463
 464
 465 <!-- ##### FUNCTION gtk_toolbar_append_widget ##### -->
 466 <para>
 467
 468 </para>
 469
 470 @toolbar:
 471 @widget:
 472 @tooltip_text:
 473 @tooltip_private_text:
 474
 475
 476 <!-- ##### FUNCTION gtk_toolbar_prepend_widget ##### -->
 477 <para>
 478
 479 </para>
 480
 481 @toolbar:
 482 @widget:
 483 @tooltip_text:
 484 @tooltip_private_text:
 485
 486
 487 <!-- ##### FUNCTION gtk_toolbar_insert_widget ##### -->
 488 <para>
 489
 490 </para>
 491
 492 @toolbar:
 493 @widget:
 494 @tooltip_text:
 495 @tooltip_private_text:
 496 @position:
 497
 498
 499 <!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
 500 <para>
 501
 502 </para>
 503
 504 @toolbar:
 505 @style:
 506
 507
 508 <!-- ##### FUNCTION gtk_toolbar_insert_stock ##### -->
 509 <para>
 510
 511 </para>
 512
 513 @toolbar:
 514 @stock_id:
 515 @tooltip_text:
 516 @tooltip_private_text:
 517 @callback:
 518 @user_data:
 519 @position:
 520 @Returns:
 521
 522
 523 <!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
 524 <para>
 525
 526 </para>
 527
 528 @toolbar:
 529 @icon_size:
 530
 531
 532 <!-- ##### FUNCTION gtk_toolbar_remove_space ##### -->
 533 <para>
 534
 535 </para>
 536
 537 @toolbar:
 538 @position:
 539
 540
 541 <!-- ##### FUNCTION gtk_toolbar_unset_style ##### -->
 542 <para>
 543
 544 </para>
 545
 546 @toolbar:
 547
 548