gtk.list_item

Module for [ListItem] class

class ListItem ListItemGidBuilder ListItemGidBuilderImpl

Types 3

classListItem : gobject.object.ObjectWrap

gtk.list_item.ListItem is used by list widgets to represent items in a gio.list_model.ListModel.

gtk.list_item.ListItem 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 gtk.list_item.ListItem.setChild.

gtk.list_item.ListItem objects exist in 2 stages:

  1. The unbound stage where the listitem is not currently connected to an item in the list. In that case, the gtk.list_item.ListItem.item property is set to null.
  2. The bound stage where the listitem references an item from the list. The gtk.list_item.ListItem.item property is not null.
Methods
GType _getGType() static nothrow
GType _gType() @property nothrow
ListItem self() nothrowReturns `this`, for use in `with` statements.
ListItemGidBuilder builder() static nothrowGet builder for [gtk.list_item.ListItem] Returns: New builder object
string accessibleDescription() @property nothrowGet `accessibleDescription` property. Returns: The accessible description to set on the list item.
void accessibleDescription(string propval) @property nothrowSet `accessibleDescription` property. Params: propval = The accessible description to set on the list item.
string accessibleLabel() @property nothrowGet `accessibleLabel` property. Returns: The accessible label to set on the list item.
void accessibleLabel(string propval) @property nothrowSet `accessibleLabel` property. Params: propval = The accessible label to set on the list item.
bool activatable() @property nothrowGet `activatable` property. Returns: If the item can be activated by the user.
void activatable(bool propval) @property nothrowSet `activatable` property. Params: propval = If the item can be activated by the user.
gtk.widget.Widget child() @property nothrowGet `child` property. Returns: Widget used for display.
void child(gtk.widget.Widget propval) @property nothrowSet `child` property. Params: propval = Widget used for display.
bool focusable() @property nothrowGet `focusable` property. Returns: If the item can be focused with the keyboard.
void focusable(bool propval) @property nothrowSet `focusable` property. Params: propval = If the item can be focused with the keyboard.
gobject.object.ObjectWrap item() @property nothrowGet `item` property. Returns: Displayed item.
uint position() @property nothrowGet `position` property. Returns: Position of the item.
bool selectable() @property nothrowGet `selectable` property. Returns: If the item can be selected by the user.
void selectable(bool propval) @property nothrowSet `selectable` property. Params: propval = If the item can be selected by the user.
bool selected() @property nothrowGet `selected` property. Returns: If the item is currently selected.
string getAccessibleDescription() nothrowGets the accessible description of self. Returns: the accessible description
string getAccessibleLabel() nothrowGets the accessible label of self. Returns: the accessible label
bool getActivatable() nothrowChecks if a list item has been set to be activatable via [gtk.list_item.ListItem.setActivatable]. Returns: true if the item is activatable
gtk.widget.Widget getChild() nothrowGets the child previously set via [gtk.list_item.ListItem.setChild] or null if none was set. Returns: The child
bool getFocusable() nothrowChecks if a list item has been set to be focusable via [gtk.list_item.ListItem.setFocusable]. Returns: true if the item is focusable
gobject.object.ObjectWrap getItem() nothrowGets the model item that associated with self.
uint getPosition() nothrowGets the position in the model that self currently displays.
bool getSelectable() nothrowChecks if a list item has been set to be selectable via [gtk.list_item.ListItem.setSelectable].
bool getSelected() nothrowChecks if the item is displayed as selected.
void setAccessibleDescription(string description) nothrowSets the accessible description for the list item, which may be used by e.g. screen readers.
void setAccessibleLabel(string label) nothrowSets the accessible label for the list item, which may be used by e.g. screen readers.
void setActivatable(bool activatable) nothrowSets self to be activatable.
void setChild(gtk.widget.Widget child = null) nothrowSets the child to be used for this listitem.
void setFocusable(bool focusable) nothrowSets self to be focusable.
void setSelectable(bool selectable) nothrowSets self to be selectable.
Constructors
this(void * ptr, Flag!"Take" take)
classListItemGidBuilderImpl(T) : gobject.object.ObjectWrapGidBuilderImpl!T

Fluent builder implementation template for gtk.list_item.ListItem

Methods
T accessibleDescription(string propval) nothrowSet `accessibleDescription` property. Params: propval = The accessible description to set on the list item. Returns: Builder instance for fluent chaining
T accessibleLabel(string propval) nothrowSet `accessibleLabel` property. Params: propval = The accessible label to set on the list item. Returns: Builder instance for fluent chaining
T activatable(bool propval) nothrowSet `activatable` property. Params: propval = If the item can be activated by the user. Returns: Builder instance for fluent chaining
T child(gtk.widget.Widget propval) nothrowSet `child` property. Params: propval = Widget used for display. Returns: Builder instance for fluent chaining
T focusable(bool propval) nothrowSet `focusable` property. Params: propval = If the item can be focused with the keyboard. Returns: Builder instance for fluent chaining
T selectable(bool propval) nothrowSet `selectable` property. Params: propval = If the item can be selected by the user. Returns: Builder instance for fluent chaining
classListItemGidBuilder : ListItemGidBuilderImpl!ListItemGidBuilder

Fluent builder for gtk.list_item.ListItem

Methods
ListItem build() nothrowCreate object from builder. Returns: New object