Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gtk.TreeModelFilter

Class Gtk.TreeModelFilter

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkTreeModelFilter
Class :	TreeModelFilter
Implements:	Gtk.TreeDragSource, Gtk.TreeModel
Extends:	GObject.Object

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.

Properties
Properties		Defined By
	child_model : Gtk.TreeModel	Gtk.TreeModelFilter
	parent : GObject.Object read only	Gtk.TreeModelFilter
	priv : Gtk.TreeModelFilterPrivate read only	Gtk.TreeModelFilter
	virtual_root : Gtk.TreePath	Gtk.TreeModelFilter

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.TreeModelFilter (Object *properties) Create a new Gtk.TreeModelFilter Create a new Gtk.TreeModelFilter Parameters: Object properties*
	clear_cache () : none This function should almost never be called. 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. Returns: none	Gtk.TreeModelFilter
	convert_child_iter_to_iter (Object *out_values, TreeIter child_iter) : gboolean Sets filter_iter* to point to the row in filter that corresponds to the row pointed at by child_iter. 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. valid iterator pointing to a visible row in child model. Parameters: Object out_values Gtk.TreeIter filter_iter Gtk.TreeIter child_iter Required (not null) A valid GtkTreeIter pointing to a row on the child model. Returns: gboolean TRUE, if filter_iter was set, i.e. if child_iter is a	Gtk.TreeModelFilter
	convert_child_path_to_path (TreePath *child_path) : Gtk.TreePath Converts child_path* to a path relative to filter. 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. Parameters: Gtk.TreePath child_path Required (not null) A GtkTreePath to convert. Returns: Gtk.TreePath A newly allocated GtkTreePath, or NULL.	Gtk.TreeModelFilter
	convert_iter_to_child_iter (TreeIter *child_iter, TreeIter filter_iter) : Gtk.TreeIter Sets child_iter* to point to the row pointed to by filter_iter. Sets child_iter to point to the row pointed to by filter_iter. Parameters: Gtk.TreeIter child_iter Required (not null) An uninitialized GtkTreeIter. Gtk.TreeIter filter_iter Required (not null) A valid GtkTreeIter pointing to a row on filter. Returns: Gtk.TreeIter An uninitialized GtkTreeIter.	Gtk.TreeModelFilter
	convert_path_to_child_path (TreePath *filter_path) : Gtk.TreePath Converts filter_path* to a path on the child model of filter. Converts filter_path to a path on the child model of filter. That is, 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. Parameters: Gtk.TreePath filter_path Required (not null) A GtkTreePath to convert. Returns: Gtk.TreePath A newly allocated GtkTreePath, or NULL.	Gtk.TreeModelFilter
	drag_data_delete (TreePath *path) : gboolean Asks the GtkTreeDragSource* to delete the row at path, because it was moved somewhere else via drag-and-drop. 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! Parameters: Gtk.TreePath path Required (not null) row that was being dragged Returns: gboolean TRUE if the row was successfully deleted	Gtk.TreeDragSource
	drag_data_get (TreePath *path, Object out_values) : gboolean Asks the GtkTreeDragSource* to fill in selection_data with a representation of the row at path. Asks the GtkTreeDragSource to fill in selection_data with a representation of the row at path. selection_data->target gives the required type of the data. Should robustly handle a path no longer found in the model! Parameters: Gtk.TreePath path Required (not null) row that was dragged Object out_values Gtk.SelectionData selection_data Returns: gboolean TRUE if data of the required type was provided	Gtk.TreeDragSource
	filter_new (TreePath *root) : Gtk.TreeModel Creates a new GtkTreeModel, with child_model* as the child_model and root as the virtual root. Creates a new GtkTreeModel, with child_model as the child_model and root as the virtual root. Parameters: Gtk.TreePath root A GtkTreePath or NULL. Returns: Gtk.TreeModel A new GtkTreeModel.	Gtk.TreeModel
	foreach (Function *func, void *user_data) : none Calls func on each node in model in a depth-first fashion. Calls func on each node in model in a depth-first fashion. If func* returns TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach() returns. Parameters: Function (TreeModel *model, TreePath path, TreeIter iter, void *data) : none Required (not null) a function to be called on each row void user_data Required (not null) user data to passed to func Returns: none	Gtk.TreeModel
	get_column_type (gint32 *index_) : Number Returns the type of the column. Returns the type of the column. Parameters: gint32 index_* Required (not null) the column index Returns: Number the type of the column	Gtk.TreeModel
	get_flags () : Gtk.TreeModelFlags Returns a set of flags supported by this interface. Returns a set of flags supported by this interface. The flags are a bitwise combination of GtkTreeModelFlags. The flags supported should not change during the lifetime of the tree_model. Returns: Gtk.TreeModelFlags the flags supported by this interface	Gtk.TreeModel
	get_iter (Object *out_values, TreePath path) : gboolean Sets iter* to a valid iterator pointing to path. Sets iter to a valid iterator pointing to path. Parameters: Object out_values Gtk.TreeIter iter Gtk.TreePath path Required (not null) the GtkTreePath Returns: gboolean TRUE, if iter was set	Gtk.TreeModel
	get_iter_first (Object *out_values) : gboolean Initializes iter* with the first iterator in the tree (the one at the path "0") and returns TRUE. Initializes iter with the first iterator in the tree (the one at the path "0") and returns TRUE. Returns FALSE if the tree is empty. Parameters: Object out_values Gtk.TreeIter iter Returns: gboolean TRUE, if iter was set	Gtk.TreeModel
	get_iter_from_string (Object *out_values, String path_string) : gboolean Sets iter* to a valid iterator pointing to path_string, if it exists. Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and FALSE is returned. Parameters: Object out_values Gtk.TreeIter iter String path_string Required (not null) a string representation of a GtkTreePath Returns: gboolean TRUE, if iter was set	Gtk.TreeModel
	get_model () : Gtk.TreeModel Returns a pointer to the child model of filter. Returns a pointer to the child model of filter. Returns: Gtk.TreeModel A pointer to a GtkTreeModel.	Gtk.TreeModelFilter
	get_n_columns () : gint32 Returns the number of columns supported by tree_model. Returns the number of columns supported by tree_model. Returns: gint32 the number of columns	Gtk.TreeModel
	get_path (TreeIter *iter) : Gtk.TreePath Returns a newly-created GtkTreePath* referenced by iter. Returns a newly-created GtkTreePath referenced by iter. This path should be freed with gtk_tree_path_free(). Parameters: Gtk.TreeIter iter Required (not null) the GtkTreeIter Returns: Gtk.TreePath a newly-created GtkTreePath	Gtk.TreeModel
	get_string_from_iter (TreeIter *iter) : String Generates a string representation of the iter. Generates a string representation of the iter. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string. Must be freed with g_free(). Parameters: Gtk.TreeIter iter* Required (not null) a GtkTreeIter Returns: String a newly-allocated string.	Gtk.TreeModel
	get_value (TreeIter *iter, gint32 column) : GObject.Value Initializes and sets value* to that at column. Initializes and sets value to that at column. When done with value, g_value_unset() needs to be called to free any allocated memory. Parameters: Gtk.TreeIter iter Required (not null) the GtkTreeIter gint32 column Required (not null) the column to lookup the value at Returns: GObject.Value	Gtk.TreeModel
	iter_children (Object *out_values, TreeIter parent) : gboolean Sets iter* to point to the first child of parent. Sets iter to point to the first child of parent. If parent has no children, FALSE is returned and iter is set to be invalid. parent will remain a valid node after this function has been called. If parent is NULL returns the first node, equivalent to gtk_tree_model_get_iter_first (tree_model, iter); Parameters: Object out_values Gtk.TreeIter iter Gtk.TreeIter parent the GtkTreeIter, or NULL Returns: gboolean TRUE, if child has been set to the first child	Gtk.TreeModel
	iter_has_child (TreeIter *iter) : gboolean Returns TRUE* if iter has children, FALSE otherwise. Returns TRUE if iter has children, FALSE otherwise. Parameters: Gtk.TreeIter iter Required (not null) the GtkTreeIter to test for children Returns: gboolean TRUE if iter has children	Gtk.TreeModel
	iter_n_children (TreeIter *iter) : gint32 Returns the number of children that iter* has. Returns the number of children that iter has. As a special case, if iter is NULL, then the number of toplevel nodes is returned. Parameters: Gtk.TreeIter iter the GtkTreeIter, or NULL Returns: gint32 the number of children of iter	Gtk.TreeModel
	iter_next (TreeIter *iter) : gboolean Sets iter* to point to the node following it at the current level. Sets iter to point to the node following it at the current level. If there is no next iter, FALSE is returned and iter is set to be invalid. Parameters: Gtk.TreeIter iter Required (not null) the GtkTreeIter Returns: gboolean TRUE if iter has been changed to the next node	Gtk.TreeModel
	iter_nth_child (Object *out_values, TreeIter parent, gint32 n) : gboolean Sets iter* to be the child of parent, using the given index. Sets iter to be the child of parent, using the given index. The first index is 0. If n is too big, or parent has no children, will remain a valid node after this function has been called. As a special case, if parent is NULL, then the nth root node is set. Parameters: Object out_values Gtk.TreeIter iter Gtk.TreeIter parent the GtkTreeIter to get the child from, or NULL. gint32 n Required (not null) the index of the desired child Returns: gboolean TRUE, if parent has an nth child	Gtk.TreeModel
	iter_parent (Object *out_values, TreeIter child) : gboolean Sets iter* to be the parent of child. Sets iter to be the parent of child. If child is at the toplevel, and doesn't have a parent, then called. Parameters: Object out_values Gtk.TreeIter iter Gtk.TreeIter child Required (not null) the GtkTreeIter Returns: gboolean TRUE, if iter is set to the parent of child	Gtk.TreeModel
	iter_previous (TreeIter *iter) : gboolean Sets iter* to point to the previous node at the current level. Sets iter to point to the previous node at the current level. If there is no previous iter, FALSE is returned and iter is set to be invalid. Parameters: Gtk.TreeIter iter Required (not null) the GtkTreeIter Returns: gboolean TRUE if iter has been changed to the previous node	Gtk.TreeModel
	ref_node (TreeIter *iter) : none Lets the tree ref the node. Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. This function is primarily meant as a way for views to let caching models know when nodes are being displayed (and hence, whether or not to cache that node). For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view. A model should be expected to be able to get an iter independent of its reffed state. Parameters: Gtk.TreeIter iter* Required (not null) the GtkTreeIter Returns: none	Gtk.TreeModel
	refilter () : none Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not. Emits ::row_changed for each row in the child model, which causes the filter to re-evaluate whether a row is visible or not. Returns: none	Gtk.TreeModelFilter
	row_changed (TreePath *path, TreeIter iter) : none Emits the GtkTreeModel::row-changed signal on tree_model. Emits the GtkTreeModel::row-changed signal on tree_model. Parameters: Gtk.TreePath path* Required (not null) a GtkTreePath pointing to the changed row Gtk.TreeIter iter Required (not null) a valid GtkTreeIter pointing to the changed row Returns: none	Gtk.TreeModel
	row_deleted (TreePath *path) : none Emits the GtkTreeModel::row-deleted signal on tree_model. Emits the GtkTreeModel::row-deleted signal on tree_model. This should be called by models after a row has been removed. The location pointed to by path* should be the location that the row previously was at. It may not be a valid location anymore. Parameters: Gtk.TreePath path Required (not null) a GtkTreePath pointing to the previous location of the deleted row Returns: none	Gtk.TreeModel
	row_draggable (TreePath *path) : gboolean Asks the GtkTreeDragSource* whether a particular row can be used as the source of a DND operation. 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. Parameters: Gtk.TreePath path Required (not null) row on which user is initiating a drag Returns: gboolean TRUE if the row can be dragged	Gtk.TreeDragSource
	row_has_child_toggled (TreePath *path, TreeIter iter) : none Emits the GtkTreeModel::row-has-child-toggled signal on state of a node changes. Emits the GtkTreeModel::row-has-child-toggled signal on state of a node changes. Parameters: Gtk.TreePath path* Required (not null) a GtkTreePath pointing to the changed row Gtk.TreeIter iter Required (not null) a valid GtkTreeIter pointing to the changed row Returns: none	Gtk.TreeModel
	row_inserted (TreePath *path, TreeIter iter) : none Emits the GtkTreeModel::row-inserted signal on tree_model. Emits the GtkTreeModel::row-inserted signal on tree_model. Parameters: Gtk.TreePath path* Required (not null) a GtkTreePath pointing to the inserted row Gtk.TreeIter iter Required (not null) a valid GtkTreeIter pointing to the inserted row Returns: none	Gtk.TreeModel
	set_modify_func (gint32 *n_columns, Array types, Function func, void *data, Function destroy) : none 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). 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. Parameters: gint32 n_columns Required (not null) The number of columns in the filter model. Array types Required (not null) The GTypes of the columns. Function (TreeModel *model, TreeIter iter, Value value, gint32 column, void *data) : none Required (not null) A GtkTreeModelFilterModifyFunc* void* data User data to pass to the modify function, or NULL. Function (void* *data) : none Destroy notifier of data, or NULL*. Returns: none	Gtk.TreeModelFilter
	set_visible_column (gint32 *column) : none Sets column* of the child_model to be the column where filter should look for visibility information. 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. Parameters: gint32 column Required (not null) A gint which is the column containing the visible information. Returns: none	Gtk.TreeModelFilter
	set_visible_func (Function *func, void *data, Function destroy) : none Sets the visible function used when filtering the filter* to be 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. 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. static gboolean visible_func (GtkTreeModel model, GtkTreeIter iter, gpointer data) { /* Visible if row is non-empty and first column is "HI" / gchar str; gboolean visible = FALSE; gtk_tree_model_get (model, iter, 0, &str, -1); if (str && strcmp (str, "HI") == 0) visible = TRUE; g_free (str); return visible; } Parameters: Function (TreeModel *model, TreeIter iter, void *data) : none Required (not null) A GtkTreeModelFilterVisibleFunc, the visible function. void data User data to pass to the visible function, or NULL. Function (void* *data) : none Destroy notifier of data, or NULL*. Returns: none	Gtk.TreeModelFilter
	sort_new_with_model () : Gtk.TreeModel Creates a new GtkTreeModel, with child_model as the child model. Creates a new GtkTreeModel, with child_model as the child model. Returns: Gtk.TreeModel A new GtkTreeModel.	Gtk.TreeModel
	unref_node (TreeIter *iter) : none Lets the tree unref the node. Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see gtk_tree_model_ref_node(). Please note that nodes that are deleted are not unreffed. Parameters: Gtk.TreeIter iter* Required (not null) the GtkTreeIter Returns: none	Gtk.TreeModel

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	row_changed (TreeModel *self, TreePath path, TreeIter iter) : none This signal is emitted when a row in the model has changed. This signal is emitted when a row in the model has changed. Parameters: Gtk.TreeModel self* Gtk.TreePath path Gtk.TreeIter iter Returns: {none}	Gtk.TreeModel
	row_deleted (TreeModel *self, TreePath path) : none This signal is emitted when a row has been deleted. This signal is emitted when a row has been deleted. Note that no iterator is passed to the signal handler, since the row is already deleted. This should be called by models after a row has been removed. The location pointed to by path* should be the location that the row previously was at. It may not be a valid location anymore. Parameters: Gtk.TreeModel self Gtk.TreePath path Returns: {none}	Gtk.TreeModel
	row_has_child_toggled (TreeModel *self, TreePath path, TreeIter iter) : none This signal is emitted when a row has gotten the first child row or lost its last child row. This signal is emitted when a row has gotten the first child row or lost its last child row. Parameters: Gtk.TreeModel self* Gtk.TreePath path Gtk.TreeIter iter Returns: {none}	Gtk.TreeModel
	row_inserted (TreeModel *self, TreePath path, TreeIter iter) : none This signal is emitted when a new row has been inserted in the model. This signal is emitted when a new row has been inserted in the model. Note that the row may still be empty at this point, since it is a common pattern to first insert an empty row, and then fill it with the desired values. Parameters: Gtk.TreeModel self* Gtk.TreePath path Gtk.TreeIter iter Returns: {none}	Gtk.TreeModel