diff --git a/docs/reference/gtk/gtk4-docs.xml b/docs/reference/gtk/gtk4-docs.xml
index b48b7ca008..670d80d49e 100644
--- a/docs/reference/gtk/gtk4-docs.xml
+++ b/docs/reference/gtk/gtk4-docs.xml
@@ -90,6 +90,7 @@
+
diff --git a/docs/reference/gtk/gtk4-sections.txt b/docs/reference/gtk/gtk4-sections.txt
index 3f2597cedf..8123359e5e 100644
--- a/docs/reference/gtk/gtk4-sections.txt
+++ b/docs/reference/gtk/gtk4-sections.txt
@@ -2680,6 +2680,23 @@ GTK_MULTI_SORTER_GET_CLASS
gtk_multi_sorter_get_type
+
+gtktreelistrowsorter
+GtkTreeListRowSorter
+GtkTreeListRowSorter
+gtk_tree_list_row_sorter_new
+gtk_tree_list_row_sorter_get_sorter
+gtk_tree_list_row_sorter_set_sorter
+
+GTK_TREE_LIST_ROW_SORTER
+GTK_IS_TREE_LIST_ROW_SORTER
+GTK_TYPE_TREE_LIST_ROW_SORTER
+GTK_IS_TREE_LIST_ROW_SORTER_CLASS
+GTK_TREE_LIST_ROW_SORTER_GET_CLASS
+
+gtk_tree_list_row_sorter_get_type
+
+
gtksortlistmodel
GtkSortListModel
diff --git a/docs/reference/gtk/gtk4.types.in b/docs/reference/gtk/gtk4.types.in
index aef3e772c6..be5ab6d20c 100644
--- a/docs/reference/gtk/gtk4.types.in
+++ b/docs/reference/gtk/gtk4.types.in
@@ -223,6 +223,7 @@ gtk_tree_drag_dest_get_type
gtk_tree_drag_source_get_type
gtk_tree_list_model_get_type
gtk_tree_list_row_get_type
+gtk_tree_list_row_sorter_get_type
gtk_tree_model_filter_get_type
gtk_tree_model_get_type
gtk_tree_model_sort_get_type
diff --git a/gtk/gtk.h b/gtk/gtk.h
index 7651a2b390..bea638962a 100644
--- a/gtk/gtk.h
+++ b/gtk/gtk.h
@@ -257,6 +257,7 @@
#include
#include
#include
+#include
#include
#include
#include
diff --git a/gtk/gtktreelistrowsorter.c b/gtk/gtktreelistrowsorter.c
new file mode 100644
index 0000000000..bd7d7ee6b4
--- /dev/null
+++ b/gtk/gtktreelistrowsorter.c
@@ -0,0 +1,329 @@
+/*
+ * Copyright © 2019 Matthias Clasen
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see .
+ *
+ * Authors: Matthias Clasen
+ */
+
+#include "config.h"
+
+#include "gtktreelistrowsorter.h"
+
+#include "gtktreelistmodel.h"
+
+#include "gtkintl.h"
+#include "gtktypebuiltins.h"
+
+/**
+ * SECTION:gtktreelistrowsorter
+ * @title: GtkTreeListRowSorter
+ * @Short_description: Sort trees by levels
+ * @See_also: #GtkTreeListModel
+ *
+ * #GtkTreeListRowSorter is a special-purpose sorter that will apply a given
+ * sorter to the levels in a tree, while respecting the tree structure.
+ *
+ * Here is an example for setting up a column view with a tree model and
+ * a GtkTreeListSorter:
+ *
+ * |[
+ * sorter = gtk_tree_list_row_sorter_new (gtk_column_view_get_sorter (view));
+ * sort_model = gtk_sort_list_model_new (tree_model, sorter);
+ * selection = gtk_single_selection_new (sort_model);
+ * gtk_column_view_set_model (view, G_LIST_MODEL (selection));
+ * ]|
+ */
+
+struct _GtkTreeListRowSorter
+{
+ GtkSorter parent_instance;
+
+ GtkSorter *sorter;
+};
+
+enum {
+ PROP_0,
+ PROP_SORTER,
+ NUM_PROPERTIES
+};
+
+static GParamSpec *properties[NUM_PROPERTIES] = { NULL, };
+
+G_DEFINE_TYPE (GtkTreeListRowSorter, gtk_tree_list_row_sorter, GTK_TYPE_SORTER)
+
+static GtkOrdering
+gtk_tree_list_row_sorter_compare (GtkSorter *sorter,
+ gpointer item1,
+ gpointer item2)
+{
+ GtkTreeListRowSorter *self = GTK_TREE_LIST_ROW_SORTER (sorter);
+ GtkTreeListRow *r1, *r2;
+ GtkTreeListRow *p1, *p2;
+ guint d1, d2;
+ GtkOrdering result = GTK_ORDERING_EQUAL;
+
+ /* break ties here so we really are a total order */
+ if (!GTK_IS_TREE_LIST_ROW (item1))
+ return GTK_IS_TREE_LIST_ROW (item2) ? GTK_ORDERING_LARGER : (item1 < item2 ? GTK_ORDERING_SMALLER : GTK_ORDERING_LARGER);
+ else if (!GTK_IS_TREE_LIST_ROW (item2))
+ return GTK_ORDERING_SMALLER;
+
+ r1 = GTK_TREE_LIST_ROW (item1);
+ r2 = GTK_TREE_LIST_ROW (item2);
+
+ g_object_ref (r1);
+ g_object_ref (r2);
+
+ d1 = gtk_tree_list_row_get_depth (r1);
+ d2 = gtk_tree_list_row_get_depth (r2);
+
+ /* First, get to the same depth */
+ while (d1 > d2)
+ {
+ p1 = gtk_tree_list_row_get_parent (r1);
+ g_object_unref (r1);
+ r1 = p1;
+ d1--;
+ result = GTK_ORDERING_LARGER;
+ }
+ while (d2 > d1)
+ {
+ p2 = gtk_tree_list_row_get_parent (r2);
+ g_object_unref (r2);
+ r2 = p2;
+ d2--;
+ result = GTK_ORDERING_SMALLER;
+ }
+
+ /* Now walk up until we find a common parent */
+ if (r1 != r2)
+ {
+ while (TRUE)
+ {
+ p1 = gtk_tree_list_row_get_parent (r1);
+ p2 = gtk_tree_list_row_get_parent (r2);
+ if (p1 == p2)
+ {
+ gpointer obj1 = gtk_tree_list_row_get_item (r1);
+ gpointer obj2 = gtk_tree_list_row_get_item (r2);
+
+ if (self->sorter == NULL)
+ result = GTK_ORDERING_EQUAL;
+ else
+ result = gtk_sorter_compare (self->sorter, obj1, obj2);
+
+ /* We must break ties here because if r1 ever gets a child,
+ * it would need to go right inbetween r1 and r2. */
+ if (result == GTK_ORDERING_EQUAL)
+ {
+ if (gtk_tree_list_row_get_position (r1) < gtk_tree_list_row_get_position (r2))
+ result = GTK_ORDERING_SMALLER;
+ else
+ result = GTK_ORDERING_LARGER;
+ }
+
+ g_object_unref (obj1);
+ g_object_unref (obj2);
+
+ break;
+ }
+ else
+ {
+ g_object_unref (r1);
+ r1 = p1;
+ g_object_unref (r2);
+ r2 = p2;
+ }
+ }
+ }
+
+ g_object_unref (r1);
+ g_object_unref (r2);
+
+ return result;
+}
+
+static GtkSorterOrder
+gtk_tree_list_row_sorter_get_order (GtkSorter *sorter)
+{
+ /* Must be a total order, because we need an exact position where new items go */
+ return GTK_SORTER_ORDER_TOTAL;
+}
+
+static void
+propagate_changed (GtkSorter *sorter, GtkSorterChange change, gpointer data)
+{
+ gtk_sorter_changed (GTK_SORTER (data), change);
+}
+
+static void
+gtk_tree_list_row_sorter_dispose (GObject *object)
+{
+ GtkTreeListRowSorter *self = GTK_TREE_LIST_ROW_SORTER (object);
+
+ if (self->sorter)
+ g_signal_handlers_disconnect_by_func (self->sorter, propagate_changed, self);
+ g_clear_object (&self->sorter);
+
+ G_OBJECT_CLASS (gtk_tree_list_row_sorter_parent_class)->dispose (object);
+}
+
+static void
+gtk_tree_list_row_sorter_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec)
+{
+ GtkTreeListRowSorter *self = GTK_TREE_LIST_ROW_SORTER (object);
+
+ switch (prop_id)
+ {
+ case PROP_SORTER:
+ gtk_tree_list_row_sorter_set_sorter (self, GTK_SORTER (g_value_get_object (value)));
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gtk_tree_list_row_sorter_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec)
+{
+ GtkTreeListRowSorter *self = GTK_TREE_LIST_ROW_SORTER (object);
+
+ switch (prop_id)
+ {
+ case PROP_SORTER:
+ g_value_set_object (value, self->sorter);
+ break;
+
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+ break;
+ }
+}
+
+static void
+gtk_tree_list_row_sorter_class_init (GtkTreeListRowSorterClass *class)
+{
+ GtkSorterClass *sorter_class = GTK_SORTER_CLASS (class);
+ GObjectClass *object_class = G_OBJECT_CLASS (class);
+
+ sorter_class->compare = gtk_tree_list_row_sorter_compare;
+ sorter_class->get_order = gtk_tree_list_row_sorter_get_order;
+
+ object_class->dispose = gtk_tree_list_row_sorter_dispose;
+ object_class->set_property = gtk_tree_list_row_sorter_set_property;
+ object_class->get_property = gtk_tree_list_row_sorter_get_property;
+
+ /**
+ * GtkTreeListRowSorter:sorter:
+ *
+ * The underlying sorter
+ */
+ properties[PROP_SORTER] =
+ g_param_spec_object ("sorter",
+ P_("Sorter"),
+ P_("The underlying sorter"),
+ GTK_TYPE_SORTER,
+ G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_EXPLICIT_NOTIFY);
+
+ g_object_class_install_properties (object_class, NUM_PROPERTIES, properties);
+}
+
+static void
+gtk_tree_list_row_sorter_init (GtkTreeListRowSorter *self)
+{
+}
+
+/**
+ * gtk_tree_list_row_sorter_new:
+ * @sorter: (nullable) (transfer full): a #GtkSorter, or %NULL
+ *
+ * Create a special-purpose sorter that applies the sorting
+ * of @sorter to the levels of a #GtkTreeListModel.
+ *
+ * Note that this sorter relies on #GtkTreeListModel:passthrough
+ * being %FALSE as it can only sort #GtkTreeListRows.
+ *
+ * Returns: a new #GtkSorter
+ */
+GtkSorter *
+gtk_tree_list_row_sorter_new (GtkSorter *sorter)
+{
+ GtkSorter *result;
+
+ g_return_val_if_fail (sorter == NULL || GTK_IS_SORTER (sorter), NULL);
+
+ result = g_object_new (GTK_TYPE_TREE_LIST_ROW_SORTER,
+ "sorter", sorter,
+ NULL);
+
+ g_clear_object (&sorter);
+
+ return result;
+}
+
+/**
+ * gtk_tree_list_row_sorter_set_sorter:
+ * @self: a #GtkTreeListRowSorter
+ * @sorter: (nullable) (transfer none): The sorter to use, or %NULL
+ *
+ * Sets the sorter to use for items with the same parent.
+ *
+ * This sorter will be passed the #GtkTreeListRow:item of the tree
+ * list rows passed to @self.
+ **/
+void
+gtk_tree_list_row_sorter_set_sorter (GtkTreeListRowSorter *self,
+ GtkSorter *sorter)
+{
+ g_return_if_fail (GTK_IS_TREE_LIST_ROW_SORTER (self));
+ g_return_if_fail (sorter == NULL || GTK_IS_SORTER (sorter));
+
+ if (self->sorter == sorter)
+ return;
+
+ if (self->sorter)
+ g_signal_handlers_disconnect_by_func (self->sorter, propagate_changed, self);
+ g_set_object (&self->sorter, sorter);
+ if (self->sorter)
+ g_signal_connect (sorter, "changed", G_CALLBACK (propagate_changed), self);
+
+ gtk_sorter_changed (GTK_SORTER (self), GTK_SORTER_CHANGE_DIFFERENT);
+
+ g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_SORTER]);
+}
+
+/**
+ * gtk_tree_list_row_sorter_get_sorter:
+ * @self: a #GtkTreeListRowSorter
+ *
+ * Returns the sorter used by @self.
+ *
+ * Returns: (transfer none) (nullable): the sorter used
+ **/
+GtkSorter *
+gtk_tree_list_row_sorter_get_sorter (GtkTreeListRowSorter *self)
+{
+ g_return_val_if_fail (GTK_IS_TREE_LIST_ROW_SORTER (self), NULL);
+
+ return self->sorter;
+}
diff --git a/gtk/gtktreelistrowsorter.h b/gtk/gtktreelistrowsorter.h
new file mode 100644
index 0000000000..8f2db0e51a
--- /dev/null
+++ b/gtk/gtktreelistrowsorter.h
@@ -0,0 +1,47 @@
+/*
+ * Copyright © 2019 Matthias Clasen
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see .
+ *
+ * Authors: Matthias Clasen
+ */
+
+#ifndef __GTK_TREE_LIST_ROW_SORTER_H__
+#define __GTK_TREE_LIST_ROW_SORTER_H__
+
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#error "Only can be included directly."
+#endif
+
+#include
+#include
+
+G_BEGIN_DECLS
+
+#define GTK_TYPE_TREE_LIST_ROW_SORTER (gtk_tree_list_row_sorter_get_type ())
+GDK_AVAILABLE_IN_ALL
+G_DECLARE_FINAL_TYPE (GtkTreeListRowSorter, gtk_tree_list_row_sorter, GTK, TREE_LIST_ROW_SORTER, GtkSorter)
+
+GDK_AVAILABLE_IN_ALL
+GtkSorter * gtk_tree_list_row_sorter_new (GtkSorter *sorter);
+
+GDK_AVAILABLE_IN_ALL
+GtkSorter * gtk_tree_list_row_sorter_get_sorter (GtkTreeListRowSorter *self);
+GDK_AVAILABLE_IN_ALL
+void gtk_tree_list_row_sorter_set_sorter (GtkTreeListRowSorter *self,
+ GtkSorter *sorter);
+
+G_END_DECLS
+
+#endif /* __GTK_TREE_LIST_ROW_SORTER_H__ */
diff --git a/gtk/meson.build b/gtk/meson.build
index f53667a891..6c02f597d4 100644
--- a/gtk/meson.build
+++ b/gtk/meson.build
@@ -402,6 +402,7 @@ gtk_public_sources = files([
'gtktreednd.c',
'gtktreeexpander.c',
'gtktreelistmodel.c',
+ 'gtktreelistrowsorter.c',
'gtktreemodel.c',
'gtktreemodelfilter.c',
'gtktreemodelsort.c',
@@ -657,6 +658,7 @@ gtk_public_headers = files([
'gtktreednd.h',
'gtktreeexpander.h',
'gtktreelistmodel.h',
+ 'gtktreelistrowsorter.h',
'gtktreemodel.h',
'gtktreemodelfilter.h',
'gtktreemodelsort.h',
diff --git a/tests/testcolumnview.c b/tests/testcolumnview.c
index bb49622313..0b6e8a749e 100644
--- a/tests/testcolumnview.c
+++ b/tests/testcolumnview.c
@@ -677,6 +677,8 @@ main (int argc, char *argv[])
GtkTreeListModel *tree;
GtkFilterListModel *filter;
GtkFilter *custom_filter;
+ GtkSortListModel *sort;
+ GtkSorter *sorter;
GFile *root;
GtkBuilderScope *scope;
GtkBuilder *builder;
@@ -727,8 +729,11 @@ main (int argc, char *argv[])
g_object_unref (dirmodel);
g_object_unref (root);
+ sorter = gtk_tree_list_row_sorter_new (g_object_ref (gtk_column_view_get_sorter (GTK_COLUMN_VIEW (view))));
+ sort = gtk_sort_list_model_new (G_LIST_MODEL (tree), sorter);
+
custom_filter = gtk_custom_filter_new (match_file, g_object_ref (search_entry), g_object_unref);
- filter = gtk_filter_list_model_new (G_LIST_MODEL (tree), custom_filter);
+ filter = gtk_filter_list_model_new (G_LIST_MODEL (sort), custom_filter);
g_signal_connect (search_entry, "search-changed", G_CALLBACK (search_changed_cb), custom_filter);
g_object_unref (custom_filter);
@@ -742,6 +747,7 @@ main (int argc, char *argv[])
gtk_box_append (GTK_BOX (vbox), statusbar);
g_object_unref (filter);
+ g_object_unref (sort);
g_object_unref (tree);
list = gtk_list_view_new_with_factory (