adwaita/org.gtkkn.bindings.adw/ComboRow

ComboRow

open class ComboRow(val adwComboRowPointer: <Error class: unknown class><<Error class: unknown class>>) : ActionRow(source)

A class@Gtk.ListBoxRow used to choose from a list of items.

combo-row

The AdwComboRow widget allows the user to choose from a list of valid choices. The row displays the selected choice. When activated, the row displays a popover which allows the user to make a new choice.

Example of an AdwComboRow UI definition:

<object class="AdwComboRow">
  <property name="title" translatable="yes">Combo Row</property>
  <property name="model">
    <object class="GtkStringList">
      <items>
        <item translatable="yes">Foo</item>
        <item translatable="yes">Bar</item>
        <item translatable="yes">Baz</item>
      </items>
    </object>
  </property>
</object>

The property@ComboRow:selected and property@ComboRow:selected-item properties can be used to keep track of the selected item and react to their changes.

AdwComboRow mirrors class@Gtk.DropDown, see that widget for details.

AdwComboRow is property@Gtk.ListBoxRow:activatable if a model is set.

CSS nodes

AdwComboRow has a main CSS node with name row and the .combo style class.

Its popover has the node named popover with the .menu style class, it contains a class@Gtk.ScrolledWindow, which in turn contains a class@Gtk.ListView, both are accessible via their regular nodes.

Accessibility

AdwComboRow uses the GTK_ACCESSIBLE_ROLE_COMBO_BOX role.

Constructors

constructor()

Creates a new AdwComboRow.

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

Types

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

adwComboRowPointer

val adwComboRowPointer: <Error class: unknown class><<Error class: unknown class>>

adwPreferencesRowPointer

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

open var enableSearch: Boolean

Whether to show a search entry in the popup.

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

An expression used to obtain strings from items.

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

Factory for populating list items.

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

open var iconName: String?

This is deprecated since version 1.3.

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

The factory for populating list items in the popup.

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

The model that provides the displayed items.

open var selected: <Error class: unknown class>

The position of the selected item.

open val selectedItem: <Error class: unknown class>?

The selected item.

open var subtitleLines: <Error class: unknown class>

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.

open var title: String

The title of the preference represented by this row.

open var titleLines: <Error class: unknown class>

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.

open var useMarkup: Boolean

Whether to use Pango markup for the title label.

open var useSubtitle: Boolean

Whether to use the current value as the subtitle.

open var useUnderline: Boolean

Whether an embedded underline in the title indicates a mnemonic.

Functions

open fun activate()

Activates @self.

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

Adds a prefix widget to @self.

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

Adds a suffix widget to @self.

fun emitActivated()

Emits the "activated" signal. See onActivated.

open fun getSubtitle(): String?

Gets the subtitle for @self.

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

This signal is emitted after the row has been activated.

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

Removes a child from @self.

open fun setSubtitle(subtitle: String)

Sets the subtitle for @self.