11.131Class GtkTreeModelFilter

A GtkTreeModel which hides parts of an underlying tree model

Class GtkTreeModelFilter( child_model, root )
child_model A GtkTreeModel.
root A GtkTreePath or NULL.

A GtkTreeModelFilter is a tree model which wraps another tree model, and can do the following things:

- Filter specific rows, based on data from a "visible column", a column storing booleans indicating whether the row should be filtered or not, or based on the return value of a "visible function", which gets a model, iter and user_data and returns a boolean indicating whether the row should be filtered or not.

- Modify the "appearance" of the model, using a modify function. This is extremely powerful and allows for just changing some values and also for creating a completely different model based on the given child model.

- Set a different root node, also known as a "virtual root". You can pass in a GtkTreePath indicating the root node for the filter at construction time.

Methods
clear_cacheThis function should almost never be called.
convert_child_iter_to_iterReturns an iterator pointing to the row in filter that corresponds to the row pointed at by child_iter.
convert_child_path_to_pathConverts child_path to a path relative to filter.
convert_iter_to_child_iterReturns an iterator pointing to the row pointed to by filter_iter.
convert_path_to_child_pathConverts filter_path to a path on the child model of filter.
get_modelReturns a pointer to the child model of filter.
refilterEmits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not.
set_visible_columnSets column of the child_model to be the column where filter should look for visibility information.
set_visible_funcSets the visible function used when filtering the filter to be func.

Methods

clear_cache

This function should almost never be called.

GtkTreeModelFilter.clear_cache()

It clears the filter of any cached iterators that haven't been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being filtered is static (and doesn't change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid.

convert_child_iter_to_iter

Returns an iterator pointing to the row in filter that corresponds to the row pointed at by child_iter.

GtkTreeModelFilter.convert_child_iter_to_iter( child_iter )
child_iter A valid GtkTreeIter pointing to a row on the child model.
Returna valid GtkTreeIter pointing to a visible row in child model.
Raise
ParamError if child_iter is invalid

convert_child_path_to_path

Converts child_path to a path relative to filter.

GtkTreeModelFilter.convert_child_path_to_path( child_path )
child_path A GtkTreePath to convert.
ReturnA GtkTreePath, or NULL.

That is, child_path points to a path in the child model. The returned path will point to the same row in the filtered model. If child_path isn't a valid path on the child model or points to a row which is not visible in filter, then NULL is returned.

convert_iter_to_child_iter

Returns an iterator pointing to the row pointed to by filter_iter.

GtkTreeModelFilter.convert_iter_to_child_iter( filter_iter )
filter_iter A valid GtkTreeIter pointing to a row on filter.
Returna GtkTreeIter.

convert_path_to_child_path

Converts filter_path to a path on the child model of filter.

GtkTreeModelFilter.convert_path_to_child_path()

That is, filter_path points to a location in filter. The returned path will point to the same location in the model not being filtered. If filter_path does not point to a location in the child model, NULL is returned.

get_model

Returns a pointer to the child model of filter.

GtkTreeModelFilter.get_model()
Returna GtkTreeModel.

refilter

Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not.

GtkTreeModelFilter.refilter()

set_visible_column

Sets column of the child_model to be the column where filter should look for visibility information.

GtkTreeModelFilter.set_visible_column( column )
column An integer which is the column containing the visible information.

columns should be a column of type G_TYPE_BOOLEAN, where TRUE means that a row is visible, and FALSE if not.

set_visible_func

Sets the visible function used when filtering the filter to be func.

GtkTreeModelFilter.set_visible_func( func, data )
func A GtkTreeModelFilterVisibleFunc, the visible function.
data User data to pass to the visible function, or NULL.

The function should return TRUE if the given row should be visible and FALSE otherwise.

If the condition calculated by the function changes over time (e.g. because it depends on some global parameters), you must call gtk_tree_model_filter_refilter() to keep the visibility information of the model uptodate.

Note that func is called whenever a row is inserted, when it may still be empty. The visible function should therefore take special care of empty rows, like in the example below.

[...]

Made with http://www.falconpl.org