list box: Document incompatible configurations

Explain in the docs that using a model is incompatible with
using filter or sort functions.

http://bugzilla.gnome.org/show_bug.cgi?id=752615
This commit is contained in:
Matthias Clasen 2015-08-25 13:20:53 -04:00
parent a27309c6e4
commit 808ea8645a

View File

@ -1083,6 +1083,9 @@ gtk_list_box_get_selection_mode (GtkListBox *box)
* continue to be called each time a row changes (via gtk_list_box_row_changed()) or
* when gtk_list_box_invalidate_filter() is called.
*
* Note that using a filter function is incompatible with using a model
* (see gtk_list_box_bind_model()).
*
* Since: 3.10
*/
void
@ -1281,6 +1284,9 @@ gtk_list_box_invalidate_headers (GtkListBox *box)
* be called each time a row changes (via gtk_list_box_row_changed()) and when
* gtk_list_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.10
*/
void
@ -3764,6 +3770,10 @@ gtk_list_box_check_model_compat (GtkListBox *box)
* gtk_list_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 GtkListBox. When using a model, filtering and sorting
* should be implemented by the model.
*
* Since: 3.16
*/
void