struct GtkButton

struct GtkButton;

This should not be accessed directly. Use the accessor functions below.

gtk_button_new ()

GtkWidget *         gtk_button_new                      (void);

Creates a new GtkButton widget. To add a child widget to the button, use gtk_container_add().

gtk_button_new_with_label ()

GtkWidget *         gtk_button_new_with_label           (const gchar *label);

Creates a GtkButton widget with a GtkLabel child containing the given text.

gtk_button_new_with_mnemonic ()

GtkWidget *         gtk_button_new_with_mnemonic        (const gchar *label);

Creates a new GtkButton containing a label. If characters in label are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use '__' (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. Pressing Alt and that key activates the button.

gtk_button_new_from_stock ()

GtkWidget *         gtk_button_new_from_stock           (const gchar *stock_id);

Creates a new GtkButton containing the image and text from a stock item. Some stock ids have preprocessor macros like GTK_STOCK_OK and GTK_STOCK_APPLY.

If stock_id is unknown, then it will be treated as a mnemonic label (as for gtk_button_new_with_mnemonic()).

gtk_button_pressed ()

void                gtk_button_pressed                  (GtkButton *button);

Emits a "pressed" signal to the given GtkButton.

gtk_button_released ()

void                gtk_button_released                 (GtkButton *button);

Emits a "released" signal to the given GtkButton.

gtk_button_clicked ()

void                gtk_button_clicked                  (GtkButton *button);

Emits a "clicked" signal to the given GtkButton.

gtk_button_enter ()

void                gtk_button_enter                    (GtkButton *button);

Emits a "enter" signal to the given GtkButton.

gtk_button_leave ()

void                gtk_button_leave                    (GtkButton *button);

Emits a "leave" signal to the given GtkButton.

gtk_button_set_relief ()

void                gtk_button_set_relief               (GtkButton *button,
                                                         GtkReliefStyle newstyle);

Sets the relief style of the edges of the given GtkButton widget. Three styles exist, GTK_RELIEF_NORMAL, GTK_RELIEF_HALF, GTK_RELIEF_NONE. The default style is, as one can guess, GTK_RELIEF_NORMAL.

gtk_button_get_relief ()

GtkReliefStyle      gtk_button_get_relief               (GtkButton *button);

Returns the current relief style of the given GtkButton.

gtk_button_get_label ()

const gchar *       gtk_button_get_label                (GtkButton *button);

Fetches the text from the label of the button, as set by gtk_button_set_label(). If the label text has not been set the return value will be NULL. This will be the case if you create an empty button with gtk_button_new() to use as a container.

gtk_button_set_label ()

void                gtk_button_set_label                (GtkButton *button,
                                                         const gchar *label);

Sets the text of the label of the button to str. This text is also used to select the stock item if gtk_button_set_use_stock() is used.

This will also clear any previously set labels.

gtk_button_get_use_stock ()

gboolean            gtk_button_get_use_stock            (GtkButton *button);

Returns whether the button label is a stock item.

gtk_button_set_use_stock ()

void                gtk_button_set_use_stock            (GtkButton *button,
                                                         gboolean use_stock);

If TRUE, the label set on the button is used as a stock id to select the stock item for the button.

gtk_button_get_use_underline ()

gboolean            gtk_button_get_use_underline        (GtkButton *button);

Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline().

gtk_button_set_use_underline ()

void                gtk_button_set_use_underline        (GtkButton *button,
                                                         gboolean use_underline);

If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.

gtk_button_set_focus_on_click ()

void                gtk_button_set_focus_on_click       (GtkButton *button,
                                                         gboolean focus_on_click);

Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don't want the keyboard focus removed from the main area of the application.

Since 2.4

gtk_button_get_focus_on_click ()

gboolean            gtk_button_get_focus_on_click       (GtkButton *button);

Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click().

Since 2.4

gtk_button_set_alignment ()

void                gtk_button_set_alignment            (GtkButton *button,
                                                         gfloat xalign,
                                                         gfloat yalign);

Sets the alignment of the child. This property has no effect unless the child is a GtkMisc or a GtkAligment.

Since 2.4

gtk_button_get_alignment ()

void                gtk_button_get_alignment            (GtkButton *button,
                                                         gfloat *xalign,
                                                         gfloat *yalign);

Gets the alignment of the child in the button.

Since 2.4

gtk_button_set_image ()

void                gtk_button_set_image                (GtkButton *button,
                                                         GtkWidget *image);

Set the image of button to the given widget. Note that it depends on the "gtk-button-images" setting whether the image will be displayed or not, you don't have to call gtk_widget_show() on image yourself.

Since 2.6

gtk_button_get_image ()

GtkWidget *         gtk_button_get_image                (GtkButton *button);

Gets the widget that is currenty set as the image of button. This may have been explicitly set by gtk_button_set_image() or constructed by gtk_button_new_from_stock().

Since 2.6

gtk_button_set_image_position ()

void                gtk_button_set_image_position       (GtkButton *button,
                                                         GtkPositionType position);

Sets the position of the image relative to the text inside the button.

Since 2.10

gtk_button_get_image_position ()

GtkPositionType     gtk_button_get_image_position       (GtkButton *button);

Gets the position of the image relative to the text inside the button.

Since 2.10

gtk_button_get_event_window ()

GdkWindow *         gtk_button_get_event_window         (GtkButton *button);

Returns the button's event window if it is realized, NULL otherwise. This function should be rarely needed.

Since 2.22

The "focus-on-click" property

  "focus-on-click"           gboolean              : Read / Write

Whether the button grabs focus when it is clicked with the mouse.

Default value: TRUE

The "image" property

  "image"                    GtkWidget*            : Read / Write

Child widget to appear next to the button text.

The "image-position" property

  "image-position"           GtkPositionType       : Read / Write

The position of the image relative to the text inside the button.

Default value: GTK_POS_LEFT

Since 2.10

The "label" property

  "label"                    gchar*                : Read / Write / Construct

Text of the label widget inside the button, if the button contains a label widget.

Default value: NULL

The "relief" property

  "relief"                   GtkReliefStyle        : Read / Write

The border relief style.

Default value: GTK_RELIEF_NORMAL

The "use-stock" property

  "use-stock"                gboolean              : Read / Write / Construct

If set, the label is used to pick a stock item instead of being displayed.

Default value: FALSE

The "use-underline" property

  "use-underline"            gboolean              : Read / Write / Construct

If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.

Default value: FALSE

The "xalign" property

  "xalign"                   gfloat                : Read / Write

If the child of the button is a GtkMisc or GtkAlignment, this property can be used to control it's horizontal alignment. 0.0 is left aligned, 1.0 is right aligned.

Allowed values: [0,1]

Default value: 0.5

Since 2.4

The "yalign" property

  "yalign"                   gfloat                : Read / Write

If the child of the button is a GtkMisc or GtkAlignment, this property can be used to control it's vertical alignment. 0.0 is top aligned, 1.0 is bottom aligned.

Allowed values: [0,1]

Default value: 0.5

Since 2.4

The "child-displacement-x" style property

  "child-displacement-x"     gint                  : Read

How far in the x direction to move the child when the button is depressed.

Default value: 0

The "child-displacement-y" style property

  "child-displacement-y"     gint                  : Read

How far in the y direction to move the child when the button is depressed.

Default value: 0

The "default-border" style property

  "default-border"           GtkBorder*            : Read

The "default-border" style property defines the extra space to add around a button that can become the default widget of its window. For more information about default widgets, see gtk_widget_grab_default().

The "default-outside-border" style property

  "default-outside-border"   GtkBorder*            : Read

The "default-outside-border" style property defines the extra outside space to add around a button that can become the default widget of its window. Extra outside space is always drawn outside the button border. For more information about default widgets, see gtk_widget_grab_default().

The "displace-focus" style property

  "displace-focus"           gboolean              : Read

Whether the child_displacement_x/child_displacement_y properties should also affect the focus rectangle.

Default value: FALSE

Since 2.6

The "image-spacing" style property

  "image-spacing"            gint                  : Read

Spacing in pixels between the image and label.

Allowed values: >= 0

Default value: 2

The "inner-border" style property

  "inner-border"             GtkBorder*            : Read

Sets the border between the button edges and child.

Since 2.10

The "activate" signal

void                user_function                      (GtkButton *widget,
                                                        gpointer   user_data)      : Action

The ::activate signal on GtkButton is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the "clicked" signal.

The "clicked" signal

void                user_function                      (GtkButton *button,
                                                        gpointer   user_data)      : Action

Emitted when the button has been activated (pressed and released).

The "enter" signal

void                user_function                      (GtkButton *button,
                                                        gpointer   user_data)      : Run First

Emitted when the pointer enters the button.

The "leave" signal

void                user_function                      (GtkButton *button,
                                                        gpointer   user_data)      : Run First

Emitted when the pointer leaves the button.

The "pressed" signal

void                user_function                      (GtkButton *button,
                                                        gpointer   user_data)      : Run First

Emitted when the button is pressed.

The "released" signal

void                user_function                      (GtkButton *button,
                                                        gpointer   user_data)      : Run First

Emitted when the button is released.