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