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