Gtk.SortListModel – gtk4 – Vala Binding Reference

Description:

[ CCode ( type_id = "gtk_sort_list_model_get_type ()" ) ]
public class SortListModel : Object, ListModel

A `GListModel` that sorts the elements of an underlying model according to a `GtkSorter`.

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 `GtkMultiSorter` 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 [ [email protected]_incremental] for details.

`GtkSortListModel` 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 `GtkSortListModel`, it is strongly recommended that you write your own sorting list model.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public bool incremental { get; set; }

If the model should sort items incrementally.

public Type item_type { get; }

The type of items.

public ListModel model { get; set; }

The model being sorted.

public uint n_items { get; }

The number of items.

public uint pending { get; }

Estimate of unsorted items remaining.

public Sorter sorter { get; set; }

The sorter for this model.

Creation methods:

public SortListModel (owned ListModel? model, owned Sorter? sorter)

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

Methods:

public bool get_incremental ()

Returns whether incremental sorting is enabled.

public unowned ListModel? get_model ()

Gets the model currently sorted or null if none.

public uint get_pending ()

Estimates progress of an ongoing sorting operation.

public unowned Sorter? get_sorter ()

Gets the sorter that is used to sort this .

public void set_incremental (bool incremental)

Sets the sort model to do an incremental sort.

public void set_model (ListModel? model)

Sets the model to be sorted.

public void set_sorter (Sorter? sorter)

Sets a new sorter on this.

Inherited Members:

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface GLib.ListModel

get_item
get_item_type

get_n_items
get_object

items_changed