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 <!-- ##### SECTION Image ##### -->
  76
  77
  78 <!-- ##### STRUCT GtkToolButton ##### -->
  79 <para>
  80 The #GtkToolButton struct contains only private. It should only be
  81 accessed with the function described below.
  82 </para>
  83
  84
  85 <!-- ##### SIGNAL GtkToolButton::clicked ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @toolbutton: the object which received the signal.
  91
  92 <!-- ##### ARG GtkToolButton:icon-name ##### -->
  93 <para>
  94
  95 </para>
  96
  97 <!-- ##### ARG GtkToolButton:icon-widget ##### -->
  98 <para>
  99
 100 </para>
 101
 102 <!-- ##### ARG GtkToolButton:label ##### -->
 103 <para>
 104
 105 </para>
 106
 107 <!-- ##### ARG GtkToolButton:label-widget ##### -->
 108 <para>
 109
 110 </para>
 111
 112 <!-- ##### ARG GtkToolButton:stock-id ##### -->
 113 <para>
 114
 115 </para>
 116
 117 <!-- ##### ARG GtkToolButton:use-underline ##### -->
 118 <para>
 119
 120 </para>
 121
 122 <!-- ##### ARG GtkToolButton:icon-spacing ##### -->
 123 <para>
 124
 125 </para>
 126
 127 <!-- ##### FUNCTION gtk_tool_button_new ##### -->
 128 <para>
 129
 130 </para>
 131
 132 @icon_widget:
 133 @label:
 134 @Returns:
 135
 136
 137 <!-- ##### FUNCTION gtk_tool_button_new_from_stock ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @stock_id:
 143 @Returns:
 144
 145
 146 <!-- ##### FUNCTION gtk_tool_button_set_label ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @button:
 152 @label:
 153
 154
 155 <!-- ##### FUNCTION gtk_tool_button_get_label ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @button:
 161 @Returns:
 162
 163
 164 <!-- ##### FUNCTION gtk_tool_button_set_use_underline ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @button:
 170 @use_underline:
 171
 172
 173 <!-- ##### FUNCTION gtk_tool_button_get_use_underline ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @button:
 179 @Returns:
 180
 181
 182 <!-- ##### FUNCTION gtk_tool_button_set_stock_id ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @button:
 188 @stock_id:
 189
 190
 191 <!-- ##### FUNCTION gtk_tool_button_get_stock_id ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @button:
 197 @Returns:
 198
 199
 200 <!-- ##### FUNCTION gtk_tool_button_set_icon_name ##### -->
 201 <para>
 202
 203 </para>
 204
 205 @button:
 206 @icon_name:
 207
 208
 209 <!-- ##### FUNCTION gtk_tool_button_get_icon_name ##### -->
 210 <para>
 211
 212 </para>
 213
 214 @button:
 215 @Returns:
 216
 217
 218 <!-- ##### FUNCTION gtk_tool_button_set_icon_widget ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @button:
 224 @icon_widget:
 225
 226
 227 <!-- ##### FUNCTION gtk_tool_button_get_icon_widget ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @button:
 233 @Returns:
 234
 235
 236 <!-- ##### FUNCTION gtk_tool_button_set_label_widget ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @button:
 242 @label_widget:
 243
 244
 245 <!-- ##### FUNCTION gtk_tool_button_get_label_widget ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @button:
 251 @Returns:
 252
 253