Button

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_button_get_type ()" ) ]
public class Button : Widget, Accessible, Actionable, Buildable, ConstraintTarget

The `GtkButton` widget is generally used to trigger a callback function that is called when the button is pressed.

![An example GtkButton](button.png)

The `GtkButton` widget can hold any valid child widget. That is, it can hold almost any other standard `GtkWidget`. The most commonly used child is the `GtkLabel`.

CSS nodes

`GtkButton` has a single CSS node with name button. The node will get the style classes .image-button or .text-button, if the content is just an image or label, respectively. It may also receive the .flat style class. When activating a button via the keyboard, the button will temporarily gain the .keyboard-activating style class.

Other style classes that are commonly used with `GtkButton` include .suggested-action and .destructive-action. In special cases, buttons can be made round by adding the .circular style class.

Button-like widgets like [class@Gtk.ToggleButton], [class@Gtk.MenuButton], [class@Gtk.VolumeButton], [class@Gtk.LockButton], [ class@Gtk.ColorButton] or [class@Gtk.FontButton] use style classes such as .toggle, .popup, .scale, .lock, .color on the button node to differentiate themselves from a plain `GtkButton`.

Accessibility

`GtkButton` uses the gtk_accessible_role_button role.

All known sub-classes:

LinkButton

LockButton

ToggleButton

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool can_shrink { get; set; }
Whether the size of the button can be made smaller than the natural size of its contents.
public Widget child { get; set; }
The child widget.
public bool has_frame { get; set; }
Whether the button has a frame.
public string icon_name { get; set; }
The name of the icon used to automatically populate the button.
public string? label { get; set; }
Text of the label inside the button, if the button contains a label widget.
public bool use_underline { get; set; }
If set, an underline in the text indicates that the following character is to be used as mnemonic.

Creation methods:

public Button ()
Creates a new `GtkButton` widget.
public Button.from_icon_name (string icon_name)
Creates a new button containing an icon from the current icon theme.
public Button.with_label (string label)
Creates a `GtkButton` widget with a `GtkLabel` child.
public Button.with_mnemonic (string label)
Creates a new `GtkButton` containing a label.

Methods:

public bool get_can_shrink ()
Retrieves whether the button can be smaller than the natural size of its contents.
public unowned Widget? get_child ()
Gets the child widget of this.
public bool get_has_frame ()
Returns whether the button has a frame.
public unowned string? get_icon_name ()
Returns the icon name of the button.
public unowned string? get_label ()
Fetches the text from the label of the button.
public bool get_use_underline ()
gets whether underlines are interpreted as mnemonics.
public void set_can_shrink (bool can_shrink)
Sets whether the button size can be smaller than the natural size of its contents.
public void set_child (Widget? child)
Sets the child widget of this.
public void set_has_frame (bool has_frame)
Sets the style of the button.
public void set_icon_name (string icon_name)
Adds a `GtkImage` with the given icon name as a child.
public void set_label (string? label)
Sets the text of the label of the button to label.
public void set_use_underline (bool use_underline)
Sets whether to use underlines as mnemonics.

Signals:

public virtual signal void activate ()
Emitted to animate press then release.
public virtual signal void clicked ()
Emitted when the button has been activated (pressed and released).

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Actionable

All known members inherited from interface Gtk.Buildable