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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkButton
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget that creates a signal when clicked on.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>\r
   9 The #GtkButton widget is generally used to attach a function to that\r
  10 is called when the button is pressed.  The various signals and how to use\r
  11 them are outlined below.\r
  12 </para>\r
  13 <para>\r
  14 The #GtkButton widget can hold any valid child widget.  That is it can\r
  15 hold most any other standard #GtkWidget.  The most commonly used child is\r
  16 the #GtkLabel.\r
  17 </para>
  18
  19 <!-- ##### SECTION See_Also ##### -->
  20 <para>\r
  21 \r
  22 </para>
  23
  24 <!-- ##### STRUCT GtkButton ##### -->
  25 <para>\r
  26 This should not be accessed directly.  Use the accessor functions below.\r
  27 </para>
  28
  29
  30 <!-- ##### FUNCTION gtk_button_new ##### -->
  31 <para>\r
  32 Creates a new #GtkButton widget.\r
  33 </para>
  34
  35 @Returns: The newly created #GtkButton widget.
  36
  37
  38 <!-- ##### FUNCTION gtk_button_new_with_label ##### -->
  39 <para>\r
  40 Creates a #GtkButton widget with a #GtkLabel child containing the given\r
  41 text.\r
  42 </para>
  43
  44 @label: The text you want the #GtkLabel to hold.
  45 @Returns: The newly created #GtkButton widget.
  46
  47
  48 <!-- ##### FUNCTION gtk_button_new_with_mnemonic ##### -->
  49 <para>
  50
  51 </para>
  52
  53 @label:
  54 @Returns:
  55
  56
  57 <!-- ##### FUNCTION gtk_button_new_from_stock ##### -->
  58 <para>
  59
  60 </para>
  61
  62 @stock_id:
  63 @Returns:
  64
  65
  66 <!-- ##### FUNCTION gtk_button_pressed ##### -->
  67 <para>\r
  68 Emits a #GtkButton::pressed signal to the given #GtkButton.\r
  69 </para>
  70
  71 @button: The #GtkButton you want to send the signal to.
  72
  73
  74 <!-- ##### FUNCTION gtk_button_released ##### -->
  75 <para>\r
  76 Emits a #GtkButton::released signal to the given #GtkButton.\r
  77 </para>
  78
  79 @button: The #GtkButton you want to send the signal to.
  80
  81
  82 <!-- ##### FUNCTION gtk_button_clicked ##### -->
  83 <para>\r
  84 Emits a #GtkButton::clicked signal to the given #GtkButton.\r
  85 </para>
  86
  87 @button: The #GtkButton you want to send the signal to.
  88
  89
  90 <!-- ##### FUNCTION gtk_button_enter ##### -->
  91 <para>\r
  92 Emits a #GtkButton::enter signal to the given #GtkButton.\r
  93 </para>
  94
  95 @button: The #GtkButton you want to send the signal to.
  96
  97
  98 <!-- ##### FUNCTION gtk_button_leave ##### -->
  99 <para>\r
 100 Emits a #GtkButton::leave signal to the given #GtkButton.\r
 101 </para>
 102
 103 @button: The #GtkButton you want to send the signal to.
 104
 105
 106 <!-- ##### FUNCTION gtk_button_set_relief ##### -->
 107 <para>\r
 108 Sets the relief style of the edges of the given #GtkButton widget.\r
 109 Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE.\r
 110 The default style is, as one can guess, GTK_RELIEF_NORMAL.\r
 111 \r
 112 <!-- FIXME: put pictures of each style -->\r
 113 </para>
 114
 115 @button: The #GtkButton you want to set relief styles of.
 116 @newstyle: The GtkReliefStyle as described above.
 117
 118
 119 <!-- ##### FUNCTION gtk_button_get_relief ##### -->
 120 <para>\r
 121 Returns the current relief style of the given #GtkButton.\r
 122 </para>
 123
 124 @button: The #GtkButton you want the #GtkReliefStyle from.
 125 @Returns: The current #GtkReliefStyle
 126
 127
 128 <!-- ##### FUNCTION gtk_button_get_label ##### -->
 129 <para>
 130
 131 </para>
 132
 133 @button:
 134 @Returns:
 135
 136
 137 <!-- ##### FUNCTION gtk_button_set_label ##### -->
 138 <para>
 139
 140 </para>
 141
 142 @button:
 143 @label:
 144
 145
 146 <!-- ##### FUNCTION gtk_button_get_use_stock ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @button:
 152 @Returns:
 153
 154
 155 <!-- ##### FUNCTION gtk_button_set_use_stock ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @button:
 161 @use_stock:
 162 <!-- # Unused Parameters # -->
 163 @value:
 164
 165
 166 <!-- ##### FUNCTION gtk_button_get_use_underline ##### -->
 167 <para>
 168
 169 </para>
 170
 171 @button:
 172 @Returns:
 173
 174
 175 <!-- ##### FUNCTION gtk_button_set_use_underline ##### -->
 176 <para>
 177
 178 </para>
 179
 180 @button:
 181 @use_underline:
 182 <!-- # Unused Parameters # -->
 183 @value:
 184
 185
 186 <!-- ##### SIGNAL GtkButton::activate ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @button: the object which received the signal.
 192
 193 <!-- ##### SIGNAL GtkButton::clicked ##### -->
 194 <para>\r
 195 Emitted when a button clicked on by the mouse and the cursor stays on the\r
 196 button.  If the cursor is not on the button when the mouse button is released,\r
 197 the signal is not emitted.\r
 198 </para>
 199
 200 @button: the object which received the signal.
 201
 202 <!-- ##### SIGNAL GtkButton::enter ##### -->
 203 <para>\r
 204 Emitted when the mouse cursor enters the region of the button.\r
 205 </para>
 206
 207 @button: the object which received the signal.
 208
 209 <!-- ##### SIGNAL GtkButton::leave ##### -->
 210 <para>\r
 211 Emitted when the mouse cursor leaves the region of the button.\r
 212 </para>
 213
 214 @button: the object which received the signal.
 215
 216 <!-- ##### SIGNAL GtkButton::pressed ##### -->
 217 <para>\r
 218 Emitted when the button is initially pressed.\r
 219 </para>
 220
 221 @button: the object which received the signal.
 222
 223 <!-- ##### SIGNAL GtkButton::released ##### -->
 224 <para>\r
 225 Emitted when a button which is pressed is released, no matter where the\r
 226 mouse cursor is.\r
 227 </para>
 228
 229 @button: the object which received the signal.
 230
 231 <!-- ##### ARG GtkButton:label ##### -->
 232 <para>
 233
 234 </para>
 235
 236 <!-- ##### ARG GtkButton:relief ##### -->
 237 <para>
 238
 239 </para>
 240
 241 <!-- ##### ARG GtkButton:use-underline ##### -->
 242 <para>
 243
 244 </para>
 245
 246 <!-- ##### ARG GtkButton:use-stock ##### -->
 247 <para>
 248
 249 </para>
 250
 251 <!-- ##### ARG GtkButton:default-border ##### -->
 252 <para>
 253
 254 </para>
 255
 256 <!-- ##### ARG GtkButton:default-outside-border ##### -->
 257 <para>
 258
 259 </para>
 260
 261 <!-- ##### ARG GtkButton:child-displacement-y ##### -->
 262 <para>
 263
 264 </para>
 265
 266 <!-- ##### ARG GtkButton:child-displacement-x ##### -->
 267 <para>
 268
 269 </para>
 270