[gtk/view-selection-model-2: 3/3] lists: Clarify rubberband docs



commit 9d61fc9e51be1c970f40c133b895ae55ac79345b
Author: Matthias Clasen <mclasen redhat com>
Date:   Fri Jul 17 08:18:07 2020 -0400

    lists: Clarify rubberband docs
    
    Say that it is only useful to enable rubberbanding
    for multi-selection, and mention GtkMultiSelection
    explicitly.

 gtk/gtkcolumnview.c | 4 ++++
 gtk/gtkgridview.c   | 4 ++++
 gtk/gtklistview.c   | 4 ++++
 3 files changed, 12 insertions(+)
---
diff --git a/gtk/gtkcolumnview.c b/gtk/gtkcolumnview.c
index ed061418f5..6f4b2bd7e1 100644
--- a/gtk/gtkcolumnview.c
+++ b/gtk/gtkcolumnview.c
@@ -1631,6 +1631,10 @@ gtk_column_view_get_reorderable (GtkColumnView *self)
  * @enable_rubberband: %TRUE to enable rubberband selection
  *
  * Sets whether selections can be changed by dragging with the mouse.
+ *
+ * Note that this is only useful when the model you passed to
+ * gtk_list_view_set_model() allows multi-selection (e.g. a
+ * #GtkMultiSelection).
  */
 void
 gtk_column_view_set_enable_rubberband (GtkColumnView *self,
diff --git a/gtk/gtkgridview.c b/gtk/gtkgridview.c
index 713aad664d..d399573def 100644
--- a/gtk/gtkgridview.c
+++ b/gtk/gtkgridview.c
@@ -1438,6 +1438,10 @@ gtk_grid_view_get_single_click_activate (GtkGridView *self)
  * @enable_rubberband: %TRUE to enable rubberband selection
  *
  * Sets whether selections can be changed by dragging with the mouse.
+ *
+ * Note that this is only useful when the model you passed to
+ * gtk_list_view_set_model() allows multi-selection (e.g. a
+ * #GtkMultiSelection).
  */
 void
 gtk_grid_view_set_enable_rubberband (GtkGridView *self,
diff --git a/gtk/gtklistview.c b/gtk/gtklistview.c
index 1e53881c96..5d4a10ded0 100644
--- a/gtk/gtklistview.c
+++ b/gtk/gtklistview.c
@@ -1146,6 +1146,10 @@ gtk_list_view_get_single_click_activate (GtkListView *self)
  * @enable_rubberband: %TRUE to enable rubberband selection
  *
  * Sets whether selections can be changed by dragging with the mouse.
+ *
+ * Note that this is only useful when the model you passed to
+ * gtk_list_view_set_model() allows multi-selection (e.g. a
+ * #GtkMultiSelection).
  */
 void
 gtk_list_view_set_enable_rubberband (GtkListView *self,


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