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