[gtk+] flow box: Document incompatible configurations



commit 9cc41307d1c0ced7de427bf12aa44f5455caf45c
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Aug 25 13:58:40 2015 -0400

    flow box: Document incompatible configurations
    
    Explain in the docs that using a model is incompatible with
    using filter or sort functions.

 gtk/gtkflowbox.c |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkflowbox.c b/gtk/gtkflowbox.c
index 6b6611e..c19130e 100644
--- a/gtk/gtkflowbox.c
+++ b/gtk/gtkflowbox.c
@@ -4287,6 +4287,10 @@ gtk_flow_box_check_model_compat (GtkFlowBox *box)
  * gtk_flow_box_insert() or gtk_container_add()) while @box is bound to a
  * model.
  *
+ * Note that using a model is incompatible with the filtering and sorting
+ * functionality in GtkFlowBox. When using a model, filtering and sorting
+ * should be implemented by the model.
+ *
  * Since: 3.18
  */
 void
@@ -4853,6 +4857,9 @@ gtk_flow_box_get_selection_mode (GtkFlowBox *box)
  * gtk_flow_box_child_changed()) or when gtk_flow_box_invalidate_filter()
  * is called.
  *
+ * Note that using a filter function is incompatible with using a model
+ * (see gtk_flow_box_bind_model()).
+ *
  * Since: 3.12
  */
 void
@@ -4935,6 +4942,9 @@ gtk_flow_box_invalidate_filter (GtkFlowBox *box)
  * gtk_flow_box_child_changed()) and when gtk_flow_box_invalidate_sort()
  * is called.
  *
+ * + * Note that using a sort function is incompatible with using a model
+ * + * (see gtk_list_box_bind_model()).
+ *
  * Since: 3.12
  */
 void


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