adwaita/org.gtkkn.bindings.adw/ActionRow

ActionRow

open class ActionRow(pointer: <Error class: unknown class><<Error class: unknown class>>) : PreferencesRow

A class@Gtk.ListBoxRow used to present actions.

The AdwActionRow widget can have a title, a subtitle and an icon. The row can receive additional widgets at its end, or prefix widgets at its start.

It is convenient to present a preference and its related actions.

AdwActionRow is unactivatable by default, giving it an activatable widget will automatically make it activatable, but unsetting it won't change the row's activatability.

AdwActionRow as GtkBuildable

The AdwActionRow implementation of the iface@Gtk.Buildable interface supports adding a child at its end by specifying “suffix” or omitting the “type” attribute of a element.

It also supports adding a child as a prefix widget by specifying “prefix” as the “type” attribute of a element.

CSS nodes

AdwActionRow has a main CSS node with name row.

It contains the subnode box.header for its main horizontal box, and box.title for the vertical box containing the title and subtitle labels.

It contains subnodes label.title and label.subtitle representing respectively the title label and subtitle label.

Style classes

AdwActionRow can use the style-classes.html#property-rows style class to emphasize the row subtitle instead of the row title, which is useful for displaying read-only properties.

When used together with the .monospace style class, only the subtitle becomes monospace, not the title or any extra widgets.

Skipped during bindings generation

method subtitle: Property TypeInfo of getter and setter do not match

Inheritors

ComboRow

SpinRow

SwitchRow

Constructors

ActionRow

constructor()

Creates a new AdwActionRow.

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

Types

Companion

object Companion

Properties

activatableWidget

open var activatableWidget: <Error class: unknown class>?

The widget to activate when the row is activated.

adwActionRowPointer

val adwActionRowPointer: <Error class: unknown class><<Error class: unknown class>>

adwPreferencesRowPointer

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

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

iconName

open var iconName: String?

The icon name for this row.

subtitleLines

open var subtitleLines: Int

The number of lines at the end of which the subtitle label will be ellipsized.

subtitleSelectable

open var subtitleSelectable: Boolean

Whether the user can copy the subtitle from the label.

title

open var title: String

The title of the preference represented by this row.

titleLines

open var titleLines: Int

The number of lines at the end of which the title label will be ellipsized.

titleSelectable

open var titleSelectable: Boolean

Whether the user can copy the title from the label.

useMarkup

open var useMarkup: Boolean

Whether to use Pango markup for the title label.

useUnderline

open var useUnderline: Boolean

Whether an embedded underline in the title indicates a mnemonic.

Functions

activate_

open fun activate_()

Activates @self.

addPrefix

open fun addPrefix(widget: <Error class: unknown class>)

Adds a prefix widget to @self.

addSuffix

open fun addSuffix(widget: <Error class: unknown class>)

Adds a suffix widget to @self.

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.

getActivatableWidget

open fun getActivatableWidget(): <Error class: unknown class>?

Gets the widget activated when @self is activated.

getIconName

open fun getIconName(): String?

Gets the icon name for @self.

getSubtitle

open fun getSubtitle(): String?

Gets the subtitle for @self.

getSubtitleLines

open fun getSubtitleLines(): Int

Gets the number of lines at the end of which the subtitle label will be ellipsized.

getSubtitleSelectable

open fun getSubtitleSelectable(): Boolean

Gets whether the user can copy the subtitle from the label

getTitle

open fun getTitle(): String

Gets the title of the preference represented by @self.

getTitleLines

open fun getTitleLines(): Int

Gets the number of lines at the end of which the title label will be ellipsized.

getTitleSelectable

open fun getTitleSelectable(): Boolean

Gets whether the user can copy the title from the label

getUseMarkup

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.

remove

open fun remove(widget: <Error class: unknown class>)

Removes a child from @self.

setActivatableWidget

open fun setActivatableWidget(widget: <Error class: unknown class>? = null)

Sets the widget to activate when @self is activated.

setIconName

open fun setIconName(iconName: String? = null)

Sets the icon name for @self.

setSubtitle

open fun setSubtitle(subtitle: String)

Sets the subtitle for @self.

setSubtitleLines

open fun setSubtitleLines(subtitleLines: Int)

Sets the number of lines at the end of which the subtitle label will be ellipsized.

setSubtitleSelectable

open fun setSubtitleSelectable(subtitleSelectable: Boolean)

Sets whether the user can copy the subtitle from the label

setTitle

open fun setTitle(title: String)

Sets the title of the preference represented by @self.

setTitleLines

open fun setTitleLines(titleLines: Int)

Sets the number of lines at the end of which the title label will be ellipsized.

setTitleSelectable

open fun setTitleSelectable(titleSelectable: Boolean)

Sets whether the user can copy the title from the label

setUseMarkup

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.