GtkTreeModel

typedef struct _GtkTreeModel GtkTreeModel;

GtkTreeIter

typedef struct {
  gint stamp;
  gpointer user_data;
  gpointer user_data2;
  gpointer user_data3;
} GtkTreeIter;

The GtkTreeIter is the primary structure for accessing a structure. Models are expected to put a unique integer in the stamp member, and put model-specific data in the three user_data members.

GtkTreePath

typedef struct _GtkTreePath GtkTreePath;

GtkTreeRowReference

typedef struct _GtkTreeRowReference GtkTreeRowReference;

GtkTreeModelIface

typedef struct {
  GTypeInterface g_iface;

  /* Signals */
  void         (* row_changed)           (GtkTreeModel *tree_model,
					  GtkTreePath  *path,
					  GtkTreeIter  *iter);
  void         (* row_inserted)          (GtkTreeModel *tree_model,
					  GtkTreePath  *path,
					  GtkTreeIter  *iter);
  void         (* row_has_child_toggled) (GtkTreeModel *tree_model,
					  GtkTreePath  *path,
					  GtkTreeIter  *iter);
  void         (* row_deleted)           (GtkTreeModel *tree_model,
					  GtkTreePath  *path);
  void         (* rows_reordered)        (GtkTreeModel *tree_model,
					  GtkTreePath  *path,
					  GtkTreeIter  *iter,
					  gint         *new_order);

  /* Virtual Table */
  GtkTreeModelFlags (* get_flags)  (GtkTreeModel *tree_model);   

  gint         (* get_n_columns)   (GtkTreeModel *tree_model);
  GType        (* get_column_type) (GtkTreeModel *tree_model,
				    gint          index_);
  gboolean     (* get_iter)        (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreePath  *path);
  GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  void         (* get_value)       (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    gint          column,
				    GValue       *value);
  gboolean     (* iter_next)       (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  gboolean     (* iter_children)   (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreeIter  *parent);
  gboolean     (* iter_has_child)  (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  gint         (* iter_n_children) (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  gboolean     (* iter_nth_child)  (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreeIter  *parent,
				    gint          n);
  gboolean     (* iter_parent)     (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreeIter  *child);
  void         (* ref_node)        (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  void         (* unref_node)      (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
} GtkTreeModelIface;

GtkTreeModelForeachFunc ()

gboolean            (*GtkTreeModelForeachFunc)          (GtkTreeModel *model,
                                                         GtkTreePath *path,
                                                         GtkTreeIter *iter,
                                                         gpointer data);

enum GtkTreeModelFlags

typedef enum
{
  GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
  GTK_TREE_MODEL_LIST_ONLY = 1 << 1
} GtkTreeModelFlags;

These flags indicate various properties of a GtkTreeModel. They are returned by gtk_tree_model_get_flags(), and must be static for the lifetime of the object. A more complete description of GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of this section.

gtk_tree_path_new ()

GtkTreePath*        gtk_tree_path_new                   (void);

Creates a new GtkTreePath. This structure refers to a row.

gtk_tree_path_new_from_string ()

GtkTreePath*        gtk_tree_path_new_from_string       (const gchar *path);

Creates a new GtkTreePath initialized to path. path is expected to be a colon separated list of numbers. For example, the string "10:4:0" would create a path of depth 3 pointing to the 11th child of the root node, the 5th child of that 11th child, and the 1st child of that 5th child. If an invalid path string is passed in, NULL is returned.

gtk_tree_path_new_from_indices ()

GtkTreePath*        gtk_tree_path_new_from_indices      (gint first_index,
                                                         ...);

Creates a new path with first_index and varargs as indices.

Since 2.2

gtk_tree_path_to_string ()

gchar*              gtk_tree_path_to_string             (GtkTreePath *path);

Generates a string representation of the path. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.

gtk_tree_path_new_first ()

GtkTreePath*        gtk_tree_path_new_first             (void);

Creates a new GtkTreePath. The string representation of this path is "0"

gtk_tree_path_new_root()

#define gtk_tree_path_new_root() gtk_tree_path_new_first()

An alternate name for gtk_tree_path_new_first() provided for compatibility reasons.

gtk_tree_path_append_index ()

void                gtk_tree_path_append_index          (GtkTreePath *path,
                                                         gint index_);

Appends a new index to a path. As a result, the depth of the path is increased.

gtk_tree_path_prepend_index ()

void                gtk_tree_path_prepend_index         (GtkTreePath *path,
                                                         gint index_);

Prepends a new index to a path. As a result, the depth of the path is increased.

gtk_tree_path_get_depth ()

gint                gtk_tree_path_get_depth             (GtkTreePath *path);

Returns the current depth of path.

gtk_tree_path_get_indices ()

gint*               gtk_tree_path_get_indices           (GtkTreePath *path);

Returns the current indices of path. This is an array of integers, each representing a node in a tree. This value should not be freed.

gtk_tree_path_free ()

void                gtk_tree_path_free                  (GtkTreePath *path);

Frees path.

gtk_tree_path_copy ()

GtkTreePath*        gtk_tree_path_copy                  (const GtkTreePath *path);

Creates a new GtkTreePath as a copy of path.

gtk_tree_path_compare ()

gint                gtk_tree_path_compare               (const GtkTreePath *a,
                                                         const GtkTreePath *b);

Compares two paths. If a appears before b in a tree, then -1 is returned. If b appears before a, then 1 is returned. If the two nodes are equal, then 0 is returned.

gtk_tree_path_next ()

void                gtk_tree_path_next                  (GtkTreePath *path);

Moves the path to point to the next node at the current depth.

gtk_tree_path_prev ()

gboolean            gtk_tree_path_prev                  (GtkTreePath *path);

Moves the path to point to the previous node at the current depth, if it exists.

gtk_tree_path_up ()

gboolean            gtk_tree_path_up                    (GtkTreePath *path);

Moves the path to point to its parent node, if it has a parent.

gtk_tree_path_down ()

void                gtk_tree_path_down                  (GtkTreePath *path);

Moves path to point to the first child of the current path.

gtk_tree_path_is_ancestor ()

gboolean            gtk_tree_path_is_ancestor           (GtkTreePath *path,
                                                         GtkTreePath *descendant);

Returns TRUE if descendant is a descendant of path.

gtk_tree_path_is_descendant ()

gboolean            gtk_tree_path_is_descendant         (GtkTreePath *path,
                                                         GtkTreePath *ancestor);

Returns TRUE if path is a descendant of ancestor.

gtk_tree_row_reference_new ()

GtkTreeRowReference* gtk_tree_row_reference_new         (GtkTreeModel *model,
                                                         GtkTreePath *path);

Creates a row reference based on path. This reference will keep pointing to the node pointed to by path, so long as it exists. It listens to all signals emitted by model, and updates its path appropriately. If path isn't a valid path in model, then NULL is returned.

gtk_tree_row_reference_new_proxy ()

GtkTreeRowReference* gtk_tree_row_reference_new_proxy   (GObject *proxy,
                                                         GtkTreeModel *model,
                                                         GtkTreePath *path);

You do not need to use this function. Creates a row reference based on path. This reference will keep pointing to the node pointed to by path, so long as it exists. If path isn't a valid path in model, then NULL is returned. However, unlike references created with gtk_tree_row_reference_new(), it does not listen to the model for changes. The creator of the row reference must do this explicitly using gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(), gtk_tree_row_reference_reordered().

These functions must be called exactly once per proxy when the corresponding signal on the model is emitted. This single call updates all row references for that proxy. Since built-in GTK+ objects like GtkTreeView already use this mechanism internally, using them as the proxy object will produce unpredictable results. Further more, passing the same object as model and proxy doesn't work for reasons of internal implementation.

This type of row reference is primarily meant by structures that need to carefully monitor exactly when a row reference updates itself, and is not generally needed by most applications.

gtk_tree_row_reference_get_model ()

GtkTreeModel*       gtk_tree_row_reference_get_model    (GtkTreeRowReference *reference);

Returns the model that the row reference is monitoring.

Since 2.8

gtk_tree_row_reference_get_path ()

GtkTreePath*        gtk_tree_row_reference_get_path     (GtkTreeRowReference *reference);

Returns a path that the row reference currently points to, or NULL if the path pointed to is no longer valid.

gtk_tree_row_reference_valid ()

gboolean            gtk_tree_row_reference_valid        (GtkTreeRowReference *reference);

Returns TRUE if the reference is non-NULL and refers to a current valid path.

gtk_tree_row_reference_free ()

void                gtk_tree_row_reference_free         (GtkTreeRowReference *reference);

Free's reference. reference may be NULL.

gtk_tree_row_reference_copy ()

GtkTreeRowReference* gtk_tree_row_reference_copy        (GtkTreeRowReference *reference);

Copies a GtkTreeRowReference.

Since 2.2

gtk_tree_row_reference_inserted ()

void                gtk_tree_row_reference_inserted     (GObject *proxy,
                                                         GtkTreePath *path);

Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the "row_inserted" signal.

gtk_tree_row_reference_deleted ()

void                gtk_tree_row_reference_deleted      (GObject *proxy,
                                                         GtkTreePath *path);

Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the "row_deleted" signal.

gtk_tree_row_reference_reordered ()

void                gtk_tree_row_reference_reordered    (GObject *proxy,
                                                         GtkTreePath *path,
                                                         GtkTreeIter *iter,
                                                         gint *new_order);

Lets a set of row reference created by gtk_tree_row_reference_new_proxy() know that the model emitted the "rows_reordered" signal.

gtk_tree_iter_copy ()

GtkTreeIter*        gtk_tree_iter_copy                  (GtkTreeIter *iter);

Creates a dynamically allocated tree iterator as a copy of iter. This function is not intended for use in applications, because you can just copy the structs by value (GtkTreeIter new_iter = iter;). You must free this iter with gtk_tree_iter_free().

gtk_tree_iter_free ()

void                gtk_tree_iter_free                  (GtkTreeIter *iter);

Frees an iterator that has been allocated on the heap. This function is mainly used for language bindings.

gtk_tree_model_get_flags ()

GtkTreeModelFlags   gtk_tree_model_get_flags            (GtkTreeModel *tree_model);

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 lifecycle of the tree_model.

gtk_tree_model_get_n_columns ()

gint                gtk_tree_model_get_n_columns        (GtkTreeModel *tree_model);

Returns the number of columns supported by tree_model.

gtk_tree_model_get_column_type ()

GType               gtk_tree_model_get_column_type      (GtkTreeModel *tree_model,
                                                         gint index_);

Returns the type of the column.

gtk_tree_model_get_iter ()

gboolean            gtk_tree_model_get_iter             (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         GtkTreePath *path);

Sets iter to a valid iterator pointing to path.

gtk_tree_model_get_iter_from_string ()

gboolean            gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         const gchar *path_string);

Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and FALSE is returned.

gtk_tree_model_get_iter_first ()

gboolean            gtk_tree_model_get_iter_first       (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter);

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.

gtk_tree_model_get_iter_root()

#define gtk_tree_model_get_iter_root(tree_model, iter) gtk_tree_model_get_iter_first(tree_model, iter)

A alternate name for gtk_tree_model_get_iter_first() provided for compatibility reasons; this macro will be deprecated in future versions of GTK+.

gtk_tree_model_get_path ()

GtkTreePath*        gtk_tree_model_get_path             (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter);

Returns a newly-created GtkTreePath referenced by iter. This path should be freed with gtk_tree_path_free().

gtk_tree_model_get_value ()

void                gtk_tree_model_get_value            (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         gint column,
                                                         GValue *value);

Sets initializes and sets value to that at column. When done with value, g_value_unset() needs to be called to free any allocated memory.

gtk_tree_model_iter_next ()

gboolean            gtk_tree_model_iter_next            (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter);

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.

gtk_tree_model_iter_children ()

gboolean            gtk_tree_model_iter_children        (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         GtkTreeIter *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);

gtk_tree_model_iter_has_child ()

gboolean            gtk_tree_model_iter_has_child       (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter);

Returns TRUE if iter has children, FALSE otherwise.

gtk_tree_model_iter_n_children ()

gint                gtk_tree_model_iter_n_children      (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter);

Returns the number of children that iter has. As a special case, if iter is NULL, then the number of toplevel nodes is returned.

gtk_tree_model_iter_nth_child ()

gboolean            gtk_tree_model_iter_nth_child       (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         GtkTreeIter *parent,
                                                         gint n);

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, iter is set to an invalid iterator and FALSE is returned. parent 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.

gtk_tree_model_iter_parent ()

gboolean            gtk_tree_model_iter_parent          (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         GtkTreeIter *child);

Sets iter to be the parent of child. If child is at the toplevel, and doesn't have a parent, then iter is set to an invalid iterator and FALSE is returned. child will remain a valid node after this function has been called.

gtk_tree_model_get_string_from_iter ()

gchar*              gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
                                                         GtkTreeIter *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.

Since 2.2

gtk_tree_model_ref_node ()

void                gtk_tree_model_ref_node             (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter);

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 model 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.

gtk_tree_model_unref_node ()

void                gtk_tree_model_unref_node           (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter);

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.

gtk_tree_model_get ()

void                gtk_tree_model_get                  (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         ...);

Gets the value of one or more cells in the row referenced by iter. The variable argument list should contain integer column numbers, each column number followed by a place to store the value being retrieved. The list is terminated by a -1. For example, to get a value from column 0 with type G_TYPE_STRING, you would write: gtk_tree_model_get (model, iter, 0, &place_string_here, -1), where place_string_here is a gchar* to be filled with the string. If appropriate, the returned values have to be freed or unreferenced.

gtk_tree_model_get_valist ()

void                gtk_tree_model_get_valist           (GtkTreeModel *tree_model,
                                                         GtkTreeIter *iter,
                                                         va_list var_args);

See gtk_tree_model_get(), this version takes a va_list for language bindings to use.

gtk_tree_model_foreach ()

void                gtk_tree_model_foreach              (GtkTreeModel *model,
                                                         GtkTreeModelForeachFunc func,
                                                         gpointer user_data);

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.

gtk_tree_model_row_changed ()

void                gtk_tree_model_row_changed          (GtkTreeModel *tree_model,
                                                         GtkTreePath *path,
                                                         GtkTreeIter *iter);

Emits the "row_changed" signal on tree_model.

gtk_tree_model_row_inserted ()

void                gtk_tree_model_row_inserted         (GtkTreeModel *tree_model,
                                                         GtkTreePath *path,
                                                         GtkTreeIter *iter);

Emits the "row_inserted" signal on tree_model

gtk_tree_model_row_has_child_toggled ()

void                gtk_tree_model_row_has_child_toggled
                                                        (GtkTreeModel *tree_model,
                                                         GtkTreePath *path,
                                                         GtkTreeIter *iter);

Emits the "row_has_child_toggled" signal on tree_model. This should be called by models after the child state of a node changes.

gtk_tree_model_row_deleted ()

void                gtk_tree_model_row_deleted          (GtkTreeModel *tree_model,
                                                         GtkTreePath *path);

Emits the "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.

gtk_tree_model_rows_reordered ()

void                gtk_tree_model_rows_reordered       (GtkTreeModel *tree_model,
                                                         GtkTreePath *path,
                                                         GtkTreeIter *iter,
                                                         gint *new_order);

Emits the "rows_reordered" signal on tree_model. This should be called by models when their rows have been reordered.

The "row-changed" signal

void                user_function                      (GtkTreeModel *tree_model,
                                                        GtkTreePath  *path,
                                                        GtkTreeIter  *iter,
                                                        gpointer      user_data)       : Run Last

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

The "row-deleted" signal

void                user_function                      (GtkTreeModel *tree_model,
                                                        GtkTreePath  *path,
                                                        gpointer      user_data)       : Run First

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.

Implementations of GtkTreeModel must emit row-deleted before removing the node from its internal data structures. This is because models and views which access and monitor this model might have references on the node which need to be released in the row-deleted handler.

The "row-has-child-toggled" signal

void                user_function                      (GtkTreeModel *tree_model,
                                                        GtkTreePath  *path,
                                                        GtkTreeIter  *iter,
                                                        gpointer      user_data)       : Run Last

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

The "row-inserted" signal

void                user_function                      (GtkTreeModel *tree_model,
                                                        GtkTreePath  *path,
                                                        GtkTreeIter  *iter,
                                                        gpointer      user_data)       : Run First

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.

The "rows-reordered" signal

void                user_function                      (GtkTreeModel *tree_model,
                                                        GtkTreePath  *path,
                                                        GtkTreeIter  *iter,
                                                        gpointer      arg3,
                                                        gpointer      user_data)       : Run First

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

Note that this signal is not emitted when rows are reordered by DND, since this is implemented by removing and then reinserting the row.