flow box: Document incompatible configurations

Explain in the docs that using a model is incompatible with
using filter or sort functions.
This commit is contained in:
Matthias Clasen 2015-08-25 13:58:40 -04:00
parent c099859872
commit 9cc41307d1

View File

@ -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 * gtk_flow_box_insert() or gtk_container_add()) while @box is bound to a
* model. * 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 * Since: 3.18
*/ */
void 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() * gtk_flow_box_child_changed()) or when gtk_flow_box_invalidate_filter()
* is called. * is called.
* *
* Note that using a filter function is incompatible with using a model
* (see gtk_flow_box_bind_model()).
*
* Since: 3.12 * Since: 3.12
*/ */
void void
@ -4935,6 +4942,9 @@ gtk_flow_box_invalidate_filter (GtkFlowBox *box)
* gtk_flow_box_child_changed()) and when gtk_flow_box_invalidate_sort() * gtk_flow_box_child_changed()) and when gtk_flow_box_invalidate_sort()
* is called. * is called.
* *
* + * Note that using a sort function is incompatible with using a model
* + * (see gtk_list_box_bind_model()).
*
* Since: 3.12 * Since: 3.12
*/ */
void void