CSS nodes

CtkButton 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.

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

Button-like widgets like CtkToggleButton, CtkMenuButton, CtkVolumeButton, CtkLockButton, CtkColorButton, CtkFontButton or CtkFileChooserButton use style classes such as .toggle, .popup, .scale, .lock, .color, .font, .file to differentiate themselves from a plain CtkButton.

ctk_button_new ()

CtkWidget *
ctk_button_new (void);

Creates a new CtkButton widget. To add a child widget to the button, use ctk_container_add().

ctk_button_new_with_label ()

CtkWidget *
ctk_button_new_with_label (const gchar *label);

Creates a CtkButton widget with a CtkLabel child containing the given text.

ctk_button_new_with_mnemonic ()

CtkWidget *
ctk_button_new_with_mnemonic (const gchar *label);

Creates a new CtkButton 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.

ctk_button_new_from_icon_name ()

CtkWidget *
ctk_button_new_from_icon_name (const gchar *icon_name,
                               CtkIconSize size);

Creates a new button containing an icon from the current icon theme.

If the icon name isn’t known, a “broken image” icon will be displayed instead. If the current icon theme is changed, the icon will be updated appropriately.

This function is a convenience wrapper around ctk_button_new() and ctk_button_set_image().

Since: 3.10

ctk_button_new_from_stock ()

CtkWidget *
ctk_button_new_from_stock (const gchar *stock_id);

Creates a new CtkButton containing the image and text from a stock item. Some stock ids have preprocessor macros like CTK_STOCK_OK and CTK_STOCK_APPLY.

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

ctk_button_pressed ()

void
ctk_button_pressed (CtkButton *button);

Emits a “pressed” signal to the given CtkButton.

ctk_button_released ()

void
ctk_button_released (CtkButton *button);

Emits a “released” signal to the given CtkButton.

ctk_button_clicked ()

void
ctk_button_clicked (CtkButton *button);

Emits a “clicked” signal to the given CtkButton.

ctk_button_enter ()

void
ctk_button_enter (CtkButton *button);

Emits a “enter” signal to the given CtkButton.

ctk_button_leave ()

void
ctk_button_leave (CtkButton *button);

Emits a “leave” signal to the given CtkButton.

ctk_button_set_relief ()

void
ctk_button_set_relief (CtkButton *button,
                       CtkReliefStyle relief);

Sets the relief style of the edges of the given CtkButton widget. Two styles exist, CTK_RELIEF_NORMAL and CTK_RELIEF_NONE. The default style is, as one can guess, CTK_RELIEF_NORMAL. The deprecated value CTK_RELIEF_HALF behaves the same as CTK_RELIEF_NORMAL.

ctk_button_get_relief ()

CtkReliefStyle
ctk_button_get_relief (CtkButton *button);

Returns the current relief style of the given CtkButton.

ctk_button_get_label ()

const gchar *
ctk_button_get_label (CtkButton *button);

Fetches the text from the label of the button, as set by ctk_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 ctk_button_new() to use as a container.

ctk_button_set_label ()

void
ctk_button_set_label (CtkButton *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 ctk_button_set_use_stock() is used.

This will also clear any previously set labels.

ctk_button_get_use_stock ()

gboolean
ctk_button_get_use_stock (CtkButton *button);

Returns whether the button label is a stock item.

ctk_button_set_use_stock ()

void
ctk_button_set_use_stock (CtkButton *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.

ctk_button_get_use_underline ()

gboolean
ctk_button_get_use_underline (CtkButton *button);

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

ctk_button_set_use_underline ()

void
ctk_button_set_use_underline (CtkButton *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.

ctk_button_set_focus_on_click ()

void
ctk_button_set_focus_on_click (CtkButton *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

ctk_button_get_focus_on_click ()

gboolean
ctk_button_get_focus_on_click (CtkButton *button);

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

Since: 2.4

ctk_button_set_alignment ()

void
ctk_button_set_alignment (CtkButton *button,
                          gfloat xalign,
                          gfloat yalign);

Sets the alignment of the child. This property has no effect unless the child is a CtkMisc or a CtkAlignment.

Since: 2.4

ctk_button_get_alignment ()

void
ctk_button_get_alignment (CtkButton *button,
                          gfloat *xalign,
                          gfloat *yalign);

Gets the alignment of the child in the button.

Since: 2.4

ctk_button_set_image ()

void
ctk_button_set_image (CtkButton *button,
                      CtkWidget *image);

Set the image of button to the given widget. The image will be displayed if the label text is NULL or if “always-show-image” is TRUE. You don’t have to call ctk_widget_show() on image yourself.

Since: 2.6

ctk_button_get_image ()

CtkWidget *
ctk_button_get_image (CtkButton *button);

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

Since: 2.6

ctk_button_set_image_position ()

void
ctk_button_set_image_position (CtkButton *button,
                               CtkPositionType position);

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

Since: 2.10

ctk_button_get_image_position ()

CtkPositionType
ctk_button_get_image_position (CtkButton *button);

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

Since: 2.10

ctk_button_set_always_show_image ()

void
ctk_button_set_always_show_image (CtkButton *button,
                                  gboolean always_show);

If TRUE, the button will ignore the “ctk-button-images” setting and always show the image, if available.

Use this property if the button would be useless or hard to use without the image.

Since: 3.6

ctk_button_get_always_show_image ()

gboolean
ctk_button_get_always_show_image (CtkButton *button);

Returns whether the button will ignore the “ctk-button-images” setting and always show the image, if available.

Since: 3.6

ctk_button_get_event_window ()

CdkWindow *
ctk_button_get_event_window (CtkButton *button);

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

Since: 2.22

struct CtkButton

struct CtkButton;

struct CtkButtonClass

struct CtkButtonClass {
  CtkBinClass        parent_class;

  void (* pressed)  (CtkButton *button);
  void (* released) (CtkButton *button);
  void (* clicked)  (CtkButton *button);
  void (* enter)    (CtkButton *button);
  void (* leave)    (CtkButton *button);
  void (* activate) (CtkButton *button);
};

The “always-show-image” property

  “always-show-image”        gboolean

If TRUE, the button will ignore the “ctk-button-images” setting and always show the image, if available.

Use this property if the button would be useless or hard to use without the image.

Owner: CtkButton

Flags: Read / Write / Construct

Default value: FALSE

Since: 3.6

The “image” property

  “image”                    CtkWidget *

The child widget to appear next to the button text.

Owner: CtkButton

Flags: Read / Write

Since: 2.6

The “image-position” property

  “image-position”           CtkPositionType

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

Owner: CtkButton

Flags: Read / Write

Default value: CTK_POS_LEFT

Since: 2.10

The “label” property

  “label”                    char *

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

Owner: CtkButton

Flags: Read / Write / Construct

Default value: NULL

The “relief” property

  “relief”                   CtkReliefStyle

The border relief style.

Owner: CtkButton

Flags: Read / Write

Default value: CTK_RELIEF_NORMAL

The “use-stock” property

  “use-stock”                gboolean

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

Owner: CtkButton

Flags: Read / Write / Construct

Default value: FALSE

The “use-underline” property

  “use-underline”            gboolean

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

Owner: CtkButton

Flags: Read / Write / Construct

Default value: FALSE

The “xalign” property

  “xalign”                   float

If the child of the button is a CtkMisc or CtkAlignment, this property can be used to control its horizontal alignment. 0.0 is left aligned, 1.0 is right aligned.

Owner: CtkButton

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5

Since: 2.4

The “yalign” property

  “yalign”                   float

If the child of the button is a CtkMisc or CtkAlignment, this property can be used to control its vertical alignment. 0.0 is top aligned, 1.0 is bottom aligned.

Owner: CtkButton

Flags: Read / Write

Allowed values: [0,1]

Default value: 0.5

Since: 2.4

The “activate” signal

void
user_function (CtkButton *widget,
               gpointer   user_data)

The ::activate signal on CtkButton 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.

Flags: Action

The “clicked” signal

void
user_function (CtkButton *button,
               gpointer   user_data)

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

Flags: Action

The “enter” signal

void
user_function (CtkButton *button,
               gpointer   user_data)

Emitted when the pointer enters the button.

Flags: Run First

The “leave” signal

void
user_function (CtkButton *button,
               gpointer   user_data)

Emitted when the pointer leaves the button.

Flags: Run First

The “pressed” signal

void
user_function (CtkButton *button,
               gpointer   user_data)

Emitted when the button is pressed.

Flags: Run First

The “released” signal

void
user_function (CtkButton *button,
               gpointer   user_data)

Emitted when the button is released.

Flags: Run First