TreeModelFilter

open class TreeModelFilter(pointer: <Error class: unknown class><<Error class: unknown class>>) : TreeDragSource, TreeModel

A GtkTreeModel which hides parts of an underlying tree model

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.

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

When using GtkTreeModelFilter, it is important to realize that GtkTreeModelFilter 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. GtkTreeModelFilter 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 GtkTreeModel documentation. (Note that e.g. GtkTreeStore 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 GtkTreeModel section).

Determining the visibility state of a given node based on the state of its child nodes is a frequently occurring use case. Therefore, GtkTreeModelFilter 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, GtkTreeModelFilter 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 GtkTreeModelFilter'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), GtkTreeModelFilter 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 GtkTreeStore 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.

Skipped during bindings generation

  • parameter types: Array parameter of type GType is not supported

  • method child-model: Property has no getter nor setter

  • method virtual-root: Property has no getter nor setter

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val gtkTreeDragSourcePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val gtkTreeModelFilterPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkTreeModelPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun clearCache()

This function should almost never be called. 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.

Link copied to clipboard
open fun connectRowChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter) -> Unit): <Error class: unknown class>

This signal is emitted when a row in the model has changed.

Link copied to clipboard
open fun connectRowDeleted(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath) -> Unit): <Error class: unknown class>

This signal is emitted when a row has been deleted.

Link copied to clipboard
open fun connectRowHasChildToggled(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter) -> Unit): <Error class: unknown class>

This signal is emitted when a row has gotten the first child row or lost its last child row.

Link copied to clipboard
open fun connectRowInserted(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter) -> Unit): <Error class: unknown class>

This signal is emitted when a new row has been inserted in the model.

Link copied to clipboard
open fun connectRowsReordered(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter, <Error class: unknown class>?) -> Unit): <Error class: unknown class>

This signal is emitted when the children of a node in the GtkTreeModel have been reordered.

Link copied to clipboard
open fun convertChildIterToIter(filterIter: TreeIter, childIter: TreeIter): Boolean

Sets @filter_iter to point to the row in @filter that corresponds to the row pointed at by @child_iter. If @filter_iter was not set, false is returned.

Link copied to clipboard

Converts @child_path to a path relative to @filter. That is, @child_path points to a path in the child model. The rerturned 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.

Link copied to clipboard
open fun convertIterToChildIter(childIter: TreeIter, filterIter: TreeIter)

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

Link copied to clipboard
open fun convertPathToChildPath(filterPath: TreePath): TreePath?

Converts @filter_path to a path on the child model of @filter. That is,

Link copied to clipboard

Asks the GtkTreeDragSource to delete the row at @path, because it was moved somewhere else via drag-and-drop. Returns false if the deletion fails because @path no longer exists, or for some model-specific reason. Should robustly handle a @path no longer found in the model!

Link copied to clipboard
open fun dragDataGet(path: TreePath): <Error class: unknown class>?

Asks the GtkTreeDragSource to return a GdkContentProvider representing the row at @path. Should robustly handle a @path no longer found in the model!

Link copied to clipboard
open fun filterNew(root: TreePath? = null): TreeModel

Creates a new GtkTreeModel, with @child_model as the child_model and @root as the virtual root.

Link copied to clipboard

Calls @func on each node in model in a depth-first fashion.

Link copied to clipboard
open fun getColumnType(index: <Error class: unknown class>): <Error class: unknown class>

Returns the type of the column.

Link copied to clipboard

Returns a set of flags supported by this interface.

Link copied to clipboard
open fun getIter(iter: TreeIter, path: TreePath): Boolean

Sets @iter to a valid iterator pointing to @path.

Link copied to clipboard
open fun getIterFirst(iter: TreeIter): Boolean

Initializes @iter with the first iterator in the tree (the one at the path "0").

Link copied to clipboard
open fun getIterFromString(iter: TreeIter, pathString: String): Boolean

Sets @iter to a valid iterator pointing to @path_string, if it exists.

Link copied to clipboard
open fun getModel(): TreeModel

Returns a pointer to the child model of @filter.

Link copied to clipboard
open fun getNColumns(): <Error class: unknown class>

Returns the number of columns supported by @tree_model.

Link copied to clipboard
open fun getPath(iter: TreeIter): TreePath

Returns a newly-created GtkTreePath referenced by @iter.

Link copied to clipboard

Generates a string representation of the iter.

Link copied to clipboard
open fun getValue(iter: TreeIter, column: <Error class: unknown class>, value: <Error class: unknown class>)

Initializes and sets @value to that at @column.

Link copied to clipboard
open fun iterChildren(iter: TreeIter, parent: TreeIter? = null): Boolean

Sets @iter to point to the first child of @parent.

Link copied to clipboard
open fun iterHasChild(iter: TreeIter): Boolean

Returns true if @iter has children, false otherwise.

Link copied to clipboard
open fun iterNChildren(iter: TreeIter? = null): <Error class: unknown class>

Returns the number of children that @iter has.

Link copied to clipboard
open fun iterNext(iter: TreeIter): Boolean

Sets @iter to point to the node following it at the current level.

Link copied to clipboard
open fun iterNthChild(iter: TreeIter, parent: TreeIter? = null, n: <Error class: unknown class>): Boolean

Sets @iter to be the child of @parent, using the given index.

Link copied to clipboard
open fun iterParent(iter: TreeIter, child: TreeIter): Boolean

Sets @iter to be the parent of @child.

Link copied to clipboard
open fun iterPrevious(iter: TreeIter): Boolean

Sets @iter to point to the previous node at the current level.

Link copied to clipboard
open fun 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.

Link copied to clipboard
open fun refNode(iter: TreeIter)

Lets the tree ref the node.

Link copied to clipboard
open fun rowChanged(path: TreePath, iter: TreeIter)

Emits the ::row-changed signal on @tree_model.

Link copied to clipboard
open fun rowDeleted(path: TreePath)

Emits the ::row-deleted signal on @tree_model.

Link copied to clipboard
open fun rowDraggable(path: TreePath): Boolean

Asks the GtkTreeDragSource whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable.

Link copied to clipboard
open fun rowHasChildToggled(path: TreePath, iter: TreeIter)

Emits the ::row-has-child-toggled signal on @tree_model.

Link copied to clipboard
open fun rowInserted(path: TreePath, iter: TreeIter)

Emits the ::row-inserted signal on @tree_model.

Link copied to clipboard
open fun setVisibleColumn(column: <Error class: unknown class>)

Sets @column of the child_model to be the column where @filter should look for visibility information. @columns should be a column of type %G_TYPE_BOOLEAN, where true means that a row is visible, and false if not.

Link copied to clipboard

Sets the visible function used when filtering the @filter to be @func. The function should return true if the given row should be visible and false otherwise.

Link copied to clipboard
open fun unrefNode(iter: TreeIter)

Lets the tree unref the node.