TreeModelFilter

A gtk.tree_model.TreeModel which hides parts of an underlying tree model

A gtk.tree_model_filter.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.tree_path.TreePath indicating the root node for the filter at construction time.

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

When using gtk.tree_model_filter.TreeModelFilter, it is important to realize that gtk.tree_model_filter.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.tree_model_filter.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.tree_model.TreeModel documentation. (Note that e.g. gtk.tree_store.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.tree_model.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.tree_model_filter.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.tree_model_filter.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.tree_model_filter.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.tree_model_filter.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.tree_store.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.

More...

Members

Functions

clearCache
void 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.TreeModel.refNode. 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.

convertChildIterToIter
bool convertChildIterToIter(gtk.tree_iter.TreeIter filterIter, gtk.tree_iter.TreeIter childIter)

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.

convertChildPathToPath
gtk.tree_path.TreePath convertChildPathToPath(gtk.tree_path.TreePath childPath)

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.

convertIterToChildIter
void convertIterToChildIter(gtk.tree_iter.TreeIter childIter, gtk.tree_iter.TreeIter filterIter)

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

convertPathToChildPath
gtk.tree_path.TreePath convertPathToChildPath(gtk.tree_path.TreePath filterPath)

Converts filter_path to a path on the child model of filter. 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.

getModel
gtk.tree_model.TreeModel getModel()

Returns a pointer to the child model of filter.

refilter
void 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.

setModifyFunc
void setModifyFunc(gobject.types.GType[] types, gtk.types.TreeModelFilterModifyFunc func)

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). The func, data and destroy parameters are for specifying the modify function. The modify function will get called for each data access, the goal of the modify function is to return the data which should be displayed at the location specified using the parameters of the modify function.

setVisibleColumn
void setVisibleColumn(int column)

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.

setVisibleFunc
void setVisibleFunc(gtk.types.TreeModelFilterVisibleFunc func)

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.

Mixed In Members

From mixin TreeDragSourceT!()

dragDataDelete
bool dragDataDelete(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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!

dragDataGet
gdk.content_provider.ContentProvider dragDataGet(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource to return a gdk.content_provider.ContentProvider representing the row at path. Should robustly handle a path no longer found in the model!

rowDraggable
bool rowDraggable(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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.

From mixin TreeModelT!()

filterNew
gtk.tree_model.TreeModel filterNew(gtk.tree_path.TreePath root)

Creates a new gtk.tree_model.TreeModel, with child_model as the child_model and root as the virtual root.

foreach_
void foreach_(gtk.types.TreeModelForeachFunc func)

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

getColumnType
gobject.types.GType getColumnType(int index)

Returns the type of the column.

getFlags
gtk.types.TreeModelFlags getFlags()

Returns a set of flags supported by this interface.

getIter
bool getIter(gtk.tree_iter.TreeIter iter, gtk.tree_path.TreePath path)

Sets iter to a valid iterator pointing to path.

getIterFirst
bool getIterFirst(gtk.tree_iter.TreeIter iter)

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

getIterFromString
bool getIterFromString(gtk.tree_iter.TreeIter iter, string pathString)

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

getNColumns
int getNColumns()

Returns the number of columns supported by tree_model.

getPath
gtk.tree_path.TreePath getPath(gtk.tree_iter.TreeIter iter)

Returns a newly-created gtk.tree_path.TreePath referenced by iter.

getStringFromIter
string getStringFromIter(gtk.tree_iter.TreeIter iter)

Generates a string representation of the iter.

getValue
void getValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value)

Initializes and sets value to that at column.

iterChildren
bool iterChildren(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent)

Sets iter to point to the first child of parent.

iterHasChild
bool iterHasChild(gtk.tree_iter.TreeIter iter)

Returns true if iter has children, false otherwise.

iterNChildren
int iterNChildren(gtk.tree_iter.TreeIter iter)

Returns the number of children that iter has.

iterNext
bool iterNext(gtk.tree_iter.TreeIter iter)

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

iterNthChild
bool iterNthChild(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int n)

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

iterParent
bool iterParent(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter child)

Sets iter to be the parent of child.

iterPrevious
bool iterPrevious(gtk.tree_iter.TreeIter iter)

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

refNode
void refNode(gtk.tree_iter.TreeIter iter)

Lets the tree ref the node.

rowChanged
void rowChanged(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-changed signal on tree_model.

rowDeleted
void rowDeleted(gtk.tree_path.TreePath path)

Emits the ::row-deleted signal on tree_model.

rowHasChildToggled
void rowHasChildToggled(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

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

rowInserted
void rowInserted(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-inserted signal on tree_model.

rowsReordered
void rowsReordered(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter, int[] newOrder)

Emits the ::rows-reordered signal on tree_model.

unrefNode
void unrefNode(gtk.tree_iter.TreeIter iter)

Lets the tree unref the node.

connectRowChanged
ulong connectRowChanged(T callback, Flag!"After" after)

Connect to RowChanged signal.

connectRowDeleted
ulong connectRowDeleted(T callback, Flag!"After" after)

Connect to RowDeleted signal.

connectRowHasChildToggled
ulong connectRowHasChildToggled(T callback, Flag!"After" after)

Connect to RowHasChildToggled signal.

connectRowInserted
ulong connectRowInserted(T callback, Flag!"After" after)

Connect to RowInserted signal.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

From TreeDragSource

dragDataDelete
bool dragDataDelete(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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!

dragDataGet
gdk.content_provider.ContentProvider dragDataGet(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource to return a gdk.content_provider.ContentProvider representing the row at path. Should robustly handle a path no longer found in the model!

rowDraggable
bool rowDraggable(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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.

From TreeModel

filterNew
gtk.tree_model.TreeModel filterNew(gtk.tree_path.TreePath root)

Creates a new gtk.tree_model.TreeModel, with child_model as the child_model and root as the virtual root.

foreach_
void foreach_(gtk.types.TreeModelForeachFunc func)

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

getColumnType
gobject.types.GType getColumnType(int index)

Returns the type of the column.

getFlags
gtk.types.TreeModelFlags getFlags()

Returns a set of flags supported by this interface.

getIter
bool getIter(gtk.tree_iter.TreeIter iter, gtk.tree_path.TreePath path)

Sets iter to a valid iterator pointing to path.

getIterFirst
bool getIterFirst(gtk.tree_iter.TreeIter iter)

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

getIterFromString
bool getIterFromString(gtk.tree_iter.TreeIter iter, string pathString)

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

getNColumns
int getNColumns()

Returns the number of columns supported by tree_model.

getPath
gtk.tree_path.TreePath getPath(gtk.tree_iter.TreeIter iter)

Returns a newly-created gtk.tree_path.TreePath referenced by iter.

getStringFromIter
string getStringFromIter(gtk.tree_iter.TreeIter iter)

Generates a string representation of the iter.

getValue
void getValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value)

Initializes and sets value to that at column.

iterChildren
bool iterChildren(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent)

Sets iter to point to the first child of parent.

iterHasChild
bool iterHasChild(gtk.tree_iter.TreeIter iter)

Returns true if iter has children, false otherwise.

iterNChildren
int iterNChildren(gtk.tree_iter.TreeIter iter)

Returns the number of children that iter has.

iterNext
bool iterNext(gtk.tree_iter.TreeIter iter)

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

iterNthChild
bool iterNthChild(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int n)

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

iterParent
bool iterParent(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter child)

Sets iter to be the parent of child.

iterPrevious
bool iterPrevious(gtk.tree_iter.TreeIter iter)

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

refNode
void refNode(gtk.tree_iter.TreeIter iter)

Lets the tree ref the node.

rowChanged
void rowChanged(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-changed signal on tree_model.

rowDeleted
void rowDeleted(gtk.tree_path.TreePath path)

Emits the ::row-deleted signal on tree_model.

rowHasChildToggled
void rowHasChildToggled(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

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

rowInserted
void rowInserted(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-inserted signal on tree_model.

rowsReordered
void rowsReordered(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter, int[] newOrder)

Emits the ::rows-reordered signal on tree_model.

unrefNode
void unrefNode(gtk.tree_iter.TreeIter iter)

Lets the tree unref the node.

connectRowChanged
ulong connectRowChanged(T callback, Flag!"After" after)

Connect to RowChanged signal.

connectRowDeleted
ulong connectRowDeleted(T callback, Flag!"After" after)

Connect to RowDeleted signal.

connectRowHasChildToggled
ulong connectRowHasChildToggled(T callback, Flag!"After" after)

Connect to RowHasChildToggled signal.

connectRowInserted
ulong connectRowInserted(T callback, Flag!"After" after)

Connect to RowInserted signal.

Detailed Description

Deprecated: Use gtk.filter_list_model.FilterListModel instead.