Package ch.bailu.gtk.gtk

Interface TreeSortable.OnTreeIterCompareFunc

Enclosing class:
TreeSortable
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public static interface TreeSortable.OnTreeIterCompareFunc

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    onTreeIterCompareFunc(CallbackHandler __self, TreeModel model, TreeIter a, TreeIter b, Pointer user_data)
    A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive
    integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b
    respectively.

  • Method Details

    • onTreeIterCompareFunc

      int onTreeIterCompareFunc(CallbackHandler __self, @Nonnull TreeModel model, @Nonnull TreeIter a, @Nonnull TreeIter b, @Nullable Pointer user_data)
      A GtkTreeIterCompareFunc should return a negative integer, zero, or a positive
      integer if @a sorts before @b, @a sorts with @b, or @a sorts after @b
      respectively.

      If two iters compare as equal, their order in the sorted model
      is undefined. In order to ensure that the `GtkTreeSortable` behaves as
      expected, the GtkTreeIterCompareFunc must define a partial order on
      the model, i.e. it must be reflexive, antisymmetric and transitive.

      For example, if @model is a product catalogue, then a compare function
      for the “price” column could be one which returns
      `price_of(@a) - price_of(@b)`.
      Parameters:
      model - The `GtkTreeModel` the comparison is within
      a - A `GtkTreeIter` in @model
      b - Another `GtkTreeIter` in @model
      user_data - Data passed when the compare func is assigned e.g. by gtk_tree_sortable_set_sort_func()
      Returns:
      a negative integer, zero or a positive integer depending on whether @a sorts before, with or after @b