:right-sidebar: True

ColumnViewRow
===================================================================

.. currentmodule:: gi.repository.Gtk


.. versionadded:: 4.12




.. class:: ColumnViewRow(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`





``GtkColumnViewRow`` is used by :obj:`~gi.repository.Gtk.ColumnView` to allow configuring
how rows are displayed.

It is not used to set the widgets displayed in the individual cells. For that
see :obj:`~gi.repository.GtkColumnViewColumn.set_factory` and :obj:`~gi.repository.Gtk.GtkColumnViewCell`.





Methods
-------

.. rst-class:: interim-class

.. class:: ColumnViewRow
   :no-index:


   .. method:: get_accessible_description() -> str

      Gets the accessible description of ``self``.



      .. versionadded:: 4.12








   .. method:: get_accessible_label() -> str

      Gets the accessible label of ``self``.



      .. versionadded:: 4.12








   .. method:: get_activatable() -> bool

      Checks if the row has been set to be activatable via
      :func:`~gi.repository.Gtk.ColumnViewRow.set_activatable`.



      .. versionadded:: 4.12








   .. method:: get_focusable() -> bool

      Checks if a row item has been set to be focusable via
      :func:`~gi.repository.Gtk.ColumnViewRow.set_focusable`.



      .. versionadded:: 4.12








   .. method:: get_item() -> ~gi.repository.GObject.Object | None

      Gets the model item that associated with ``self``.

      If ``self`` is unbound, this function returns :const:`None`.



      .. versionadded:: 4.12








   .. method:: get_position() -> int

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

      If ``self`` is unbound, :const:`~gi.repository.Gtk.INVALID_LIST_POSITION` is returned.



      .. versionadded:: 4.12








   .. method:: get_selectable() -> bool

      Checks if the row has been set to be selectable via
      :func:`~gi.repository.Gtk.ColumnViewRow.set_selectable`.

      Do not confuse this function with :obj:`~gi.repository.Gtk.ColumnViewRow.get_selected`.



      .. versionadded:: 4.12








   .. method:: get_selected() -> bool

      Checks if the item is selected that this row corresponds to.

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



      .. versionadded:: 4.12








   .. method:: set_accessible_description(description: str) -> None

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



      .. versionadded:: 4.12





      :param description: the description





   .. method:: set_accessible_label(label: str) -> None

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



      .. versionadded:: 4.12





      :param label: the label





   .. method:: set_activatable(activatable: bool) -> None

      Sets ``self`` to be activatable.

      If a row is activatable, double-clicking on the row, using
      the Return key or calling :func:`~gi.repository.Gtk.Widget.activate` will activate
      the row. Activating instructs the containing columnview to
      emit the :obj:`~gi.repository.Gtk.ColumnView.signals.activate` signal.

      By default, row are activatable.



      .. versionadded:: 4.12





      :param activatable: if the row should be activatable





   .. method:: set_focusable(focusable: bool) -> None

      Sets ``self`` to be focusable.

      If a row is focusable, it can be focused using the keyboard.
      This works similar to :obj:`~gi.repository.Gtk.Widget.set_focusable`.

      Note that if row are not focusable, the contents of cells can still be focused if
      they are focusable.

      By default, rows are focusable.



      .. versionadded:: 4.12





      :param focusable: if the row should be focusable





   .. method:: set_selectable(selectable: bool) -> None

      Sets ``self`` to be selectable.

      If a row is selectable, clicking on the row or using the keyboard
      will try to select or unselect the row. Whether this succeeds is up to
      the model to determine, as it is managing the selected state.

      Note that this means that making a row non-selectable has no
      influence on the selected state at all. A non-selectable row
      may still be selected.

      By default, rows are selectable.



      .. versionadded:: 4.12





      :param selectable: if the row should be selectable









Properties
----------

.. rst-class:: interim-class

.. class:: ColumnViewRow
   :no-index:
   

   .. attribute:: props.accessible_description
      :type: str

      The accessible description to set on the row.



      .. versionadded:: 4.12





   .. attribute:: props.accessible_label
      :type: str

      The accessible label to set on the row.



      .. versionadded:: 4.12





   .. attribute:: props.activatable
      :type: bool

      If the row can be activated by the user.



      .. versionadded:: 4.12





   .. attribute:: props.focusable
      :type: bool

      If the row can be focused with the keyboard.



      .. versionadded:: 4.12





   .. attribute:: props.item
      :type: ~gi.repository.GObject.Object

      The item for this row.



      .. versionadded:: 4.12





   .. attribute:: props.position
      :type: int

      Position of the row.



      .. versionadded:: 4.12





   .. attribute:: props.selectable
      :type: bool

      If the row can be selected by the user.



      .. versionadded:: 4.12





   .. attribute:: props.selected
      :type: bool

      If the item in the row is currently selected.



      .. versionadded:: 4.12