Package ch.bailu.gtk.gtk

Class SortListModel

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gtk.SortListModel
All Implemented Interfaces:
PointerInterface
public class SortListModel extends Object
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
[method@Gtk.SortListModel.set_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.

https://docs.gtk.org/gtk4/class.SortListModel.html

  • Constructor Details

    • SortListModel

      public SortListModel(PointerContainer pointer)

    • SortListModel

      public SortListModel(@Nullable ListModel model, @Nullable Sorter sorter)
      Creates a new sort list model that uses the @sorter to sort @model.
      Parameters:
      model - the model to sort
      sorter - the `GtkSorter` to sort @model with,

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • getIncremental

      public boolean getIncremental()
      Returns whether incremental sorting is enabled.

      See [method@Gtk.SortListModel.set_incremental].
      Returns:
      %TRUE if incremental sorting is enabled

    • getModel

      public ListModel getModel()
      Gets the model currently sorted or %NULL if none.
      Returns:
      The model that gets sorted

    • getPending

      public int getPending()
      Estimates progress of an ongoing sorting operation.

      The estimate is the number of items that would still need to be
      sorted to finish the sorting operation if this was a linear
      algorithm. So this number is not related to how many items are
      already correctly sorted.

      If you want to estimate the progress, you can use code like this:
      ```c
      pending = gtk_sort_list_model_get_pending (self);
      model = gtk_sort_list_model_get_model (self);
      progress = 1.0 - pending / (double) MAX (1, g_list_model_get_n_items (model));
      ```

      If no sort operation is ongoing - in particular when
      [property@Gtk.SortListModel:incremental] is %FALSE - this
      function returns 0.
      Returns:
      a progress estimate of remaining items to sort

    • getSorter

      public Sorter getSorter()
      Gets the sorter that is used to sort @self.
      Returns:
      the sorter of #self

    • setIncremental

      public void setIncremental(boolean incremental)
      Sets the sort model to do an incremental sort.

      When incremental sorting is enabled, the `GtkSortListModel` will not do
      a complete sort immediately, but will instead queue an idle handler that
      incrementally sorts the items towards their correct position. This of
      course means that items do not instantly appear in the right place. It
      also means that the total sorting time is a lot slower.

      When your filter blocks the UI while sorting, you might consider
      turning this on. Depending on your model and sorters, this may become
      interesting around 10,000 to 100,000 items.

      By default, incremental sorting is disabled.

      See [method@Gtk.SortListModel.get_pending] for progress information
      about an ongoing incremental sorting operation.
      Parameters:
      incremental - %TRUE to sort incrementally

    • setModel

      public void setModel(@Nullable ListModel model)
      Sets the model to be sorted.

      The @model's item type must conform to the item type of @self.
      Parameters:
      model - The model to be sorted

    • setSorter

      public void setSorter(@Nullable Sorter sorter)
      Sets a new sorter on @self.
      Parameters:
      sorter - the `GtkSorter` to sort @model with

    • asListModel

      public ListModel asListModel()
      Implements interface ListModel. Call this to get access to interface functions.
      Returns:
      ListModel

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()