[gtk/prop-list: 86/113] column view: Document sorting



commit 81a7ca813f6174cad4e0c30b5e23dab61c9b8e7f
Author: Matthias Clasen <mclasen redhat com>
Date:   Sun Dec 15 20:57:56 2019 -0500

    column view: Document sorting
    
    Add a paragraph outlining how sorting is set up
    for GtkColumnView.

 gtk/gtkcolumnview.c | 6 ++++++
 1 file changed, 6 insertions(+)
---
diff --git a/gtk/gtkcolumnview.c b/gtk/gtkcolumnview.c
index b36fd09808..9d3bf91299 100644
--- a/gtk/gtkcolumnview.c
+++ b/gtk/gtkcolumnview.c
@@ -43,6 +43,12 @@
  *
  * GtkColumnView is a widget to present a view into a large dynamic list of items
  * using multiple columns.
+ *
+ * It supports sorting that can be customized by the user by clicking on column
+ * view headers. To set this up, the #GtkSorter returned by gtk_column_view_get_sorter()
+ * must be attached to a sort model for the data that the view is showing, and the
+ * columns must have sorters attached to them by calling gtk_column_view_column_set_sorter().
+ * The initial sort order can be set with gtk_column_view_sort_by_column().
  */
 
 struct _GtkColumnView


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]