Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtktoolbutton.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkToolButton
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A GtkToolItem subclass that displays buttons
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #GtkToolButton<!-- -->s are #GtkToolItems containing buttons.
  10 </para>
  11
  12 <para>
  13 Use gtk_tool_button_new() to create a new #GtkToolButton. Use
  14 gtk_tool_button_new_with_stock() to create a #GtkToolButton
  15 containing a stock item.
  16 </para>
  17
  18 <para>
  19 The label of a #GtkToolButton is determined by the properties
  20 "label-widget", "label", and "stock-id". If "label-widget" is
  21 non-%NULL, then that widget is used as the label. Otherwise, if
  22 "label" is non-%NULL, that string is used as the label. Otherwise, if
  23 "stock-id" is non-%NULL, the label is determined by the stock
  24 item. Otherwise, the button does not have a label.
  25 </para>
  26
  27 <para>
  28 The icon of a #GtkToolButton is determined by the properties
  29 "icon-widget" and "stock-id". If "icon-widget" is non-%NULL, then
  30 that widget is used as the icon. Otherwise, if "stock-id" is
  31 non-%NULL, the icon is determined by the stock item. Otherwise,
  32 the button does not have a icon.
  33 </para>
  34
  35 <!-- ##### SECTION See_Also ##### -->
  36 <para>
  37 <variablelist>
  38
  39 <varlistentry>
  40 <term>#GtkToolbar</term>
  41 <listitem><para>The toolbar widget</para></listitem>
  42 </varlistentry>
  43
  44 <varlistentry>
  45 <term>#GtkMenuToolButton</term>
  46 <listitem><para>A subclass of #GtkToolButton that displays on
  47     the toolbar a button with an additional dropdown
  48     menu</para></listitem>
  49 </varlistentry>
  50
  51 <varlistentry>
  52 <term>#GtkToggleToolButton</term>
  53 <listitem><para>A subclass of #GtkToolButton that displays toggle
  54     buttons on the toolbar</para></listitem>
  55 </varlistentry>
  56
  57 <varlistentry>
  58 <term>#GtkRadioToolButton</term>
  59 <listitem><para>A subclass of #GtkToolButton that displays radio
  60     buttons on the toolbar</para></listitem>
  61 </varlistentry>
  62
  63 <varlistentry>
  64 <term>#GtkSeparatorToolItem</term>
  65 <listitem><para>A subclass of #GtkToolItem that separates groups of
  66     items on a toolbar</para></listitem>
  67 </varlistentry>
  68
  69 </variablelist>
  70 </para>
  71
  72 <!-- ##### SECTION Stability_Level ##### -->
  73
  74
  75 <!-- ##### STRUCT GtkToolButton ##### -->
  76 <para>
  77 The #GtkToolButton struct contains only private. It should only be
  78 accessed with the function described below.
  79 </para>
  80
  81
  82 <!-- ##### SIGNAL GtkToolButton::clicked ##### -->
  83 <para>
  84
  85 </para>
  86
  87 @toolbutton: the object which received the signal.
  88
  89 <!-- ##### ARG GtkToolButton:icon-name ##### -->
  90 <para>
  91
  92 </para>
  93
  94 <!-- ##### ARG GtkToolButton:icon-widget ##### -->
  95 <para>
  96
  97 </para>
  98
  99 <!-- ##### ARG GtkToolButton:label ##### -->
 100 <para>
 101
 102 </para>
 103
 104 <!-- ##### ARG GtkToolButton:label-widget ##### -->
 105 <para>
 106
 107 </para>
 108
 109 <!-- ##### ARG GtkToolButton:stock-id ##### -->
 110 <para>
 111
 112 </para>
 113
 114 <!-- ##### ARG GtkToolButton:use-underline ##### -->
 115 <para>
 116
 117 </para>
 118
 119 <!-- ##### ARG GtkToolButton:icon-spacing ##### -->
 120 <para>
 121
 122 </para>
 123
 124 <!-- ##### FUNCTION gtk_tool_button_new ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @icon_widget:
 130 @label:
 131 @Returns:
 132
 133
 134 <!-- ##### FUNCTION gtk_tool_button_new_from_stock ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @stock_id:
 140 @Returns:
 141
 142
 143 <!-- ##### FUNCTION gtk_tool_button_set_label ##### -->
 144 <para>
 145
 146 </para>
 147
 148 @button:
 149 @label:
 150
 151
 152 <!-- ##### FUNCTION gtk_tool_button_get_label ##### -->
 153 <para>
 154
 155 </para>
 156
 157 @button:
 158 @Returns:
 159
 160
 161 <!-- ##### FUNCTION gtk_tool_button_set_use_underline ##### -->
 162 <para>
 163
 164 </para>
 165
 166 @button:
 167 @use_underline:
 168
 169
 170 <!-- ##### FUNCTION gtk_tool_button_get_use_underline ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @button:
 176 @Returns:
 177
 178
 179 <!-- ##### FUNCTION gtk_tool_button_set_stock_id ##### -->
 180 <para>
 181
 182 </para>
 183
 184 @button:
 185 @stock_id:
 186
 187
 188 <!-- ##### FUNCTION gtk_tool_button_get_stock_id ##### -->
 189 <para>
 190
 191 </para>
 192
 193 @button:
 194 @Returns:
 195
 196
 197 <!-- ##### FUNCTION gtk_tool_button_set_icon_name ##### -->
 198 <para>
 199
 200 </para>
 201
 202 @button:
 203 @icon_name:
 204
 205
 206 <!-- ##### FUNCTION gtk_tool_button_get_icon_name ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @button:
 212 @Returns:
 213
 214
 215 <!-- ##### FUNCTION gtk_tool_button_set_icon_widget ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @button:
 221 @icon_widget:
 222
 223
 224 <!-- ##### FUNCTION gtk_tool_button_get_icon_widget ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @button:
 230 @Returns:
 231
 232
 233 <!-- ##### FUNCTION gtk_tool_button_set_label_widget ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @button:
 239 @label_widget:
 240
 241
 242 <!-- ##### FUNCTION gtk_tool_button_get_label_widget ##### -->
 243 <para>
 244
 245 </para>
 246
 247 @button:
 248 @Returns:
 249
 250