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>#GtkToggleToolButton</term>
  46 <listitem><para>A subclass of #GtkToolButton that displays toggle
  47     buttons on the toolbar</para></listitem>
  48 </varlistentry>
  49
  50 <varlistentry>
  51 <term>#GtkRadioToolButton</term>
  52 <listitem><para>A subclass of #GtkToolButton that displays radio
  53     buttons on the toolbar</para></listitem>
  54 </varlistentry>
  55
  56 <varlistentry>
  57 <term>#GtkSeparatorToolItem</term>
  58 <listitem><para>A subclass of #GtkToolItem that separates groups of
  59     items on a toolbar</para></listitem>
  60 </varlistentry>
  61
  62 </variablelist>
  63 </para>
  64
  65 <!-- ##### STRUCT GtkToolButton ##### -->
  66 <para>
  67 The #GtkToolButton struct contains only private. It should only be
  68 accessed with the function described below.
  69 </para>
  70
  71
  72 <!-- ##### SIGNAL GtkToolButton::clicked ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @toolbutton: the object which received the signal.
  78
  79 <!-- ##### ARG GtkToolButton:icon-widget ##### -->
  80 <para>
  81
  82 </para>
  83
  84 <!-- ##### ARG GtkToolButton:label ##### -->
  85 <para>
  86
  87 </para>
  88
  89 <!-- ##### ARG GtkToolButton:label-widget ##### -->
  90 <para>
  91
  92 </para>
  93
  94 <!-- ##### ARG GtkToolButton:stock-id ##### -->
  95 <para>
  96
  97 </para>
  98
  99 <!-- ##### ARG GtkToolButton:use-underline ##### -->
 100 <para>
 101
 102 </para>
 103
 104 <!-- ##### FUNCTION gtk_tool_button_new ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @icon_widget:
 110 @label:
 111 @Returns:
 112
 113
 114 <!-- ##### FUNCTION gtk_tool_button_new_from_stock ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @stock_id:
 120 @Returns:
 121
 122
 123 <!-- ##### FUNCTION gtk_tool_button_set_label ##### -->
 124 <para>
 125
 126 </para>
 127
 128 @button:
 129 @label:
 130
 131
 132 <!-- ##### FUNCTION gtk_tool_button_get_label ##### -->
 133 <para>
 134
 135 </para>
 136
 137 @button:
 138 @Returns:
 139
 140
 141 <!-- ##### FUNCTION gtk_tool_button_set_use_underline ##### -->
 142 <para>
 143
 144 </para>
 145
 146 @button:
 147 @use_underline:
 148
 149
 150 <!-- ##### FUNCTION gtk_tool_button_get_use_underline ##### -->
 151 <para>
 152
 153 </para>
 154
 155 @button:
 156 @Returns:
 157
 158
 159 <!-- ##### FUNCTION gtk_tool_button_set_stock_id ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @button:
 165 @stock_id:
 166
 167
 168 <!-- ##### FUNCTION gtk_tool_button_get_stock_id ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @button:
 174 @Returns:
 175
 176
 177 <!-- ##### FUNCTION gtk_tool_button_set_icon_widget ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @button:
 183 @icon_widget:
 184
 185
 186 <!-- ##### FUNCTION gtk_tool_button_get_icon_widget ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @button:
 192 @Returns:
 193
 194
 195 <!-- ##### FUNCTION gtk_tool_button_set_label_widget ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @button:
 201 @label_widget:
 202
 203
 204 <!-- ##### FUNCTION gtk_tool_button_get_label_widget ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @button:
 210 @Returns:
 211
 212