6.2.9 button

Superclass: bin atk-implementor-iface activatable buildable

Subclasses: scale-button link-button font-button color-button toggle-button

The button widget is generally used to attach a function to that is called when the button is pressed. The various signals and how to use them are outlined below.

The button widget can hold any valid child widget. That is it can hold most any other standard widget. The most commonly used child is the label.

Slots:

• focus-on-click. Type: boolean. Accessor: button-focus-on-click.

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

  Default value: True

• image. Type: widget. Accessor: button-image.

  Child widget to appear next to the button text.

• image-position. Type: position-type. Accessor: button-image-position.

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

  Default value: :left

• label. Type: string. Accessor: button-label.

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

  Default value: NIL

• relief. Type: relief-style. Accessor: button-relief.

  The border relief style.

  Default value: :normal

• use-stock. Type: boolean. Accessor: button-use-stock.

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

  Default value: False

• use-underline. Type: boolean. Accessor: button-use-underline.

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

  Default value: False

• xalign. Type: single-float. Accessor: button-xalign.

  If the child of the button is a misc or alignment, 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

• yalign. Type: single-float. Accessor: button-yalign.

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

  Allowed values: [0,1]

  Default value: 0.5

Signals:

• "activate". Signature: (instance button) => void. Options: run-first, action.

  This signal 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.

• "clicked". Signature: (instance button) => void. Options: run-first, action.

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

• "enter". Signature: (instance button) => void. Options: run-first.

  Emitted when the pointer enters the button.

• "leave". Signature: (instance button) => void. Options: run-first.

  Emitted when the pointer leaves the button.

• "pressed". Signature: (instance button) => void. Options: run-first.

  Emitted when the button is pressed.

• "released". Signature: (instance button) => void. Options: run-first.

  Emitted when the button is released.