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 <!-- ##### SECTION Image ##### -->
  45
  46
  47 <!-- ##### STRUCT GtkToolbar ##### -->
  48 <para>
  49 The #GtkToolbar struct only contains private data and should only be
  50 accessed through the function described below.
  51 </para>
  52
  53
  54 <!-- ##### SIGNAL GtkToolbar::focus-home-or-end ##### -->
  55 <para>
  56
  57 </para>
  58
  59 @toolbar: the object which received the signal.
  60 @arg1:
  61 @Returns:
  62
  63 <!-- ##### SIGNAL GtkToolbar::orientation-changed ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @toolbar: the object which received the signal.
  69 @orientation: the new #GtkOrientation of the toolbar.
  70
  71 <!-- ##### SIGNAL GtkToolbar::popup-context-menu ##### -->
  72 <para>
  73
  74 </para>
  75
  76 @toolbar: the object which received the signal.
  77 @Returns:
  78 @Returns:
  79 @Returns:
  80 @Returns:
  81
  82 <!-- ##### SIGNAL GtkToolbar::style-changed ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @toolbar:
  88 @style:
  89
  90 <!-- ##### ARG GtkToolbar:icon-size ##### -->
  91 <para>
  92
  93 </para>
  94
  95 <!-- ##### ARG GtkToolbar:icon-size-set ##### -->
  96 <para>
  97
  98 </para>
  99
 100 <!-- ##### ARG GtkToolbar:show-arrow ##### -->
 101 <para>
 102
 103 </para>
 104
 105 <!-- ##### ARG GtkToolbar:toolbar-style ##### -->
 106 <para>
 107
 108 </para>
 109
 110 <!-- ##### ARG GtkToolbar:expand ##### -->
 111 <para>
 112
 113 </para>
 114
 115 <!-- ##### ARG GtkToolbar:homogeneous ##### -->
 116 <para>
 117
 118 </para>
 119
 120 <!-- ##### ARG GtkToolbar:button-relief ##### -->
 121 <para>
 122
 123 </para>
 124
 125 <!-- ##### ARG GtkToolbar:internal-padding ##### -->
 126 <para>
 127
 128 </para>
 129
 130 <!-- ##### ARG GtkToolbar:max-child-expand ##### -->
 131 <para>
 132
 133 </para>
 134
 135 <!-- ##### ARG GtkToolbar:shadow-type ##### -->
 136 <para>
 137
 138 </para>
 139
 140 <!-- ##### ARG GtkToolbar:space-size ##### -->
 141 <para>
 142
 143 </para>
 144
 145 <!-- ##### ARG GtkToolbar:space-style ##### -->
 146 <para>
 147
 148 </para>
 149
 150 <!-- ##### ENUM GtkToolbarChildType ##### -->
 151 <para>
 152 #GtkToolbarChildType is used to set the type of new elements that are added
 153 to a #GtkToolbar.
 154 </para>
 155
 156 @GTK_TOOLBAR_CHILD_SPACE: a space in the style of the toolbar's #GtkToolbarSpaceStyle.
 157 @GTK_TOOLBAR_CHILD_BUTTON: a #GtkButton.
 158 @GTK_TOOLBAR_CHILD_TOGGLEBUTTON: a #GtkToggleButton.
 159 @GTK_TOOLBAR_CHILD_RADIOBUTTON: a #GtkRadioButton.
 160 @GTK_TOOLBAR_CHILD_WIDGET: a standard #GtkWidget.
 161
 162 <!-- ##### ENUM GtkToolbarSpaceStyle ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @GTK_TOOLBAR_SPACE_EMPTY:
 168 @GTK_TOOLBAR_SPACE_LINE:
 169
 170 <!-- ##### STRUCT GtkToolbarChild ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @type:
 176 @widget:
 177 @icon:
 178 @label:
 179
 180 <!-- ##### FUNCTION gtk_toolbar_new ##### -->
 181 <para>
 182
 183 </para>
 184
 185 @void:
 186 @Returns: the newly-created toolbar.
 187
 188
 189 <!-- ##### FUNCTION gtk_toolbar_insert ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @toolbar:
 195 @item:
 196 @pos:
 197
 198
 199 <!-- ##### FUNCTION gtk_toolbar_get_item_index ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @toolbar:
 205 @item:
 206 @Returns:
 207
 208
 209 <!-- ##### FUNCTION gtk_toolbar_get_n_items ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @toolbar:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION gtk_toolbar_get_nth_item ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @toolbar:
 224 @n:
 225 @Returns:
 226
 227
 228 <!-- ##### FUNCTION gtk_toolbar_get_drop_index ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @toolbar:
 234 @x:
 235 @y:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION gtk_toolbar_set_drop_highlight_item ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @toolbar:
 245 @tool_item:
 246 @index_:
 247
 248
 249 <!-- ##### FUNCTION gtk_toolbar_set_show_arrow ##### -->
 250 <para>
 251
 252 </para>
 253
 254 @toolbar:
 255 @show_arrow:
 256
 257
 258 <!-- ##### FUNCTION gtk_toolbar_unset_icon_size ##### -->
 259 <para>
 260
 261 </para>
 262
 263 @toolbar:
 264
 265
 266 <!-- ##### FUNCTION gtk_toolbar_get_show_arrow ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @toolbar:
 272 @Returns:
 273
 274
 275 <!-- ##### FUNCTION gtk_toolbar_get_style ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @toolbar:
 281 @Returns:
 282
 283
 284 <!-- ##### FUNCTION gtk_toolbar_get_icon_size ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @toolbar:
 290 @Returns:
 291
 292
 293 <!-- ##### FUNCTION gtk_toolbar_get_relief_style ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @toolbar:
 299 @Returns:
 300
 301
 302 <!-- ##### FUNCTION gtk_toolbar_set_style ##### -->
 303 <para>
 304
 305 </para>
 306
 307 @toolbar:
 308 @style:
 309
 310
 311 <!-- ##### FUNCTION gtk_toolbar_set_icon_size ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @toolbar:
 317 @icon_size:
 318
 319
 320 <!-- ##### FUNCTION gtk_toolbar_unset_style ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @toolbar:
 326
 327