Memory-managed wrapper type.

Type class for types which can be safely cast to Button, for instance with toButton.

Cast to Button, for types for which this is known to be safe. For general casts, use castTo.

A convenience alias for Nothing :: Maybe Button.

Emits a Button::clicked signal to the given Button.

Emits a Button::enter signal to the given Button.

Gets the alignment of the child in the button.

Since: 2.4

Returns whether the button will ignore the Settings:gtk-button-images setting and always show the image, if available.

Since: 3.6

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

Since: 2.22

Returns whether the button grabs focus when it is clicked with the mouse. See buttonSetFocusOnClick.

Since: 2.4

Gets the widget that is currenty set as the image of button. This may have been explicitly set by buttonSetImage or constructed by buttonNewFromStock.

Since: 2.6

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

Since: 2.10

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

Returns the current relief style of the given Button.

Returns whether the button label is a stock item.

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

Emits a Button::leave signal to the given Button.

Creates a new Button widget. To add a child widget to the button, use containerAdd.

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 buttonNew and buttonSetImage.

Since: 3.10

Creates a new Button containing the image and text from a stock item. Some stock ids have preprocessor macros like STOCK_OK and STOCK_APPLY.

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

Creates a Button widget with a Label child containing the given text.

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

Emits a Button::pressed signal to the given Button.

Emits a Button::released signal to the given Button.

Sets the alignment of the child. This property has no effect unless the child is a Misc or a Alignment.

Since: 2.4

If True, the button will ignore the Settings:gtk-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

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

Set the image of button to the given widget. The image will be displayed if the label text is Nothing or if Button:always-show-image is True. You don’t have to call widgetShow on image yourself.

Since: 2.6

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

Since: 2.10

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

This will also clear any previously set labels.

Sets the relief style of the edges of the given Button widget. Two styles exist, ReliefStyleNormal and ReliefStyleNone. The default style is, as one can guess, ReliefStyleNormal. The deprecated value ReliefStyleHalf behaves the same as ReliefStyleNormal.

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

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

Construct a GValueConstruct with valid value for the “always-show-image” property. This is rarely needed directly, but it is used by new.

Get the value of the “always-show-image” property. When overloading is enabled, this is equivalent to

get button #alwaysShowImage

Set the value of the “always-show-image” property. When overloading is enabled, this is equivalent to

set button [ #alwaysShowImage := value ]

Set the value of the “image” property to Nothing. When overloading is enabled, this is equivalent to

clear #image

Construct a GValueConstruct with valid value for the “image” property. This is rarely needed directly, but it is used by new.

Get the value of the “image” property. When overloading is enabled, this is equivalent to

get button #image

Set the value of the “image” property. When overloading is enabled, this is equivalent to

set button [ #image := value ]

Construct a GValueConstruct with valid value for the “image-position” property. This is rarely needed directly, but it is used by new.

Get the value of the “image-position” property. When overloading is enabled, this is equivalent to

get button #imagePosition

Set the value of the “image-position” property. When overloading is enabled, this is equivalent to

set button [ #imagePosition := value ]

Construct a GValueConstruct with valid value for the “label” property. This is rarely needed directly, but it is used by new.

Get the value of the “label” property. When overloading is enabled, this is equivalent to

get button #label

Set the value of the “label” property. When overloading is enabled, this is equivalent to

set button [ #label := value ]

Construct a GValueConstruct with valid value for the “relief” property. This is rarely needed directly, but it is used by new.

Get the value of the “relief” property. When overloading is enabled, this is equivalent to

get button #relief

Set the value of the “relief” property. When overloading is enabled, this is equivalent to

set button [ #relief := value ]

Construct a GValueConstruct with valid value for the “use-stock” property. This is rarely needed directly, but it is used by new.

Get the value of the “use-stock” property. When overloading is enabled, this is equivalent to

get button #useStock

Set the value of the “use-stock” property. When overloading is enabled, this is equivalent to

set button [ #useStock := value ]

Construct a GValueConstruct with valid value for the “use-underline” property. This is rarely needed directly, but it is used by new.

Get the value of the “use-underline” property. When overloading is enabled, this is equivalent to

get button #useUnderline

Set the value of the “use-underline” property. When overloading is enabled, this is equivalent to

set button [ #useUnderline := value ]

Construct a GValueConstruct with valid value for the “xalign” property. This is rarely needed directly, but it is used by new.

Get the value of the “xalign” property. When overloading is enabled, this is equivalent to

get button #xalign

Set the value of the “xalign” property. When overloading is enabled, this is equivalent to

set button [ #xalign := value ]

Construct a GValueConstruct with valid value for the “yalign” property. This is rarely needed directly, but it is used by new.

Get the value of the “yalign” property. When overloading is enabled, this is equivalent to

get button #yalign

Set the value of the “yalign” property. When overloading is enabled, this is equivalent to

set button [ #yalign := value ]

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 Button::clicked signal.

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “activate” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after button #activate callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ButtonActivateCallback.

A convenience synonym for Nothing :: Maybe ButtonActivateCallback.

Connect a signal handler for the “activate” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on button #activate callback

Wrap a ButtonActivateCallback into a C_ButtonActivateCallback.

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

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “clicked” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after button #clicked callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ButtonClickedCallback.

A convenience synonym for Nothing :: Maybe ButtonClickedCallback.

Connect a signal handler for the “clicked” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on button #clicked callback

Wrap a ButtonClickedCallback into a C_ButtonClickedCallback.

Emitted when the pointer enters the button.

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “enter” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after button #enter callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ButtonEnterCallback.

A convenience synonym for Nothing :: Maybe ButtonEnterCallback.

Connect a signal handler for the “enter” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on button #enter callback

Wrap a ButtonEnterCallback into a C_ButtonEnterCallback.

Emitted when the pointer leaves the button.

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “leave” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after button #leave callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ButtonLeaveCallback.

A convenience synonym for Nothing :: Maybe ButtonLeaveCallback.

Connect a signal handler for the “leave” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on button #leave callback

Wrap a ButtonLeaveCallback into a C_ButtonLeaveCallback.

Emitted when the button is pressed.

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “pressed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after button #pressed callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ButtonPressedCallback.

A convenience synonym for Nothing :: Maybe ButtonPressedCallback.

Connect a signal handler for the “pressed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on button #pressed callback

Wrap a ButtonPressedCallback into a C_ButtonPressedCallback.

Emitted when the button is released.

Type for the callback on the (unwrapped) C side.

Connect a signal handler for the “released” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after button #released callback

Wrap the callback into a Closure.

Generate a function pointer callable from C code, from a C_ButtonReleasedCallback.

A convenience synonym for Nothing :: Maybe ButtonReleasedCallback.

Connect a signal handler for the “released” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on button #released callback

Wrap a ButtonReleasedCallback into a C_ButtonReleasedCallback.