ColumnViewCell

Added in version 4.12.

class ColumnViewCell(**properties: Any)

Superclasses: ListItem, Object

GtkColumnViewCell is used by ColumnViewColumn to represent items in a cell in ColumnView.

The GtkColumnViewCell’s are managed by the columnview widget (with its factory) and cannot be created by applications, but they need to be populated by application code. This is done by calling set_child.

GtkColumnViewCell’s 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 item property is set to None.

2. The bound stage where the listitem references an item from the list. The item property is not None.

Methods

class ColumnViewCell

get_child() → Widget | None

Gets the child previously set via set_child() or None if none was set.

Added in version 4.12.

get_focusable() → bool

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

Added in version 4.12.

get_item() → Object | None

Gets the model item that associated with self.

If self is unbound, this function returns None.

Added in version 4.12.

get_position() → int

Gets the position in the model that self currently displays.

If self is unbound, INVALID_LIST_POSITION is returned.

Added in version 4.12.

get_selected() → bool

Checks if the item is displayed as selected.

The selected state is maintained by the liste widget and its model and cannot be set otherwise.

Added in version 4.12.

set_child(child: Widget | None = None) → None

Sets the child to be used for this listitem.

This function is typically called by applications when setting up a listitem so that the widget can be reused when binding it multiple times.

Added in version 4.12.

Parameters:

child – The list item’s child or None to unset

set_focusable(focusable: bool) → None

Sets self to be focusable.

If an item is focusable, it can be focused using the keyboard. This works similar to set_focusable.

Note that if items are not focusable, the keyboard cannot be used to activate them and selecting only works if one of the listitem’s children is focusable.

By default, list items are focusable.

Added in version 4.12.

Parameters:

focusable – if the item should be focusable

Properties

class ColumnViewCell

props.child: Widget

Widget used for display.

Added in version 4.12.

props.focusable: bool

If the item can be focused with the keyboard.

Added in version 4.12.

props.item: Object

Displayed item.

Added in version 4.12.

props.position: int

Position of the item.

Added in version 4.12.

props.selected: bool

If the item is currently selected.

Added in version 4.12.