adwaita/org.gtkkn.bindings.adw/ButtonRow

ButtonRow

class ButtonRow(pointer: <Error class: unknown class><<Error class: unknown class>>) : PreferencesRow

A class@Gtk.ListBoxRow that looks like a button.

The AdwButtonRow widget has a title and two icons: before and after the title.

It is convenient for presenting actions like "Delete" at the end of a boxed list.

AdwButtonRow is always activatable.

CSS nodes

AdwButtonRow has a main CSS node with name row and the style class .button.

It contains the subnode box for its main horizontal box, which contains the nodes: image.icon.start for the start icon, label.title for the title, and image.icon.end for the end icon.

Style classes

The style-classes.html#suggested-action style class makes AdwButtonRow use accent color for its background. It should be used very sparingly to denote important buttons.

button-row-suggested-action

The style-classes.html#destructive-action style makes the row use destructive colors. It can be used to draw attention to the potentially damaging consequences of using it. This style acts as a warning to the user.

button-row-destructive-action

Since

1.6

Constructors

constructor()

Creates a new AdwButtonRow.

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

Types

object Companion

Properties

adwButtonRowPointer

val adwButtonRowPointer: <Error class: unknown class><<Error class: unknown class>>

adwPreferencesRowPointer

val adwPreferencesRowPointer: <Error class: unknown class><<Error class: unknown class>>

var endIconName: String?

The icon name to show after the title.

gtkAccessiblePointer

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

gtkActionablePointer

open override val gtkActionablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

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

gtkConstraintTargetPointer

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

var startIconName: String?

The icon name to show before the title.

open var title: String

The title of the preference represented by this row.

titleSelectable

open var titleSelectable: Boolean

Whether the user can copy the title from the label.

open var useMarkup: Boolean

Whether to use Pango markup for the title label.

open var useUnderline: Boolean

Whether an embedded underline in the title indicates a mnemonic.

Functions

connectActivated

fun connectActivated(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

This signal is emitted after the row has been activated.

fun getEndIconName(): String?

Gets the end icon name for @self.

getStartIconName

fun getStartIconName(): String?

Gets the start icon name for @self.

open fun getTitle(): String

Gets the title of the preference represented by @self.

getTitleSelectable

open fun getTitleSelectable(): Boolean

Gets whether the user can copy the title from the label

open fun getUseMarkup(): Boolean

Gets whether to use Pango markup for the title label.

getUseUnderline

open fun getUseUnderline(): Boolean

Gets whether an embedded underline in the title indicates a mnemonic.

fun setEndIconName(iconName: String? = null)

Sets the end icon name for @self.

setStartIconName

fun setStartIconName(iconName: String? = null)

Sets the start icon name for @self.

open fun setTitle(title: String)

Sets the title of the preference represented by @self.

setTitleSelectable

open fun setTitleSelectable(titleSelectable: Boolean)

Sets whether the user can copy the title from the label

open fun setUseMarkup(useMarkup: Boolean)

Sets whether to use Pango markup for the title label.

setUseUnderline

open fun setUseUnderline(useUnderline: Boolean)

Sets whether an embedded underline in the title indicates a mnemonic.