gtk.section_model_mixin

Module for SectionModel interface mixin

tmpl SectionModelGidBuilderT SectionModelT

Templates 2

tmplSectionModelT()

gtk.section_model.SectionModel is an interface that adds support for sections to list models.

A gtk.section_model.SectionModel groups successive items into so-called sections. List widgets like gtk.list_view.ListView and gtk.grid_view.GridView then allow displaying section headers for these sections by installing a header factory.

Many GTK list models support sections inherently, or they pass through the sections of a model they are wrapping.

When the section groupings of a model change, the model will emit the gtk.section_model.SectionModel.sectionsChanged signal by calling the gtk.section_model.SectionModel.sectionsChanged function. All sections in the given range then need to be queried again. The gio.list_model.ListModel.itemsChanged signal has the same effect, all sections in that range are invalidated, too.

Functions
void getSection(uint position, out uint outStart, out uint outEnd)

Query the section that covers the given position. The number of items in the section can be computed by out_end - out_start.

If the position is larger than the number of items, a single range from n_items to G_MAXUINT will be returned.

Parameters

positionthe position of the item to query
outStartthe position of the first item in the section
outEndthe position of the first item not part of the section anymore.
void sectionsChanged(uint position, uint nItems)
gulong connectSectionsChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T && is(ReturnType!T == void) && (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == uint))) && (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] == uint))) && (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] : gtk.section_model.SectionModel))) && Parameters!T.length < 4)

Connect to SectionsChanged signal.

Emitted when the start-of-section state of some of the items in model changes.

Note that this signal does not specify the new section state of the items, they need to be queried manually. It is also not necessary for a model to change the section state of any of the items in the section model, though it would be rather useless to emit such a signal.

The gio.list_model.ListModel.itemsChanged implies the effect of the gtk.section_model.SectionModel.sectionsChanged signal for all the items it covers.

Parameters

callbacksignal callback delegate or function to connect void callback(uint position, uint nItems, gtk.section_model.SectionModel sectionModel) position The first item that may have changed (optional) nItems number of items with changes (optional) sectionModel the instance the signal is connected to (optional)
afterYes.After to execute callback after default handler, No.After to execute before (default)

Returns

Signal ID
tmplSectionModelGidBuilderT()

Fluent builder implementation template for gtk.section_model.SectionModel