adwaita/org.gtkkn.bindings.adw/SpinRow

SpinRow

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

An class@ActionRow with an embedded spin button.

Example of an AdwSpinRow UI definition:

<object class="AdwSpinRow">
  <property name="title" translatable="yes">Spin Row</property>
  <property name="adjustment">
    <object class="GtkAdjustment">
      <property name="lower">0</property>
      <property name="upper">100</property>
      <property name="value">50</property>
      <property name="page-increment">10</property>
      <property name="step-increment">1</property>
    </object>
  </property>
</object>

See class@Gtk.SpinButton for details.

CSS nodes

AdwSpinRow has the same structure as class@ActionRow, as well as the .spin style class on the main node.

Accessibility

AdwSpinRow uses an internal GtkSpinButton with the GTK_ACCESSIBLE_ROLE_SPIN_BUTTON role.

Skipped during bindings generation

method adjustment: Property TypeInfo of getter and setter do not match
signal input: Unsupported parameter new_value : new_value: Out parameter is not supported

Since

1.4

Constructors

SpinRow

constructor(adjustment: <Error class: unknown class>? = null, climbRate: Double, digits: <Error class: unknown class>)

Creates a new AdwSpinRow.

constructor(min: Double, max: Double, step: Double)

Creates a new AdwSpinRow with the given properties.

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

adwSpinRowPointer

val adwSpinRowPointer: <Error class: unknown class><<Error class: unknown class>>

climbRate

var climbRate: Double

The acceleration rate when you hold down a button or key.

digits

var digits: <Error class: unknown class>

The number of decimal places to display.

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

gtkEditablePointer

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

iconName

open var iconName: String?

The icon name for this row.

numeric

var numeric: Boolean

Whether non-numeric characters should be ignored.

snapToTicks

var snapToTicks: Boolean

Whether invalid values are snapped to the nearest step increment.

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.

updatePolicy

var updatePolicy: <Error class: unknown class>

The policy for updating the spin row.

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.

value

var value: Double

The current value.

wrap

var wrap: Boolean

Whether the spin row should wrap upon reaching its limits.

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.

configure

fun configure(adjustment: <Error class: unknown class>? = null, climbRate: Double, digits: <Error class: unknown class>)

Changes the properties of an existing spin row.

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.

connectOutput

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

Emitted to tweak the formatting of the value for display.

connectWrapped

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

Emitted right after the spinbutton wraps.

getActivatableWidget

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

Gets the widget activated when @self is activated.

getAdjustment

fun getAdjustment(): <Error class: unknown class>

Gets the adjustment that holds the value for the spin row.

getClimbRate

fun getClimbRate(): Double

Gets the acceleration rate when you hold down a button or key.

getDigits

fun getDigits(): <Error class: unknown class>

Gets the number of decimal places to display.

getIconName

open fun getIconName(): String?

Gets the icon name for @self.

getNumeric

fun getNumeric(): Boolean

Gets whether non-numeric characters should be ignored.

getSnapToTicks

fun getSnapToTicks(): Boolean

Gets whether invalid values are snapped to nearest step increment.

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

getUpdatePolicy

fun getUpdatePolicy(): <Error class: unknown class>

Gets the policy for updating the spin row.

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.

getValue

fun getValue(): Double

Gets the current value.

getWrap

fun getWrap(): Boolean

Gets whether the spin row should wrap upon reaching its limits.

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.

setAdjustment

fun setAdjustment(adjustment: <Error class: unknown class>? = null)

Sets the adjustment that holds the value for the spin row.

setClimbRate

fun setClimbRate(climbRate: Double)

Sets the acceleration rate when you hold down a button or key.

setDigits

fun setDigits(digits: <Error class: unknown class>)

Sets the number of decimal places to display.

setIconName

open fun setIconName(iconName: String? = null)

Sets the icon name for @self.

setNumeric

fun setNumeric(numeric: Boolean)

Sets whether non-numeric characters should be ignored.

setRange

fun setRange(min: Double, max: Double)

Sets the minimum and maximum allowable values for @self.

setSnapToTicks

fun setSnapToTicks(snapToTicks: Boolean)

Sets whether invalid values are snapped to the nearest step increment.

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

setUpdatePolicy

fun setUpdatePolicy(policy: <Error class: unknown class>)

Sets the policy for updating the spin row.

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.

setValue

fun setValue(value: Double)

Sets the current value.

setWrap

fun setWrap(wrap: Boolean)

Sets whether the spin row should wrap upon reaching its limits.

update

fun update()

Manually force an update of the spin row.