[gtk/matthiasc/for-master: 5/11] docs: Add an example
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/matthiasc/for-master: 5/11] docs: Add an example
- Date: Fri, 17 Jul 2020 01:59:53 +0000 (UTC)
commit 5f33f4ae8ed5582afb5aead418c9a51705f4a023
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Jul 16 19:52:08 2020 -0400
docs: Add an example
Add a small example for setting up columnview sorting.
gtk/gtkcolumnview.c | 21 +++++++++++++++------
1 file changed, 15 insertions(+), 6 deletions(-)
---
diff --git a/gtk/gtkcolumnview.c b/gtk/gtkcolumnview.c
index acaa2b9b07..715b394fc7 100644
--- a/gtk/gtkcolumnview.c
+++ b/gtk/gtkcolumnview.c
@@ -1486,17 +1486,26 @@ gtk_column_view_get_list_view (GtkColumnView *self)
* gtk_column_view_get_sorter:
* @self: a #GtkColumnView
*
- * Returns the sorter associated with users sorting choices in
- * the column view.
+ * Returns a special sorter that reflects the users sorting
+ * choices in the column view.
*
* To allow users to customizable sorting by clicking on column
- * headers, this sorter needs to be set on the sort
- * model(s) underneath the model that is displayed
- * by the view.
+ * headers, this sorter needs to be set on the sort model underneath
+ * the model that is displayed by the view.
*
- * See gtk_column_view_column_get_sorter() for setting up
+ * See gtk_column_view_column_set_sorter() for setting up
* per-column sorting.
*
+ * Here is an example:
+ * |[
+ * gtk_column_view_column_set_sorter (column, sorter);
+ * gtk_column_view_append_column (view, column);
+ * model = gtk_sort_list_model_new (store,
+ * gtk_column_view_get_sorter (view));
+ * selection = gtk_no_selection_new (model);
+ * gtk_column_view_set_model (view, selection);
+ * ]|
+ *
* Returns: (transfer none): the #GtkSorter of @self
*/
GtkSorter *
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]