Gtk.ColumnViewRow

g GObject.Object GObject.Object Gtk.ColumnViewRow Gtk.ColumnViewRow GObject.Object->Gtk.ColumnViewRow

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

get_accessible_description ()

get_accessible_label ()

get_activatable ()

get_focusable ()

get_item ()

get_position ()

get_selectable ()

get_selected ()

set_accessible_description (description)

set_accessible_label (label)

set_activatable (activatable)

set_focusable (focusable)

set_selectable (selectable)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

accessible-description

str

r/w/en

accessible-label

str

r/w/en

activatable

bool

r/w/en

focusable

bool

r/w/en

item

GObject.Object

r/en

position

int

r/en

selectable

bool

r/w/en

selected

bool

r/en

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Gtk.ColumnViewRow(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Gtk.ColumnViewRowClass

GtkColumnViewRow is used by [class`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 [method`GtkColumnViewColumn`.set_factory] and [class`GtkColumnViewCell`].

New in version 4.12.

get_accessible_description()[source]
Returns:

the accessible description

Return type:

str

Gets the accessible description of self.

New in version 4.12.

get_accessible_label()[source]
Returns:

the accessible label

Return type:

str

Gets the accessible label of self.

New in version 4.12.

get_activatable()[source]
Returns:

True if the row is activatable

Return type:

bool

Checks if the row has been set to be activatable via Gtk.ColumnViewRow.set_activatable().

New in version 4.12.

get_focusable()[source]
Returns:

True if the row is focusable

Return type:

bool

Checks if a row item has been set to be focusable via Gtk.ColumnViewRow.set_focusable().

New in version 4.12.

get_item()[source]
Returns:

The item displayed

Return type:

GObject.Object or None

Gets the model item that associated with self.

If self is unbound, this function returns None.

New in version 4.12.

get_position()[source]
Returns:

The position of this row

Return type:

int

Gets the position in the model that self currently displays.

If self is unbound, Gtk.INVALID_LIST_POSITION is returned.

New in version 4.12.

get_selectable()[source]
Returns:

True if the row is selectable

Return type:

bool

Checks if the row has been set to be selectable via Gtk.ColumnViewRow.set_selectable().

Do not confuse this function with [method`Gtk`.ColumnViewRow.get_selected].

New in version 4.12.

get_selected()[source]
Returns:

True if the item is selected.

Return type:

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.

New in version 4.12.

set_accessible_description(description)[source]
Parameters:

description (str) – the description

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

New in version 4.12.

set_accessible_label(label)[source]
Parameters:

label (str) – the label

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

New in version 4.12.

set_activatable(activatable)[source]
Parameters:

activatable (bool) – if the row should be activatable

Sets self to be activatable.

If a row is activatable, double-clicking on the row, using the Return key or calling Gtk.Widget.activate() will activate the row. Activating instructs the containing columnview to emit the [signal`Gtk`.ColumnView::activate] signal.

By default, row are activatable.

New in version 4.12.

set_focusable(focusable)[source]
Parameters:

focusable (bool) – if the row should be focusable

Sets self to be focusable.

If a row is focusable, it can be focused using the keyboard. This works similar to [method`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.

New in version 4.12.

set_selectable(selectable)[source]
Parameters:

selectable (bool) – if the row should be selectable

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.

New in version 4.12.

Property Details

Gtk.ColumnViewRow.props.accessible_description
Name:

accessible-description

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The accessible description to set on the row.

New in version 4.12.

Gtk.ColumnViewRow.props.accessible_label
Name:

accessible-label

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

The accessible label to set on the row.

New in version 4.12.

Gtk.ColumnViewRow.props.activatable
Name:

activatable

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

If the row can be activated by the user.

New in version 4.12.

Gtk.ColumnViewRow.props.focusable
Name:

focusable

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

If the row can be focused with the keyboard.

New in version 4.12.

Gtk.ColumnViewRow.props.item
Name:

item

Type:

GObject.Object

Default Value:

None

Flags:

READABLE, EXPLICIT_NOTIFY

The item for this row.

New in version 4.12.

Gtk.ColumnViewRow.props.position
Name:

position

Type:

int

Default Value:

4294967295

Flags:

READABLE, EXPLICIT_NOTIFY

Position of the row.

New in version 4.12.

Gtk.ColumnViewRow.props.selectable
Name:

selectable

Type:

bool

Default Value:

True

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

If the row can be selected by the user.

New in version 4.12.

Gtk.ColumnViewRow.props.selected
Name:

selected

Type:

bool

Default Value:

False

Flags:

READABLE, EXPLICIT_NOTIFY

If the item in the row is currently selected.

New in version 4.12.