Class TreeModelSort

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gtk.TreeModelSort
All Implemented Interfaces:
TreeDragSource, TreeModel, TreeSortable, Proxy
@Generated("org.javagi.JavaGI") @Deprecated public class TreeModelSort extends GObject implements TreeDragSource, TreeModel, TreeSortable
Deprecated.
Use SortListModel instead

A GtkTreeModel which makes an underlying tree model sortable

The GtkTreeModelSort is a model which implements the GtkTreeSortable interface. It does not hold any data itself, but rather is created with a child model and proxies its data. It has identical column types to this child model, and the changes in the child are propagated. The primary purpose of this model is to provide a way to sort a different model without modifying it. Note that the sort function used by GtkTreeModelSort is not guaranteed to be stable.

The use of this is best demonstrated through an example. In the following sample code we create two GtkTreeView widgets each with a view of the same data. As the model is wrapped here by a GtkTreeModelSort, the two GtkTreeViews can each sort their view of the data without affecting the other. By contrast, if we simply put the same model in each widget, then sorting the first would sort the second.

Using a GtkTreeModelSort

{
  GtkTreeView *tree_view1;
  GtkTreeView *tree_view2;
  GtkTreeModel *sort_model1;
  GtkTreeModel *sort_model2;
  GtkTreeModel *child_model;

  // get the child model
  child_model = get_my_model ();

  // Create the first tree
  sort_model1 = gtk_tree_model_sort_new_with_model (child_model);
  tree_view1 = gtk_tree_view_new_with_model (sort_model1);

  // Create the second tree
  sort_model2 = gtk_tree_model_sort_new_with_model (child_model);
  tree_view2 = gtk_tree_view_new_with_model (sort_model2);

  // Now we can sort the two models independently
  gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model1),
                                        COLUMN_1, GTK_SORT_ASCENDING);
  gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model2),
                                        COLUMN_1, GTK_SORT_DESCENDING);
}

To demonstrate how to access the underlying child model from the sort model, the next example will be a callback for the GtkTreeSelection GtkTreeSelection::changed signal. In this callback, we get a string from COLUMN_1 of the model. We then modify the string, find the same selected row on the child model, and change the row there.

Accessing the child model of in a selection changed callback

void
selection_changed (GtkTreeSelection *selection, gpointer data)
{
  GtkTreeModel *sort_model = NULL;
  GtkTreeModel *child_model;
  GtkTreeIter sort_iter;
  GtkTreeIter child_iter;
  char *some_data = NULL;
  char *modified_data;

  // Get the current selected row and the model.
  if (! gtk_tree_selection_get_selected (selection,
                                         &sort_model,
                                         &sort_iter))
    return;

  // Look up the current value on the selected row and get
  // a new value to change it to.
  gtk_tree_model_get (GTK_TREE_MODEL (sort_model), &sort_iter,
                      COLUMN_1, &some_data,
                      -1);

  modified_data = change_the_data (some_data);
  g_free (some_data);

  // Get an iterator on the child model, instead of the sort model.
  gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (sort_model),
                                                  &child_iter,
                                                  &sort_iter);

  // Get the child model and change the value of the row. In this
  // example, the child model is a GtkListStore. It could be any other
  // type of model, though.
  child_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (sort_model));
  gtk_list_store_set (GTK_LIST_STORE (child_model), &child_iter,
                      COLUMN_1, &modified_data,
                      -1);
  g_free (modified_data);
}

  • Constructor Details

    • TreeModelSort

      public TreeModelSort(MemorySegment address)
      Deprecated.
      Create a TreeModelSort instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • TreeModelSort

      public TreeModelSort()
      Deprecated.
      Create a new TreeModelSort.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Deprecated.
      Get the GType of the TreeModelSort class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      Deprecated.
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected TreeModelSort asParent()
      Deprecated.
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • withModel

      public static TreeModelSort withModel(TreeModel childModel)
      Deprecated.
      Creates a new GtkTreeModelSort, with childModel as the child model.
      Parameters:
      childModel - A GtkTreeModel
      Returns:
      A new GtkTreeModelSort.

    • clearCache

      @Deprecated public void clearCache()
      Deprecated.
      This function should almost never be called. It clears the this TreeModelSort of any cached iterators that haven’t been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being sorted is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid.

    • convertChildIterToIter

      @Deprecated public boolean convertChildIterToIter(TreeIter sortIter, TreeIter childIter)
      Deprecated.
      Sets sortIter to point to the row in this TreeModelSort that corresponds to the row pointed at by childIter. If sortIter was not set, false is returned. Note: a boolean is only returned since 2.14.
      Parameters:
      sortIter - An uninitialized GtkTreeIter
      childIter - A valid GtkTreeIter pointing to a row on the child model
      Returns:
      true, if sortIter was set, i.e. if sortIter is a valid iterator pointer to a visible row in the child model.

    • convertChildPathToPath

      @Deprecated public @Nullable TreePath convertChildPathToPath(TreePath childPath)
      Deprecated.
      Converts childPath to a path relative to treeModelSort. That is, childPath points to a path in the child model. The returned path will point to the same row in the sorted model. If childPath isn’t a valid path on the child model, then null is returned.
      Parameters:
      childPath - A GtkTreePath to convert
      Returns:
      A newly allocated GtkTreePath

    • convertIterToChildIter

      @Deprecated public void convertIterToChildIter(TreeIter childIter, TreeIter sortedIter)
      Deprecated.
      Sets childIter to point to the row pointed to by sortedIter.
      Parameters:
      childIter - An uninitialized GtkTreeIter
      sortedIter - A valid GtkTreeIter pointing to a row on treeModelSort.

    • convertPathToChildPath

      @Deprecated public @Nullable TreePath convertPathToChildPath(TreePath sortedPath)
      Deprecated.
      Converts sortedPath to a path on the child model of treeModelSort. That is, sortedPath points to a location in treeModelSort. The returned path will point to the same location in the model not being sorted. If sortedPath does not point to a location in the child model, null is returned.
      Parameters:
      sortedPath - A GtkTreePath to convert
      Returns:
      A newly allocated GtkTreePath

    • getModel

      public TreeModel getModel()
      Deprecated.
      Returns the model the GtkTreeModelSort is sorting.
      Returns:
      the "child model" being sorted

    • iterIsValid

      @Deprecated public boolean iterIsValid(TreeIter iter)
      Deprecated.

      This function is slow. Only use it for debugging and/or testing purposes.

      Checks if the given iter is a valid iter for this GtkTreeModelSort.

      Parameters:
      iter - A GtkTreeIter
      Returns:
      true if the iter is valid, false if the iter is invalid.

    • resetDefaultSortFunc

      @Deprecated public void resetDefaultSortFunc()
      Deprecated.
      This resets the default sort function to be in the “unsorted” state. That is, it is in the same order as the child model. It will re-sort the model to be in the same order as the child model only if the GtkTreeModelSort is in “unsorted” state.

    • builder

      public static TreeModelSort.Builder<? extends TreeModelSort.Builder> builder()
      Deprecated.
      A TreeModelSort.Builder object constructs a TreeModelSort with the specified properties. Use the various set...() methods to set properties, and finish construction with TreeModelSort.Builder.build().
      Returns:
      the builder object