Gtk.ListHeader¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_child` ()
	`get_end` ()
	`get_item` ()
	`get_n_items` ()
	`get_start` ()
	`set_child` (child)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags
`child`	`Gtk.Widget`	r/w/en
`end`	`int`	r/en
`item`	`GObject.Object`	r/en
`n-items`	`int`	r/en
`start`	`int`	r/en

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Gtk.ListHeader(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gtk.ListHeaderClass

GtkListHeader is used by list widgets to represent the headers they display.

GtkListHeader objects are managed just like [class`Gtk`.ListItem] objects via their factory, but provide a different set of properties suitable for managing the header instead of individual items.

New in version 4.12.

get_child()[source]¶

Returns:: The child
Return type:: Gtk.Widget or None

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

New in version 4.12.

get_end()[source]¶

Returns:: The end position of the section
Return type:: int

Gets the end position in the model of the section that self is currently the header for.

If self is unbound, Gtk.INVALID_LIST_POSITION is returned.

New in version 4.12.

get_item()[source]¶

Returns:: The item displayed
Return type:: GObject.Object or None

Gets the model item at the start of the section. This is the item that occupies the list model at position [property`Gtk`.ListHeader:start].

If self is unbound, this function returns None.

New in version 4.12.

get_n_items()[source]¶

Returns:: The number of items in the section
Return type:: int

Gets the the number of items in the section.

If self is unbound, 0 is returned.

New in version 4.12.

get_start()[source]¶

Returns:: The start position of the section
Return type:: int

Gets the start position in the model of the section that self is currently the header for.

If self is unbound, Gtk.INVALID_LIST_POSITION is returned.

New in version 4.12.

set_child(child)[source]¶

Parameters:: child (Gtk.Widget or None) – The list item’s child or None to unset

Sets the child to be used for this listitem.

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

New in version 4.12.

Property Details¶

Gtk.ListHeader.props.child¶

Name:: child
Type:: Gtk.Widget
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Widget used for display.

New in version 4.12.

Gtk.ListHeader.props.end¶

Name:: end
Type:: int
Default Value:: 4294967295
Flags:: READABLE, EXPLICIT_NOTIFY

The first position no longer part of this section.

New in version 4.12.

Gtk.ListHeader.props.item¶

Name:: item
Type:: GObject.Object
Default Value:: None
Flags:: READABLE, EXPLICIT_NOTIFY

The item at the start of the section.

New in version 4.12.

Gtk.ListHeader.props.n_items¶

Name:: n-items
Type:: int
Default Value:: 0
Flags:: READABLE, EXPLICIT_NOTIFY

Number of items in this section.

New in version 4.12.

Gtk.ListHeader.props.start¶

Name:: start
Type:: int
Default Value:: 4294967295
Flags:: READABLE, EXPLICIT_NOTIFY

First position of items in this section.

New in version 4.12.