Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

Enums

Interface Gtk.TreeModel

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-3.0.gir
C documentation:	GtkTreeModel
Interface :	TreeModel
Implementations:	Gtk.ListStore, Gtk.TreeModelFilter, Gtk.TreeModelSort, Gtk.TreeStore

The GtkTreeModel interface defines a generic tree interface for
use by the GtkTreeView widget. It is an abstract interface, and
is designed to be usable with any appropriate data structure. The
programmer just has to implement this interface on their own data
type for it to be viewable by a GtkTreeView widget.
The model is represented as a hierarchical tree of strongly-typed,
columned data. In other words, the model can be seen as a tree where
every node has different values depending on which column is being
queried. The type of data found in a column is determined by using
the GType system (ie. G_TYPE_INT, GTK_TYPE_BUTTON, G_TYPE_POINTER,
etc). The types are homogeneous per column across all nodes. It is
important to note that this interface only provides a way of examining
a model and observing changes. The implementation of each individual
model decides how and if changes are made.
In order to make life simpler for programmers who do not need to
write their own specialized model, two generic models are provided
— the GtkTreeStore and the GtkListStore. To use these, the
developer simply pushes data into these models as necessary. These
models provide the data structure as well as all appropriate tree
interfaces. As a result, implementing drag and drop, sorting, and
storing data is trivial. For the vast majority of trees and lists,
these two models are sufficient.
Models are accessed on a node/column level of granularity. One can
query for the value of a model at a certain node and a certain
column on that node. There are two structures used to reference
a particular node in a model. They are the GtkTreePath and the
GtkTreeIterHere, iter is short
for iterator. Most of the interface
consists of operations on a GtkTreeIter.
A path is essentially a potential node. It is a location on a model
that may or may not actually correspond to a node on a specific
model. The GtkTreePath struct can be converted into either an
array of unsigned integers or a string. The string form is a list
of numbers separated by a colon. Each number refers to the offset
at that level. Thus, the path 0 refers to the root
node and the path 2:4 refers to the fifth child of
the third node.
By contrast, a GtkTreeIter is a reference to a specific node on
a specific model. It is a generic struct with an integer and three
generic pointers. These are filled in by the model in a model-specific
way. One can convert a path to an iterator by calling
gtk_tree_model_get_iter(). These iterators are the primary way
of accessing a model and are similar to the iterators used by
GtkTextBuffer. They are generally statically allocated on the
stack and only used for a short time. The model interface defines
a set of operations using them for navigating the model.
It is expected that models fill in the iterator with private data.
For example, the GtkListStore model, which is internally a simple
linked list, stores a list node in one of the pointers. The
GtkTreeModelSort stores an array and an offset in two of the
pointers. Additionally, there is an integer field. This field is
generally filled with a unique stamp per model. This stamp is for
catching errors resulting from using invalid iterators with a model.
The lifecycle of an iterator can be a little confusing at first.
Iterators are expected to always be valid for as long as the model
is unchanged (and doesn't emit a signal). The model is considered
to own all outstanding iterators and nothing needs to be done to
free them from the user's point of view. Additionally, some models
guarantee that an iterator is valid for as long as the node it refers
to is valid (most notably the GtkTreeStore and GtkListStore).
Although generally uninteresting, as one always has to allow for
the case where iterators do not persist beyond a signal, some very
important performance enhancements were made in the sort model.
As a result, the GTK_TREE_MODEL_ITERS_PERSIST flag was added to
indicate this behavior.
To help show some common operation of a model, some examples are
provided. The first example shows three ways of getting the iter at
the location 3:2:5. While the first method shown is
easier, the second is much more common, as you often get paths from
callbacks.

Acquiring a <structname>GtkTreeIter</structname>

/* Three ways of getting the iter pointing to the location */
GtkTreePath *path;
GtkTreeIter iter;
GtkTreeIter parent_iter;
/* get the iterator from a string */
gtk_tree_model_get_iter_from_string (model, &iter, "3:2:5");
/* get the iterator from a path */
path = gtk_tree_path_new_from_string ("3:2:5");
gtk_tree_model_get_iter (model, &iter, path);
gtk_tree_path_free (path);
/* walk the tree to find the iterator */
gtk_tree_model_iter_nth_child (model, &iter, NULL, 3);
parent_iter = iter;
gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, 2);
parent_iter = iter;
gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, 5);

This second example shows a quick way of iterating through a list
and getting a string and an integer from each row. The
populate_model function used below is not
shown, as it is specific to the GtkListStore. For information on
how to write such a function, see the GtkListStore documentation.

Reading data from a <structname>GtkTreeModel</structname>

enum
{
STRING_COLUMN,
INT_COLUMN,
N_COLUMNS
};
...
GtkTreeModel *list_store;
GtkTreeIter iter;
gboolean valid;
gint row_count = 0;
/* make a new list_store */
list_store = gtk_list_store_new (N_COLUMNS, G_TYPE_STRING, G_TYPE_INT);
/* Fill the list store with data */
populate_model (list_store);
/* Get the first iter in the list */
valid = gtk_tree_model_get_iter_first (list_store, &iter);
while (valid)
{
/* Walk through the list, reading each row */
gchar *str_data;
gint int_data;
/* Make sure you terminate calls to gtk_tree_model_get()
* with a '-1' value
*/
gtk_tree_model_get (list_store, &iter,
STRING_COLUMN, &str_data,
INT_COLUMN, &int_data,
-1);
/* Do something with the data */
g_free (str_data);
row_count++;
valid = gtk_tree_model_iter_next (list_store, &iter);
}

Properties
None

Methods / Constructors
Method / Constructor		Defined By
	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_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
	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_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
	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

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
EvinceDocument.DocumentFonts Method	fill_model (TreeModel *model*) : none
GnomeBluetooth.Client Method	get_adapter_model () : Gtk.TreeModel
GnomeBluetooth.Client Method	get_device_filter_model (Proxy *adapter, Function func, void *data, Function destroy*) : Gtk.TreeModel
GnomeBluetooth.Client Method	get_device_model (Proxy *adapter*) : Gtk.TreeModel
GnomeBluetooth.Client Method	get_filter_model (Function *func, void *data, Function destroy*) : Gtk.TreeModel
GnomeBluetooth.Client Method	get_model () : Gtk.TreeModel
Gtk Method	Gtk.tree_set_row_drag_data (SelectionData *selection_data, TreeModel tree_model, TreePath path) : gboolean Sets selection data of target type GTK_TREE_MODEL_ROW*.
Gtk.CellArea Signal	apply_attributes (CellArea *self, TreeModel model, TreeIter iter, gboolean is_expander, gboolean is_expanded) : none This signal is emitted whenever applying attributes to area* from model
Gtk.CellArea Method	apply_attributes (TreeModel *tree_model, TreeIter iter, gboolean is_expander, gboolean is_expanded*) : none Applies any connected attributes to the renderers in
Gtk.CellRendererCombo Property	model : Gtk.TreeModel Holds a tree model containing the possible values for the combo box.
Gtk.CellView Property	model : Gtk.TreeModel The model for cell view since 2.10
Gtk.CellView Method	get_model () : Gtk.TreeModel Returns the model for cell_view.
Gtk.CellView Method	set_model (TreeModel *model) : none Sets the model for cell_view*.
Gtk.ComboBox Property	model : Gtk.TreeModel The model from which the combo box takes the values shown in the list.
Gtk.ComboBox Method	new Gtk.ComboBox.with_model (TreeModel *model*) : Gtk.Widget Create a new Gtk.ComboBox
Gtk.ComboBox Method	new Gtk.ComboBox.with_model_and_entry (TreeModel *model*) : Gtk.Widget Create a new Gtk.ComboBox
Gtk.ComboBox Method	get_model () : Gtk.TreeModel Returns the GtkTreeModel which is acting as data source for combo_box.
Gtk.ComboBox Method	set_model (TreeModel *model) : none Sets the model used by combo_box* to be model.
Gtk.EntryCompletion Property	model : Gtk.TreeModel
Gtk.EntryCompletion Signal	cursor_on_match (EntryCompletion *self, TreeModel model, TreeIter iter*) : gboolean Gets emitted when a match from the cursor is on a match of the list.
Gtk.EntryCompletion Signal	match_selected (EntryCompletion *self, TreeModel model, TreeIter iter*) : gboolean Gets emitted when a match from the list is selected.
Gtk.EntryCompletion Method	get_model () : Gtk.TreeModel Returns the model the GtkEntryCompletion is using as data source.
Gtk.EntryCompletion Method	set_model (TreeModel *model) : none Sets the model for a GtkEntryCompletion*.
Gtk.IconView Property	model : Gtk.TreeModel
Gtk.IconView Method	new Gtk.IconView.with_model (TreeModel *model*) : Gtk.Widget Create a new Gtk.IconView
Gtk.IconView Method	get_model () : Gtk.TreeModel Returns the model the GtkIconView is based on.
Gtk.IconView Method	set_model (TreeModel *model) : none Sets the model for a GtkIconView*.
Gtk.TreeModelFilter Property	child_model : Gtk.TreeModel
Gtk.TreeModelFilter Method	get_model () : Gtk.TreeModel Returns a pointer to the child model of filter.
Gtk.TreeModelSort Property	model : Gtk.TreeModel
Gtk.TreeModelSort Method	get_model () : Gtk.TreeModel Returns the model the GtkTreeModelSort is sorting.
Gtk.TreeRowReference Method	new Gtk.TreeRowReference.c_new (TreeModel *model, TreePath path*) : Gtk.TreeRowReference Create a new Gtk.TreeRowReference
Gtk.TreeRowReference Method	new Gtk.TreeRowReference.proxy (Object *proxy, TreeModel model, TreePath path*) : Gtk.TreeRowReference Create a new Gtk.TreeRowReference
Gtk.TreeRowReference Method	get_model () : Gtk.TreeModel Returns the model that the row reference is monitoring.
Gtk.TreeView Property	model : Gtk.TreeModel
Gtk.TreeView Method	new Gtk.TreeView.with_model (TreeModel *model*) : Gtk.Widget Create a new Gtk.TreeView
Gtk.TreeView Method	get_model () : Gtk.TreeModel Returns the model the GtkTreeView is based on.
Gtk.TreeView Method	set_model (TreeModel *model) : none Sets the model for a GtkTreeView*.
Gtk.TreeViewColumn Method	cell_set_cell_data (TreeModel *tree_model, TreeIter iter, gboolean is_expander, gboolean is_expanded) : none Sets the cell renderer based on the tree_model* and iter.