adwaita/org.gtkkn.bindings.adw/SwitchRow

SwitchRow

class SwitchRow(pointer: <Error class: unknown class><<Error class: unknown class>>) : ActionRow

A class@Gtk.ListBoxRow used to represent two states.

The AdwSwitchRow widget contains a class@Gtk.Switch that allows the user to select between two states: "on" or "off". When activated, the row will invert its active state.

The user can control the switch by activating the row or by dragging on the switch handle.

See class@Gtk.Switch for details.

Example of an AdwSwitchRow UI definition:

<object class="AdwSwitchRow">
  <property name="title" translatable="yes">Switch Row</property>
  <signal name="notify::active" handler="switch_row_notify_active_cb"/>
</object>

The property@SwitchRow:active property should be connected to in order to monitor changes to the active state.

Accessibility

AdwSwitchRow uses the GTK_ACCESSIBLE_ROLE_SWITCH role.

Since

1.4

Constructors

SwitchRow

constructor()

Creates a new AdwSwitchRow.

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.

active

var active: Boolean

Whether the switch row is in the "on" or "off" position.

adwActionRowPointer

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

adwPreferencesRowPointer

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

adwSwitchRowPointer

val adwSwitchRowPointer: <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.

getActive

fun getActive(): Boolean

Gets whether @self is in its "on" or "off" position.

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.

setActive

fun setActive(isActive: Boolean)

Sets whether @self is in its "on" or "off" position

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.