[gtk/view-selection-model-2: 2/3] lists: Adjust the selection docs



commit dbfbb0374812cfed49aa695f2019f5698f811bf7
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jul 17 08:13:02 2020 -0400

    lists: Adjust the selection docs
    
    Don't mention the auto-created internal selection model.
    It is confusing to mention it, since the state it maintains
    is not easily accessible from the outside, and we want
    users to create their own selection model.

 gtk/gtkcolumnview.c | 11 +++++------
 gtk/gtkgridview.c   | 12 +++++++-----
 gtk/gtklistview.c   | 11 +++++------
 3 files changed, 17 insertions(+), 17 deletions(-)
---
diff --git a/gtk/gtkcolumnview.c b/gtk/gtkcolumnview.c
index 79b725b21c..ed061418f5 100644
--- a/gtk/gtkcolumnview.c
+++ b/gtk/gtkcolumnview.c
@@ -58,10 +58,9 @@
  * separators between the rows or columns.
  *
  * GtkColumnView allows the user to select items according to the selection
- * characteristics of the model. If the provided model is not a #GtkSelectionModel,
- * GtkColumnView will wrap it in a #GtkSingleSelection. For models that allow
- * multiple selected items, it is possible to turn on *rubberband selection*,
- * using #GtkColumnView:enable-rubberband.
+ * characteristics of the model (see #GtkSelectionModel and its implementations).
+ * For models that allow multiple selected items, it is possible to turn on
+ * _rubberband selection_, using #GtkColumnView:enable-rubberband.
  *
  * The column view supports sorting that can be customized by the user by
  * clicking on column headers. To set this up, the #GtkSorter returned by
@@ -1217,8 +1216,8 @@ gtk_column_view_get_model (GtkColumnView *self)
  *
  * Sets the #GListModel to use.
  *
- * If the @model is a #GtkSelectionModel, it is used for managing the selection.
- * Otherwise, @self creates a #GtkSingleSelection for the selection.
+ * If the @model is a #GtkSelectionModel, it is used for managing
+ * the selection.
  **/
 void
 gtk_column_view_set_model (GtkColumnView *self,
diff --git a/gtk/gtkgridview.c b/gtk/gtkgridview.c
index 7138a71aab..713aad664d 100644
--- a/gtk/gtkgridview.c
+++ b/gtk/gtkgridview.c
@@ -55,10 +55,9 @@
  * grid reflows vertically or horizontally.
  *
  * GtkGridView allows the user to select items according to the selection
- * characteristics of the model. If the provided model is not a #GtkSelectionModel,
- * GtkGridView will wrap it in a #GtkSingleSelection. For models that allow
- * multiple selected items, it is possible to turn on _rubberband selection_,
- * using #GtkGridView:enable-rubberband.
+ * characteristics of the model (see #GtkSelectionModel and its implementations).
+ * For models that allow multiple selected items, it is possible to turn on
+ * _rubberband selection_, using #GtkGridView:enable-rubberband.
  *
  * To learn more about the list widget framework, see the [overview](#ListWidget).
  *
@@ -1248,7 +1247,10 @@ gtk_grid_view_get_model (GtkGridView *self)
  * @self: a #GtkGridView
  * @model: (allow-none) (transfer none): the model to use or %NULL for none
  *
- * Sets the #GListModel to use for
+ * Sets the #GListModel to use.
+ *
+ * If the @model is a #GtkSelectionModel, it is used for managing
+ * the selection.
  **/
 void
 gtk_grid_view_set_model (GtkGridView *self,
diff --git a/gtk/gtklistview.c b/gtk/gtklistview.c
index 3a65706ee6..1e53881c96 100644
--- a/gtk/gtklistview.c
+++ b/gtk/gtklistview.c
@@ -54,10 +54,9 @@
  * between the rows.
  *
  * GtkListView allows the user to select items according to the selection
- * characteristics of the model. If the provided model is not a #GtkSelectionModel,
- * GtkListView will wrap it in a #GtkSingleSelection. For models that allow
- * multiple selected items, it is possible to turn on _rubberband selection_,
- * using #GtkListView:enable-rubberband.
+ * characteristics of the model (see #GtkSelectionModel and its implementations).
+ * For models that allow multiple selected items, it is possible to turn on
+ * _rubberband selection_, using #GtkListView:enable-rubberband.
  *
  * If you need multiple columns with headers, see #GtkColumnView.
  *
@@ -1004,8 +1003,8 @@ gtk_list_view_get_model (GtkListView *self)
  *
  * Sets the #GListModel to use.
  *
- * If the @model is a #GtkSelectionModel, it is used for managing the selection.
- * Otherwise, @self creates a #GtkSingleSelection for the selection.
+ * If the @model is a #GtkSelectionModel, it is used for managing
+ * the selection.
  **/
 void
 gtk_list_view_set_model (GtkListView *self,


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