adwaita/org.gtkkn.bindings.adw/ButtonContent

ButtonContent

class ButtonContent(pointer: <Error class: unknown class><<Error class: unknown class>>)

A helper widget for creating buttons.

AdwButtonContent is a box-like widget with an icon and a label.

It's intended to be used as a direct child of class@Gtk.Button, class@Gtk.MenuButton or class@SplitButton, when they need to have both an icon and a label, as follows:

<object class="GtkButton">
  <property name="child">
    <object class="AdwButtonContent">
      <property name="icon-name">document-open-symbolic</property>
      <property name="label" translatable="yes">_Open</property>
      <property name="use-underline">True</property>
    </object>
  </property>
</object>

AdwButtonContent handles style classes and connecting the mnemonic to the button automatically.

CSS nodes

buttoncontent
╰── box
    ├── image
    ╰── label

AdwButtonContent's CSS node is called buttoncontent. It contains a box subnode that serves as a container for the image and label nodes.

When inside a GtkButton or AdwSplitButton, the button will receive the .image-text-button style class. When inside a GtkMenuButton, the internal GtkButton will receive it instead.

Accessibility

AdwButtonContent uses the GTK_ACCESSIBLE_ROLE_GROUP role.

Constructors

constructor()

Creates a new AdwButtonContent.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

adwButtonContentPointer

val adwButtonContentPointer: <Error class: unknown class><<Error class: unknown class>>

var canShrink: Boolean

Whether the button can be smaller than the natural size of its contents.

gtkAccessiblePointer

open val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

var iconName: String

The name of the displayed icon.

var label: String

The displayed label.

var useUnderline: Boolean

Whether an underline in the text indicates a mnemonic.

Functions

fun getCanShrink(): Boolean

gets whether the button can be smaller than the natural size of its contents.

fun getIconName(): String

Gets the name of the displayed icon.

fun getLabel(): String

Gets the displayed label.

getUseUnderline

fun getUseUnderline(): Boolean

Gets whether an underline in the text indicates a mnemonic.

fun setCanShrink(canShrink: Boolean)

Sets whether the button can be smaller than the natural size of its contents.

fun setIconName(iconName: String)

Sets the name of the displayed icon.

fun setLabel(label: String)

Sets the displayed label.

setUseUnderline

fun setUseUnderline(useUnderline: Boolean)

Sets whether an underline in the text indicates a mnemonic.