class Gtk::TreeModelFilter

• Gtk::TreeModelFilter
• GObject::Object
• Reference
• Object

Overview

A Gtk::TreeModel which hides parts of an underlying tree model

A Gtk::TreeModelFilter 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 Gtk::TreePath indicating the root node for the filter at construction time.

The basic API is similar to Gtk::TreeModelSort. For an example on its usage, see the section on Gtk::TreeModelSort.

When using Gtk::TreeModelFilter, it is important to realize that Gtk::TreeModelFilter maintains an internal cache of all nodes which are visible in its clients. The cache is likely to be a subtree of the tree exposed by the child model. Gtk::TreeModelFilter will not cache the entire child model when unnecessary to not compromise the caching mechanism that is exposed by the reference counting scheme. If the child model implements reference counting, unnecessary signals may not be emitted because of reference counting rule 3, see the Gtk::TreeModel documentation. (Note that e.g. Gtk::TreeStore does not implement reference counting and will always emit all signals, even when the receiving node is not visible).

Because of this, limitations for possible visible functions do apply. In general, visible functions should only use data or properties from the node for which the visibility state must be determined, its siblings or its parents. Usually, having a dependency on the state of any child node is not possible, unless references are taken on these explicitly. When no such reference exists, no signals may be received for these child nodes (see reference counting rule number 3 in the Gtk::TreeModel section).

Determining the visibility state of a given node based on the state of its child nodes is a frequently occurring use case. Therefore, Gtk::TreeModelFilter explicitly supports this. For example, when a node does not have any children, you might not want the node to be visible. As soon as the first row is added to the node’s child level (or the last row removed), the node’s visibility should be updated.

This introduces a dependency from the node on its child nodes. In order to accommodate this, Gtk::TreeModelFilter must make sure the necessary signals are received from the child model. This is achieved by building, for all nodes which are exposed as visible nodes to Gtk::TreeModelFilter's clients, the child level (if any) and take a reference on the first node in this level. Furthermore, for every row-inserted, row-changed or row-deleted signal (also these which were not handled because the node was not cached), Gtk::TreeModelFilter will check if the visibility state of any parent node has changed.

Beware, however, that this explicit support is limited to these two cases. For example, if you want a node to be visible only if two nodes in a child’s child level (2 levels deeper) are visible, you are on your own. In this case, either rely on Gtk::TreeStore to emit all signals because it does not implement reference counting, or for models that do implement reference counting, obtain references on these child levels yourself.

Included Modules

• Gtk::TreeDragSource
• Gtk::TreeModel

Defined in:

Constructors

• .new

  Initialize a new TreeModelFilter.

• .new(*, child_model : Gtk::TreeModel | Nil = nil, virtual_root : Gtk::TreePath | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #child_model : Gtk::TreeModel | Nil
• #child_model=(value : Gtk::TreeModel | Nil) : Gtk::TreeModel | Nil
• #clear_cache : Nil

  This function should almost never be called.

• #convert_child_iter_to_iter(child_iter : Gtk::TreeIter) : Gtk::TreeIter

  Sets filter_iter to point to the row in filter that corresponds to the row pointed at by child_iter.

• #convert_child_path_to_path(child_path : Gtk::TreePath) : Gtk::TreePath | Nil

  Converts child_path to a path relative to filter.

• #convert_iter_to_child_iter(filter_iter : Gtk::TreeIter) : Gtk::TreeIter

  Sets child_iter to point to the row pointed to by filter_iter.

• #convert_path_to_child_path(filter_path : Gtk::TreePath) : Gtk::TreePath | Nil

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

• #hash(hasher)

  See Object#hash(hasher)

• #model : Gtk::TreeModel

  Returns a pointer to the child model of filter.

• #refilter : Nil

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

• #set_modify_func(types : Enumerable(UInt64), func : Gtk::TreeModelFilterModifyFunc) : Nil

  With the n_columns and types parameters, you give an array of column types for this model (which will be exposed to the parent model/view).

• #virtual_root : Gtk::TreePath | Nil
• #virtual_root=(value : Gtk::TreePath | Nil) : Gtk::TreePath | Nil
• #visible_column=(column : Int32) : Nil

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

• #visible_func=(func : Gtk::TreeModelFilterVisibleFunc) : Nil

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

Constructor Detail

Class Method Detail

Instance Method Detail