SortListModel

A gio.list_model.ListModel that sorts the elements of an underlying model according to a gtk.sorter.Sorter.

The model is a stable sort. If two items compare equal according to the sorter, the one that appears first in the original model will also appear first after sorting. Note that if you change the sorter, the previous order will have no influence on the new order. If you want that, consider using a gtk.multi_sorter.MultiSorter and appending the previous sorter to it.

The model can be set up to do incremental sorting, so that sorting long lists doesn't block the UI. See gtk.sort_list_model.SortListModel.setIncremental for details.

gtk.sort_list_model.SortListModel is a generic model and because of that it cannot take advantage of any external knowledge when sorting. If you run into performance issues with gtk.sort_list_model.SortListModel, it is strongly recommended that you write your own sorting list model.

gtk.sort_list_model.SortListModel allows sorting the items into sections. It implements gtk.section_model.SectionModel and when property@Gtk.SortListModel:section-sorter is set, it will sort all items with that sorter and items comparing equal with it will be put into the same section. The gtk.sort_list_model.SortListModel.Sorter will then be used to sort items inside their sections.

Constructors

this
this(gio.list_model.ListModel model, gtk.sorter.Sorter sorter)

Creates a new sort list model that uses the sorter to sort model.

Members

Functions

getIncremental
bool getIncremental()

Returns whether incremental sorting is enabled.

getModel
gio.list_model.ListModel getModel()

Gets the model currently sorted or null if none.

getPending
uint getPending()

Estimates progress of an ongoing sorting operation.

getSectionSorter
gtk.sorter.Sorter getSectionSorter()

Gets the section sorter that is used to sort items of self into sections.

getSorter
gtk.sorter.Sorter getSorter()

Gets the sorter that is used to sort self.

setIncremental
void setIncremental(bool incremental)

Sets the sort model to do an incremental sort.

setModel
void setModel(gio.list_model.ListModel model)

Sets the model to be sorted.

setSectionSorter
void setSectionSorter(gtk.sorter.Sorter sorter)

Sets a new section sorter on self.

setSorter
void setSorter(gtk.sorter.Sorter sorter)

Sets a new sorter on self.

Mixed In Members

From mixin ListModelT!()

getItem
T getItem(uint position)

Get the item at position and cast to the template type. NOTE: If type is an interface and no known D object is found that the object conforms to, the interface IfaceProxy object will be used. If position is greater than the number of items in list, %NULL is returned. %NULL may be returned if index is smaller than the length of the list, but the object does not conform to the template type. This function is meant to be used by language bindings in place of Gio.ListModel.getItem. See also: Gio.ListModel.getNItems

getItemType
gobject.types.GType getItemType()

Gets the type of the items in list.

getNItems
uint getNItems()

Gets the number of items in list.

getItem
gobject.object.ObjectG getItem(uint position)

Get the item at position.

itemsChanged
void itemsChanged(uint position, uint removed, uint added)

Emits the #GListModel::items-changed signal on list.

connectItemsChanged
ulong connectItemsChanged(T callback, Flag!"After" after)

Connect to ItemsChanged signal.

From mixin SectionModelT!()

getSection
void getSection(uint position, uint outStart, 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.

sectionsChanged
void sectionsChanged(uint position, uint nItems)
connectSectionsChanged
ulong connectSectionsChanged(T callback, Flag!"After" after)

Connect to SectionsChanged signal.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

From ListModel

getItem
T getItem(uint position)

Get the item at position and cast to the template type. NOTE: If type is an interface and no known D object is found that the object conforms to, the interface IfaceProxy object will be used. If position is greater than the number of items in list, %NULL is returned. %NULL may be returned if index is smaller than the length of the list, but the object does not conform to the template type. This function is meant to be used by language bindings in place of Gio.ListModel.getItem. See also: Gio.ListModel.getNItems

getItemType
gobject.types.GType getItemType()

Gets the type of the items in list.

getNItems
uint getNItems()

Gets the number of items in list.

getItem
gobject.object.ObjectG getItem(uint position)

Get the item at position.

itemsChanged
void itemsChanged(uint position, uint removed, uint added)

Emits the #GListModel::items-changed signal on list.

connectItemsChanged
ulong connectItemsChanged(T callback, Flag!"After" after)

Connect to ItemsChanged signal.

From SectionModel

getSection
void getSection(uint position, uint outStart, 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.

sectionsChanged
void sectionsChanged(uint position, uint nItems)
connectSectionsChanged
ulong connectSectionsChanged(T callback, Flag!"After" after)

Connect to SectionsChanged signal.