gtk4/org.gtkkn.bindings.gtk/ListItem

ListItem

open class ListItem(pointer: <Error class: unknown class><<Error class: unknown class>>)

GtkListItem is used by list widgets to represent items in a iface@Gio.ListModel.

GtkListItem objects are managed by the list widget (with its factory) and cannot be created by applications, but they need to be populated by application code. This is done by calling method@Gtk.ListItem.set_child.

GtkListItem objects exist in 2 stages:

The unbound stage where the listitem is not currently connected to an item in the list. In that case, the property@Gtk.ListItem:item property is set to null.
The bound stage where the listitem references an item from the list. The property@Gtk.ListItem:item property is not null.

Inheritors

Constructors

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

Types

object Companion

Properties

accessibleDescription

open var accessibleDescription: String

The accessible description to set on the list item.

accessibleLabel

open var accessibleLabel: String

The accessible label to set on the list item.

open var activatable: Boolean

If the item can be activated by the user.

open var child: Widget?

Widget used for display.

open var focusable: Boolean

If the item can be focused with the keyboard.

gtkListItemPointer

val gtkListItemPointer: <Error class: unknown class><<Error class: unknown class>>

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

Displayed item.

open val position: <Error class: unknown class>

Position of the item.

open var selectable: Boolean

If the item can be selected by the user.

open val selected: Boolean

If the item is currently selected.

Functions

getAccessibleDescription

open fun getAccessibleDescription(): String

Gets the accessible description of @self.

getAccessibleLabel

open fun getAccessibleLabel(): String

Gets the accessible label of @self.

open fun getActivatable(): Boolean

Checks if a list item has been set to be activatable via gtk_list_item_set_activatable().

open fun getChild(): Widget?

Gets the child previously set via gtk_list_item_set_child() or null if none was set.

open fun getFocusable(): Boolean

Checks if a list item has been set to be focusable via gtk_list_item_set_focusable().

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

Gets the model item that associated with @self.

open fun getPosition(): <Error class: unknown class>

Gets the position in the model that @self currently displays.

open fun getSelectable(): Boolean

Checks if a list item has been set to be selectable via gtk_list_item_set_selectable().

open fun getSelected(): Boolean

Checks if the item is displayed as selected.

setAccessibleDescription

open fun setAccessibleDescription(description: String)

Sets the accessible description for the list item, which may be used by e.g. screen readers.

setAccessibleLabel

open fun setAccessibleLabel(label: String)

Sets the accessible label for the list item, which may be used by e.g. screen readers.

open fun setActivatable(activatable: Boolean)

Sets @self to be activatable.

open fun setChild(child: Widget? = null)

Sets the child to be used for this listitem.

open fun setFocusable(focusable: Boolean)

Sets @self to be focusable.

open fun setSelectable(selectable: Boolean)

Sets @self to be selectable.