Gtk.ListBoxRow

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Actionable Gtk.Actionable GObject.GInterface->Gtk.Actionable Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.ListBoxRow Gtk.ListBoxRow Gtk.Actionable->Gtk.ListBoxRow Gtk.Bin Gtk.Bin Gtk.Bin->Gtk.ListBoxRow Gtk.Buildable->Gtk.Widget Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Widget->Gtk.Container

Subclasses:None

Properties

Inherited:Gtk.Container (3), Gtk.Widget (39), Gtk.Actionable (2)
Name Type Flags Short Description
activatable bool r/w/en Whether this row can be activated
selectable bool r/w/en Whether this row can be selected

Style Properties

Inherited:Gtk.Widget (17)

Signals

Inherited:Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)
Name Short Description
activate This is a keybinding signal, which will cause this row to be activated.

Fields

Inherited:Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)
Name Type Access Description
parent_instance Gtk.Bin r  

Class Details

class Gtk.ListBoxRow(**kwargs)
Bases:Gtk.Bin, Gtk.Actionable
Abstract:No
Structure:Gtk.ListBoxRowClass
classmethod new()[source]
Returns:a new Gtk.ListBoxRow
Return type:Gtk.Widget

Creates a new Gtk.ListBoxRow, to be used as a child of a Gtk.ListBox.

New in version 3.10.

changed()[source]

Marks self as changed, causing any state that depends on this to be updated. This affects sorting, filtering and headers.

Note that calls to this method must be in sync with the data used for the row functions. For instance, if the list is mirroring some external data set, and *two* rows changed in the external data set then when you call Gtk.ListBoxRow.changed() on the first row the sort function must only read the new data for the first of the two changed rows, otherwise the resorting of the rows will be wrong.

This generally means that if you don’t fully control the data model you have to duplicate the data that affects the listbox row functions into the row widgets themselves. Another alternative is to call Gtk.ListBox.invalidate_sort() on any model change, but that is more expensive.

New in version 3.10.

get_activatable()[source]
Returns:True if the row is activatable
Return type:bool

Gets the value of the Gtk.ListBoxRow :activatable property for this row.

New in version 3.14.

get_header()[source]
Returns:the current header, or None if none
Return type:Gtk.Widget or None

Returns the current header of the self. This can be used in a Gtk.ListBoxUpdateHeaderFunc to see if there is a header set already, and if so to update the state of it.

New in version 3.10.

get_index()[source]
Returns:the index of the self, or -1 if the self is not in a listbox
Return type:int

Gets the current index of the self in its Gtk.ListBox container.

New in version 3.10.

get_selectable()[source]
Returns:True if the row is selectable
Return type:bool

Gets the value of the Gtk.ListBoxRow :selectable property for this row.

New in version 3.14.

is_selected()[source]
Returns:True if self is selected
Return type:bool

Returns whether the child is currently selected in its Gtk.ListBox container.

New in version 3.14.

set_activatable(activatable)[source]
Parameters:activatable (bool) – True to mark the row as activatable

Set the Gtk.ListBoxRow :activatable property for this row.

New in version 3.14.

set_header(header)[source]
Parameters:header (Gtk.Widget or None) – the header, or None

Sets the current header of the self. This is only allowed to be called from a Gtk.ListBoxUpdateHeaderFunc. It will replace any existing header in the row, and be shown in front of the row in the listbox.

New in version 3.10.

set_selectable(selectable)[source]
Parameters:selectable (bool) – True to mark the row as selectable

Set the Gtk.ListBoxRow :selectable property for this row.

New in version 3.14.

do_activate() virtual

Signal Details

Gtk.ListBoxRow.signals.activate(list_box_row)
Signal Name:activate
Flags:RUN_FIRST, ACTION
Parameters:list_box_row (Gtk.ListBoxRow) – The object which received the signal

This is a keybinding signal, which will cause this row to be activated.

If you want to be notified when the user activates a row (by key or not), use the Gtk.ListBox ::row-activated signal on the row’s parent Gtk.ListBox.

New in version 3.10.

Property Details

Gtk.ListBoxRow.props.activatable
Name:activatable
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

The property determines whether the Gtk.ListBox ::row-activated signal will be emitted for this row.

New in version 3.14.

Gtk.ListBoxRow.props.selectable
Name:selectable
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

The property determines whether this row can be selected.

New in version 3.14.