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