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