2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
24 #include <glib/gprintf.h>
25 #include <gobject/gvaluecollector.h>
26 #include "gtktreemodel.h"
27 #include "gtktreeview.h"
28 #include "gtktreeprivate.h"
29 #include "gtkmarshalers.h"
34 #define INITIALIZE_TREE_ITER(Iter) \
37 (Iter)->user_data = NULL; \
38 (Iter)->user_data2 = NULL; \
39 (Iter)->user_data3 = NULL; \
42 #define ROW_REF_DATA_STRING "gtk-tree-row-refs"
47 ROW_HAS_CHILD_TOGGLED,
53 static guint tree_model_signals[LAST_SIGNAL] = { 0 };
66 static void gtk_tree_model_base_init (gpointer g_class);
69 static void row_inserted_marshal (GClosure *closure,
70 GValue /* out */ *return_value,
72 const GValue *param_values,
73 gpointer invocation_hint,
74 gpointer marshal_data);
75 static void row_deleted_marshal (GClosure *closure,
76 GValue /* out */ *return_value,
78 const GValue *param_values,
79 gpointer invocation_hint,
80 gpointer marshal_data);
81 static void rows_reordered_marshal (GClosure *closure,
82 GValue /* out */ *return_value,
84 const GValue *param_values,
85 gpointer invocation_hint,
86 gpointer marshal_data);
88 static void gtk_tree_row_ref_inserted (RowRefList *refs,
91 static void gtk_tree_row_ref_deleted (RowRefList *refs,
93 static void gtk_tree_row_ref_reordered (RowRefList *refs,
99 gtk_tree_model_get_type (void)
101 static GType tree_model_type = 0;
103 if (! tree_model_type)
105 static const GTypeInfo tree_model_info =
107 sizeof (GtkTreeModelIface), /* class_size */
108 gtk_tree_model_base_init, /* base_init */
109 NULL, /* base_finalize */
111 NULL, /* class_finalize */
112 NULL, /* class_data */
119 g_type_register_static (G_TYPE_INTERFACE, I_("GtkTreeModel"),
120 &tree_model_info, 0);
122 g_type_interface_add_prerequisite (tree_model_type, G_TYPE_OBJECT);
125 return tree_model_type;
129 gtk_tree_model_base_init (gpointer g_class)
131 static gboolean initialized = FALSE;
136 GType row_inserted_params[2];
137 GType row_deleted_params[1];
138 GType rows_reordered_params[3];
140 row_inserted_params[0] = GTK_TYPE_TREE_PATH | G_SIGNAL_TYPE_STATIC_SCOPE;
141 row_inserted_params[1] = GTK_TYPE_TREE_ITER;
143 row_deleted_params[0] = GTK_TYPE_TREE_PATH | G_SIGNAL_TYPE_STATIC_SCOPE;
145 rows_reordered_params[0] = GTK_TYPE_TREE_PATH | G_SIGNAL_TYPE_STATIC_SCOPE;
146 rows_reordered_params[1] = GTK_TYPE_TREE_ITER;
147 rows_reordered_params[2] = G_TYPE_POINTER;
150 * GtkTreeModel::row-changed:
151 * @tree_model: the #GtkTreeModel on which the signal is emitted
152 * @path: a #GtkTreePath identifying the changed row
153 * @iter: a valid #GtkTreeIter pointing to the changed row
155 * This signal is emitted when a row in the model has changed.
157 tree_model_signals[ROW_CHANGED] =
158 g_signal_new (I_("row_changed"),
161 G_STRUCT_OFFSET (GtkTreeModelIface, row_changed),
163 _gtk_marshal_VOID__BOXED_BOXED,
165 GTK_TYPE_TREE_PATH | G_SIGNAL_TYPE_STATIC_SCOPE,
168 /* We need to get notification about structure changes
169 * to update row references., so instead of using the
170 * standard g_signal_new() with an offset into our interface
171 * structure, we use a customs closures for the class
172 * closures (default handlers) that first update row references
173 * and then calls the function from the interface structure.
175 * The reason we don't simply update the row references from
176 * the wrapper functions (gtk_tree_model_row_inserted(), etc.)
177 * is to keep proper ordering with respect to signal handlers
178 * connected normally and after.
182 * GtkTreeModel::row-inserted:
183 * @tree_model: the #GtkTreeModel on which the signal is emitted
184 * @path: a #GtkTreePath identifying the new row
185 * @iter: a valid #GtkTreeIter pointing to the new row
187 * This signal is emitted when a new row has been inserted in the model.
189 * Note that the row may still be empty at this point, since
190 * it is a common pattern to first insert an empty row, and
191 * then fill it with the desired values.
193 closure = g_closure_new_simple (sizeof (GClosure), NULL);
194 g_closure_set_marshal (closure, row_inserted_marshal);
195 tree_model_signals[ROW_INSERTED] =
196 g_signal_newv (I_("row_inserted"),
201 _gtk_marshal_VOID__BOXED_BOXED,
203 row_inserted_params);
206 * GtkTreeModel::row-has-child-toggled:
207 * @tree_model: the #GtkTreeModel on which the signal is emitted
208 * @path: a #GtkTreePath identifying the row
209 * @iter: a valid #GtkTreeIter pointing to the row
211 * This signal is emitted when a row has gotten the first child row or lost
212 * its last child row.
214 tree_model_signals[ROW_HAS_CHILD_TOGGLED] =
215 g_signal_new (I_("row_has_child_toggled"),
218 G_STRUCT_OFFSET (GtkTreeModelIface, row_has_child_toggled),
220 _gtk_marshal_VOID__BOXED_BOXED,
222 GTK_TYPE_TREE_PATH | G_SIGNAL_TYPE_STATIC_SCOPE,
226 * GtkTreeModel::row-deleted:
227 * @tree_model: the #GtkTreeModel on which the signal is emitted
228 * @path: a #GtkTreePath identifying the row
230 * This signal is emitted when a row has been deleted.
232 * Note that no iterator is passed to the signal handler,
233 * since the row is already deleted.
235 * Implementations of GtkTreeModel must emit row-deleted
236 * <emphasis>before</emphasis> removing the node from its
237 * internal data structures. This is because models and
238 * views which access and monitor this model might have
239 * references on the node which need to be released in the
240 * row-deleted handler.
242 closure = g_closure_new_simple (sizeof (GClosure), NULL);
243 g_closure_set_marshal (closure, row_deleted_marshal);
244 tree_model_signals[ROW_DELETED] =
245 g_signal_newv (I_("row_deleted"),
250 _gtk_marshal_VOID__BOXED,
255 * GtkTreeModel::rows-reordered:
256 * @tree_model: the #GtkTreeModel on which the signal is emitted
257 * @path: a #GtkTreePath identifying the tree node whose children
258 * have been reordered
259 * @iter: a valid #GtkTreeIter pointing to the node whose
261 * This signal is emitted when the children of a node in the #GtkTreeModel
262 * have been reordered.
264 * Note that this signal is <emphasis>not</emphasis> emitted
265 * when rows are reordered by DND, since this is implemented
266 * by removing and then reinserting the row.
268 closure = g_closure_new_simple (sizeof (GClosure), NULL);
269 g_closure_set_marshal (closure, rows_reordered_marshal);
270 tree_model_signals[ROWS_REORDERED] =
271 g_signal_newv (I_("rows_reordered"),
276 _gtk_marshal_VOID__BOXED_BOXED_POINTER,
278 rows_reordered_params);
284 row_inserted_marshal (GClosure *closure,
285 GValue /* out */ *return_value,
286 guint n_param_values,
287 const GValue *param_values,
288 gpointer invocation_hint,
289 gpointer marshal_data)
291 GtkTreeModelIface *iface;
293 void (* row_inserted_callback) (GtkTreeModel *tree_model,
295 GtkTreeIter *iter) = NULL;
297 GObject *model = g_value_get_object (param_values + 0);
298 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
299 GtkTreeIter *iter = (GtkTreeIter *)g_value_get_boxed (param_values + 2);
301 /* first, we need to update internal row references */
302 gtk_tree_row_ref_inserted ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
305 /* fetch the interface ->row_inserted implementation */
306 iface = GTK_TREE_MODEL_GET_IFACE (model);
307 row_inserted_callback = G_STRUCT_MEMBER (gpointer, iface,
308 G_STRUCT_OFFSET (GtkTreeModelIface,
311 /* Call that default signal handler, it if has been set */
312 if (row_inserted_callback)
313 row_inserted_callback (GTK_TREE_MODEL (model), path, iter);
317 row_deleted_marshal (GClosure *closure,
318 GValue /* out */ *return_value,
319 guint n_param_values,
320 const GValue *param_values,
321 gpointer invocation_hint,
322 gpointer marshal_data)
324 GtkTreeModelIface *iface;
325 void (* row_deleted_callback) (GtkTreeModel *tree_model,
326 GtkTreePath *path) = NULL;
327 GObject *model = g_value_get_object (param_values + 0);
328 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
331 /* first, we need to update internal row references */
332 gtk_tree_row_ref_deleted ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
335 /* fetch the interface ->row_deleted implementation */
336 iface = GTK_TREE_MODEL_GET_IFACE (model);
337 row_deleted_callback = G_STRUCT_MEMBER (gpointer, iface,
338 G_STRUCT_OFFSET (GtkTreeModelIface,
341 /* Call that default signal handler, it if has been set */
342 if (row_deleted_callback)
343 row_deleted_callback (GTK_TREE_MODEL (model), path);
347 rows_reordered_marshal (GClosure *closure,
348 GValue /* out */ *return_value,
349 guint n_param_values,
350 const GValue *param_values,
351 gpointer invocation_hint,
352 gpointer marshal_data)
354 GtkTreeModelIface *iface;
355 void (* rows_reordered_callback) (GtkTreeModel *tree_model,
360 GObject *model = g_value_get_object (param_values + 0);
361 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
362 GtkTreeIter *iter = (GtkTreeIter *)g_value_get_boxed (param_values + 2);
363 gint *new_order = (gint *)g_value_get_pointer (param_values + 3);
365 /* first, we need to update internal row references */
366 gtk_tree_row_ref_reordered ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
367 path, iter, new_order);
369 /* fetch the interface ->rows_reordered implementation */
370 iface = GTK_TREE_MODEL_GET_IFACE (model);
371 rows_reordered_callback = G_STRUCT_MEMBER (gpointer, iface,
372 G_STRUCT_OFFSET (GtkTreeModelIface,
375 /* Call that default signal handler, it if has been set */
376 if (rows_reordered_callback)
377 rows_reordered_callback (GTK_TREE_MODEL (model), path, iter, new_order);
383 * Creates a new #GtkTreePath. This structure refers to a row.
385 * Return value: A newly created #GtkTreePath.
387 /* GtkTreePath Operations */
389 gtk_tree_path_new (void)
392 retval = g_new (GtkTreePath, 1);
394 retval->indices = NULL;
400 * gtk_tree_path_new_from_string:
401 * @path: The string representation of a path.
403 * Creates a new #GtkTreePath initialized to @path. @path is expected to be a
404 * colon separated list of numbers. For example, the string "10:4:0" would
405 * create a path of depth 3 pointing to the 11th child of the root node, the 5th
406 * child of that 11th child, and the 1st child of that 5th child. If an invalid
407 * path string is passed in, %NULL is returned.
409 * Return value: A newly-created #GtkTreePath, or %NULL
412 gtk_tree_path_new_from_string (const gchar *path)
415 const gchar *orig_path = path;
419 g_return_val_if_fail (path != NULL, NULL);
420 g_return_val_if_fail (*path != '\000', NULL);
422 retval = gtk_tree_path_new ();
426 i = strtol (path, &ptr, 10);
429 g_warning (G_STRLOC ": Negative numbers in path %s passed to gtk_tree_path_new_from_string", orig_path);
430 gtk_tree_path_free (retval);
434 gtk_tree_path_append_index (retval, i);
438 if (ptr == path || *ptr != ':')
440 g_warning (G_STRLOC ": Invalid path %s passed to gtk_tree_path_new_from_string", orig_path);
441 gtk_tree_path_free (retval);
451 * gtk_tree_path_new_from_indices:
452 * @first_index: first integer
453 * @varargs: list of integers terminated by -1
455 * Creates a new path with @first_index and @varargs as indices.
457 * Return value: A newly created #GtkTreePath.
462 gtk_tree_path_new_from_indices (gint first_index,
469 path = gtk_tree_path_new ();
471 va_start (args, first_index);
476 gtk_tree_path_append_index (path, arg);
477 arg = va_arg (args, gint);
486 * gtk_tree_path_to_string:
487 * @path: A #GtkTreePath
489 * Generates a string representation of the path. This string is a ':'
490 * separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
492 * Return value: A newly-allocated string. Must be freed with g_free().
495 gtk_tree_path_to_string (GtkTreePath *path)
500 g_return_val_if_fail (path != NULL, NULL);
502 if (path->depth == 0)
505 ptr = retval = g_new0 (gchar, path->depth*8);
506 g_sprintf (retval, "%d", path->indices[0]);
507 while (*ptr != '\000')
510 for (i = 1; i < path->depth; i++)
512 g_sprintf (ptr, ":%d", path->indices[i]);
513 while (*ptr != '\000')
521 * gtk_tree_path_new_first:
523 * Creates a new #GtkTreePath. The string representation of this path is "0"
525 * Return value: A new #GtkTreePath.
528 gtk_tree_path_new_first (void)
532 retval = gtk_tree_path_new ();
533 gtk_tree_path_append_index (retval, 0);
539 * gtk_tree_path_append_index:
540 * @path: A #GtkTreePath.
541 * @index_: The index.
543 * Appends a new index to a path. As a result, the depth of the path is
547 gtk_tree_path_append_index (GtkTreePath *path,
550 g_return_if_fail (path != NULL);
551 g_return_if_fail (index >= 0);
554 path->indices = g_realloc (path->indices, path->depth * sizeof(gint));
555 path->indices[path->depth - 1] = index;
559 * gtk_tree_path_prepend_index:
560 * @path: A #GtkTreePath.
561 * @index_: The index.
563 * Prepends a new index to a path. As a result, the depth of the path is
567 gtk_tree_path_prepend_index (GtkTreePath *path,
573 new_indices = g_new (gint, path->depth);
575 if (path->indices == NULL)
577 path->indices = new_indices;
578 path->indices[0] = index;
581 memcpy (new_indices + 1, path->indices, (path->depth - 1)*sizeof (gint));
582 g_free (path->indices);
583 path->indices = new_indices;
584 path->indices[0] = index;
588 * gtk_tree_path_get_depth:
589 * @path: A #GtkTreePath.
591 * Returns the current depth of @path.
593 * Return value: The depth of @path
596 gtk_tree_path_get_depth (GtkTreePath *path)
598 g_return_val_if_fail (path != NULL, 0);
604 * gtk_tree_path_get_indices:
605 * @path: A #GtkTreePath.
607 * Returns the current indices of @path. This is an array of integers, each
608 * representing a node in a tree. This value should not be freed.
610 * Return value: The current indices, or %NULL.
613 gtk_tree_path_get_indices (GtkTreePath *path)
615 g_return_val_if_fail (path != NULL, NULL);
617 return path->indices;
621 * gtk_tree_path_free:
622 * @path: A #GtkTreePath.
627 gtk_tree_path_free (GtkTreePath *path)
632 g_free (path->indices);
637 * gtk_tree_path_copy:
638 * @path: A #GtkTreePath.
640 * Creates a new #GtkTreePath as a copy of @path.
642 * Return value: A new #GtkTreePath.
645 gtk_tree_path_copy (const GtkTreePath *path)
649 g_return_val_if_fail (path != NULL, NULL);
651 retval = g_new (GtkTreePath, 1);
652 retval->depth = path->depth;
653 retval->indices = g_new (gint, path->depth);
654 memcpy (retval->indices, path->indices, path->depth * sizeof (gint));
659 gtk_tree_path_get_type (void)
661 static GType our_type = 0;
664 our_type = g_boxed_type_register_static (I_("GtkTreePath"),
665 (GBoxedCopyFunc) gtk_tree_path_copy,
666 (GBoxedFreeFunc) gtk_tree_path_free);
672 * gtk_tree_path_compare:
673 * @a: A #GtkTreePath.
674 * @b: A #GtkTreePath to compare with.
676 * Compares two paths. If @a appears before @b in a tree, then -1 is returned.
677 * If @b appears before @a, then 1 is returned. If the two nodes are equal,
678 * then 0 is returned.
680 * Return value: The relative positions of @a and @b
683 gtk_tree_path_compare (const GtkTreePath *a,
684 const GtkTreePath *b)
688 g_return_val_if_fail (a != NULL, 0);
689 g_return_val_if_fail (b != NULL, 0);
690 g_return_val_if_fail (a->depth > 0, 0);
691 g_return_val_if_fail (b->depth > 0, 0);
695 if (a->indices[p] == b->indices[q])
697 return (a->indices[p] < b->indices[q]?-1:1);
699 while (++p < a->depth && ++q < b->depth);
700 if (a->depth == b->depth)
702 return (a->depth < b->depth?-1:1);
706 * gtk_tree_path_is_ancestor:
707 * @path: a #GtkTreePath
708 * @descendant: another #GtkTreePath
710 * Returns %TRUE if @descendant is a descendant of @path.
712 * Return value: %TRUE if @descendant is contained inside @path
715 gtk_tree_path_is_ancestor (GtkTreePath *path,
716 GtkTreePath *descendant)
720 g_return_val_if_fail (path != NULL, FALSE);
721 g_return_val_if_fail (descendant != NULL, FALSE);
723 /* can't be an ancestor if we're deeper */
724 if (path->depth >= descendant->depth)
728 while (i < path->depth)
730 if (path->indices[i] != descendant->indices[i])
739 * gtk_tree_path_is_descendant:
740 * @path: a #GtkTreePath
741 * @ancestor: another #GtkTreePath
743 * Returns %TRUE if @path is a descendant of @ancestor.
745 * Return value: %TRUE if @ancestor contains @path somewhere below it
748 gtk_tree_path_is_descendant (GtkTreePath *path,
749 GtkTreePath *ancestor)
753 g_return_val_if_fail (path != NULL, FALSE);
754 g_return_val_if_fail (ancestor != NULL, FALSE);
756 /* can't be a descendant if we're shallower in the tree */
757 if (path->depth <= ancestor->depth)
761 while (i < ancestor->depth)
763 if (path->indices[i] != ancestor->indices[i])
773 * gtk_tree_path_next:
774 * @path: A #GtkTreePath.
776 * Moves the @path to point to the next node at the current depth.
779 gtk_tree_path_next (GtkTreePath *path)
781 g_return_if_fail (path != NULL);
782 g_return_if_fail (path->depth > 0);
784 path->indices[path->depth - 1] ++;
788 * gtk_tree_path_prev:
789 * @path: A #GtkTreePath.
791 * Moves the @path to point to the previous node at the current depth,
794 * Return value: %TRUE if @path has a previous node, and the move was made.
797 gtk_tree_path_prev (GtkTreePath *path)
799 g_return_val_if_fail (path != NULL, FALSE);
801 if (path->depth == 0)
804 if (path->indices[path->depth - 1] == 0)
807 path->indices[path->depth - 1] -= 1;
814 * @path: A #GtkTreePath.
816 * Moves the @path to point to its parent node, if it has a parent.
818 * Return value: %TRUE if @path has a parent, and the move was made.
821 gtk_tree_path_up (GtkTreePath *path)
823 g_return_val_if_fail (path != NULL, FALSE);
825 if (path->depth == 0)
834 * gtk_tree_path_down:
835 * @path: A #GtkTreePath.
837 * Moves @path to point to the first child of the current path.
840 gtk_tree_path_down (GtkTreePath *path)
842 g_return_if_fail (path != NULL);
844 gtk_tree_path_append_index (path, 0);
848 * gtk_tree_iter_copy:
849 * @iter: A #GtkTreeIter.
851 * Creates a dynamically allocated tree iterator as a copy of @iter. This
852 * function is not intended for use in applications, because you can just copy
853 * the structs by value (<literal>GtkTreeIter new_iter = iter;</literal>). You
854 * must free this iter with gtk_tree_iter_free ().
856 * Return value: a newly-allocated copy of @iter.
859 gtk_tree_iter_copy (GtkTreeIter *iter)
863 g_return_val_if_fail (iter != NULL, NULL);
865 retval = g_new (GtkTreeIter, 1);
872 * gtk_tree_iter_free:
873 * @iter: A dynamically allocated tree iterator.
875 * Frees an iterator that has been allocated on the heap. This function is
876 * mainly used for language bindings.
879 gtk_tree_iter_free (GtkTreeIter *iter)
881 g_return_if_fail (iter != NULL);
887 gtk_tree_iter_get_type (void)
889 static GType our_type = 0;
892 our_type = g_boxed_type_register_static (I_("GtkTreeIter"),
893 (GBoxedCopyFunc) gtk_tree_iter_copy,
894 (GBoxedFreeFunc) gtk_tree_iter_free);
900 * gtk_tree_model_get_flags:
901 * @tree_model: A #GtkTreeModel.
903 * Returns a set of flags supported by this interface. The flags are a bitwise
904 * combination of #GtkTreeModelFlags. The flags supported should not change
905 * during the lifecycle of the @tree_model.
907 * Return value: The flags supported by this interface.
910 gtk_tree_model_get_flags (GtkTreeModel *tree_model)
912 GtkTreeModelIface *iface;
914 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
916 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
917 if (iface->get_flags)
918 return (* iface->get_flags) (tree_model);
924 * gtk_tree_model_get_n_columns:
925 * @tree_model: A #GtkTreeModel.
927 * Returns the number of columns supported by @tree_model.
929 * Return value: The number of columns.
932 gtk_tree_model_get_n_columns (GtkTreeModel *tree_model)
934 GtkTreeModelIface *iface;
935 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
937 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
938 g_return_val_if_fail (iface->get_n_columns != NULL, 0);
940 return (* iface->get_n_columns) (tree_model);
944 * gtk_tree_model_get_column_type:
945 * @tree_model: A #GtkTreeModel.
946 * @index_: The column index.
948 * Returns the type of the column.
950 * Return value: The type of the column.
953 gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
956 GtkTreeModelIface *iface;
958 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), G_TYPE_INVALID);
960 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
961 g_return_val_if_fail (iface->get_column_type != NULL, G_TYPE_INVALID);
962 g_return_val_if_fail (index >= 0, G_TYPE_INVALID);
964 return (* iface->get_column_type) (tree_model, index);
968 * gtk_tree_model_get_iter:
969 * @tree_model: A #GtkTreeModel.
970 * @iter: The uninitialized #GtkTreeIter.
971 * @path: The #GtkTreePath.
973 * Sets @iter to a valid iterator pointing to @path.
975 * Return value: %TRUE, if @iter was set.
978 gtk_tree_model_get_iter (GtkTreeModel *tree_model,
982 GtkTreeModelIface *iface;
984 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
985 g_return_val_if_fail (iter != NULL, FALSE);
986 g_return_val_if_fail (path != NULL, FALSE);
988 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
989 g_return_val_if_fail (iface->get_iter != NULL, FALSE);
990 g_return_val_if_fail (path->depth > 0, FALSE);
992 INITIALIZE_TREE_ITER (iter);
994 return (* iface->get_iter) (tree_model, iter, path);
998 * gtk_tree_model_get_iter_from_string:
999 * @tree_model: A #GtkTreeModel.
1000 * @iter: An uninitialized #GtkTreeIter.
1001 * @path_string: A string representation of a #GtkTreePath.
1003 * Sets @iter to a valid iterator pointing to @path_string, if it
1004 * exists. Otherwise, @iter is left invalid and %FALSE is returned.
1006 * Return value: %TRUE, if @iter was set.
1009 gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
1011 const gchar *path_string)
1016 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1017 g_return_val_if_fail (iter != NULL, FALSE);
1018 g_return_val_if_fail (path_string != NULL, FALSE);
1020 path = gtk_tree_path_new_from_string (path_string);
1022 g_return_val_if_fail (path != NULL, FALSE);
1024 retval = gtk_tree_model_get_iter (tree_model, iter, path);
1025 gtk_tree_path_free (path);
1031 * gtk_tree_model_get_string_from_iter:
1032 * @tree_model: A #GtkTreeModel.
1033 * @iter: An #GtkTreeIter.
1035 * Generates a string representation of the iter. This string is a ':'
1036 * separated list of numbers. For example, "4:10:0:3" would be an
1037 * acceptable return value for this string.
1039 * Return value: A newly-allocated string. Must be freed with g_free().
1044 gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
1050 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
1051 g_return_val_if_fail (iter != NULL, NULL);
1053 path = gtk_tree_model_get_path (tree_model, iter);
1055 g_return_val_if_fail (path != NULL, NULL);
1057 ret = gtk_tree_path_to_string (path);
1058 gtk_tree_path_free (path);
1064 * gtk_tree_model_get_iter_first:
1065 * @tree_model: A #GtkTreeModel.
1066 * @iter: The uninitialized #GtkTreeIter.
1068 * Initializes @iter with the first iterator in the tree (the one at the path
1069 * "0") and returns %TRUE. Returns %FALSE if the tree is empty.
1071 * Return value: %TRUE, if @iter was set.
1074 gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
1080 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1081 g_return_val_if_fail (iter != NULL, FALSE);
1083 path = gtk_tree_path_new_first ();
1084 retval = gtk_tree_model_get_iter (tree_model, iter, path);
1085 gtk_tree_path_free (path);
1091 * gtk_tree_model_get_path:
1092 * @tree_model: A #GtkTreeModel.
1093 * @iter: The #GtkTreeIter.
1095 * Returns a newly-created #GtkTreePath referenced by @iter. This path should
1096 * be freed with gtk_tree_path_free().
1098 * Return value: a newly-created #GtkTreePath.
1101 gtk_tree_model_get_path (GtkTreeModel *tree_model,
1104 GtkTreeModelIface *iface;
1106 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
1107 g_return_val_if_fail (iter != NULL, NULL);
1109 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1110 g_return_val_if_fail (iface->get_path != NULL, NULL);
1112 return (* iface->get_path) (tree_model, iter);
1116 * gtk_tree_model_get_value:
1117 * @tree_model: A #GtkTreeModel.
1118 * @iter: The #GtkTreeIter.
1119 * @column: The column to lookup the value at.
1120 * @value: An empty #GValue to set.
1122 * Sets initializes and sets @value to that at @column. When done with @value,
1123 * g_value_unset() needs to be called to free any allocated memory.
1126 gtk_tree_model_get_value (GtkTreeModel *tree_model,
1131 GtkTreeModelIface *iface;
1133 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1134 g_return_if_fail (iter != NULL);
1135 g_return_if_fail (value != NULL);
1137 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1138 g_return_if_fail (iface->get_value != NULL);
1140 (* iface->get_value) (tree_model, iter, column, value);
1144 * gtk_tree_model_iter_next:
1145 * @tree_model: A #GtkTreeModel.
1146 * @iter: The #GtkTreeIter.
1148 * Sets @iter to point to the node following it at the current level. If there
1149 * is no next @iter, %FALSE is returned and @iter is set to be invalid.
1151 * Return value: %TRUE if @iter has been changed to the next node.
1154 gtk_tree_model_iter_next (GtkTreeModel *tree_model,
1157 GtkTreeModelIface *iface;
1159 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1160 g_return_val_if_fail (iter != NULL, FALSE);
1162 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1163 g_return_val_if_fail (iface->iter_next != NULL, FALSE);
1165 return (* iface->iter_next) (tree_model, iter);
1169 * gtk_tree_model_iter_children:
1170 * @tree_model: A #GtkTreeModel.
1171 * @iter: The new #GtkTreeIter to be set to the child.
1172 * @parent: The #GtkTreeIter, or %NULL
1174 * Sets @iter to point to the first child of @parent. If @parent has no
1175 * children, %FALSE is returned and @iter is set to be invalid. @parent
1176 * will remain a valid node after this function has been called.
1178 * If @parent is %NULL returns the first node, equivalent to
1179 * <literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal>
1181 * Return value: %TRUE, if @child has been set to the first child.
1184 gtk_tree_model_iter_children (GtkTreeModel *tree_model,
1186 GtkTreeIter *parent)
1188 GtkTreeModelIface *iface;
1190 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1191 g_return_val_if_fail (iter != NULL, FALSE);
1193 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1194 g_return_val_if_fail (iface->iter_children != NULL, FALSE);
1196 INITIALIZE_TREE_ITER (iter);
1198 return (* iface->iter_children) (tree_model, iter, parent);
1202 * gtk_tree_model_iter_has_child:
1203 * @tree_model: A #GtkTreeModel.
1204 * @iter: The #GtkTreeIter to test for children.
1206 * Returns %TRUE if @iter has children, %FALSE otherwise.
1208 * Return value: %TRUE if @iter has children.
1211 gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
1214 GtkTreeModelIface *iface;
1216 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1217 g_return_val_if_fail (iter != NULL, FALSE);
1219 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1220 g_return_val_if_fail (iface->iter_has_child != NULL, FALSE);
1222 return (* iface->iter_has_child) (tree_model, iter);
1226 * gtk_tree_model_iter_n_children:
1227 * @tree_model: A #GtkTreeModel.
1228 * @iter: The #GtkTreeIter, or %NULL.
1230 * Returns the number of children that @iter has. As a special case, if @iter
1231 * is %NULL, then the number of toplevel nodes is returned.
1233 * Return value: The number of children of @iter.
1236 gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
1239 GtkTreeModelIface *iface;
1241 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
1243 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1244 g_return_val_if_fail (iface->iter_n_children != NULL, 0);
1246 return (* iface->iter_n_children) (tree_model, iter);
1250 * gtk_tree_model_iter_nth_child:
1251 * @tree_model: A #GtkTreeModel.
1252 * @iter: The #GtkTreeIter to set to the nth child.
1253 * @parent: The #GtkTreeIter to get the child from, or %NULL.
1254 * @n: Then index of the desired child.
1256 * Sets @iter to be the child of @parent, using the given index. The first
1257 * index is 0. If @n is too big, or @parent has no children, @iter is set
1258 * to an invalid iterator and %FALSE is returned. @parent will remain a valid
1259 * node after this function has been called. As a special case, if @parent is
1260 * %NULL, then the @n<!-- -->th root node is set.
1262 * Return value: %TRUE, if @parent has an @n<!-- -->th child.
1265 gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
1267 GtkTreeIter *parent,
1270 GtkTreeModelIface *iface;
1272 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1273 g_return_val_if_fail (iter != NULL, FALSE);
1274 g_return_val_if_fail (n >= 0, FALSE);
1276 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1277 g_return_val_if_fail (iface->iter_nth_child != NULL, FALSE);
1279 INITIALIZE_TREE_ITER (iter);
1281 return (* iface->iter_nth_child) (tree_model, iter, parent, n);
1285 * gtk_tree_model_iter_parent:
1286 * @tree_model: A #GtkTreeModel
1287 * @iter: The new #GtkTreeIter to set to the parent.
1288 * @child: The #GtkTreeIter.
1290 * Sets @iter to be the parent of @child. If @child is at the toplevel, and
1291 * doesn't have a parent, then @iter is set to an invalid iterator and %FALSE
1292 * is returned. @child will remain a valid node after this function has been
1295 * Return value: %TRUE, if @iter is set to the parent of @child.
1298 gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
1302 GtkTreeModelIface *iface;
1304 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1305 g_return_val_if_fail (iter != NULL, FALSE);
1306 g_return_val_if_fail (child != NULL, FALSE);
1308 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1309 g_return_val_if_fail (iface->iter_parent != NULL, FALSE);
1311 INITIALIZE_TREE_ITER (iter);
1313 return (* iface->iter_parent) (tree_model, iter, child);
1317 * gtk_tree_model_ref_node:
1318 * @tree_model: A #GtkTreeModel.
1319 * @iter: The #GtkTreeIter.
1321 * Lets the tree ref the node. This is an optional method for models to
1322 * implement. To be more specific, models may ignore this call as it exists
1323 * primarily for performance reasons.
1325 * This function is primarily meant as a way for views to let caching model
1326 * know when nodes are being displayed (and hence, whether or not to cache that
1327 * node.) For example, a file-system based model would not want to keep the
1328 * entire file-hierarchy in memory, just the sections that are currently being
1329 * displayed by every current view.
1331 * A model should be expected to be able to get an iter independent of its
1335 gtk_tree_model_ref_node (GtkTreeModel *tree_model,
1338 GtkTreeModelIface *iface;
1340 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1342 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1343 if (iface->ref_node)
1344 (* iface->ref_node) (tree_model, iter);
1348 * gtk_tree_model_unref_node:
1349 * @tree_model: A #GtkTreeModel.
1350 * @iter: The #GtkTreeIter.
1352 * Lets the tree unref the node. This is an optional method for models to
1353 * implement. To be more specific, models may ignore this call as it exists
1354 * primarily for performance reasons.
1356 * For more information on what this means, see gtk_tree_model_ref_node().
1357 * Please note that nodes that are deleted are not unreffed.
1360 gtk_tree_model_unref_node (GtkTreeModel *tree_model,
1363 GtkTreeModelIface *iface;
1365 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1366 g_return_if_fail (iter != NULL);
1368 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1369 if (iface->unref_node)
1370 (* iface->unref_node) (tree_model, iter);
1374 * gtk_tree_model_get:
1375 * @tree_model: a #GtkTreeModel
1376 * @iter: a row in @tree_model
1377 * @Varargs: pairs of column number and value return locations, terminated by -1
1379 * Gets the value of one or more cells in the row referenced by @iter.
1380 * The variable argument list should contain integer column numbers,
1381 * each column number followed by a place to store the value being
1382 * retrieved. The list is terminated by a -1. For example, to get a
1383 * value from column 0 with type %G_TYPE_STRING, you would
1384 * write: <literal>gtk_tree_model_get (model, iter, 0, &place_string_here, -1)</literal>,
1385 * where <literal>place_string_here</literal> is a <type>gchar*</type> to be
1386 * filled with the string.
1387 * If appropriate, the returned values have to be freed or unreferenced.
1391 gtk_tree_model_get (GtkTreeModel *tree_model,
1397 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1398 g_return_if_fail (iter != NULL);
1400 va_start (var_args, iter);
1401 gtk_tree_model_get_valist (tree_model, iter, var_args);
1406 * gtk_tree_model_get_valist:
1407 * @tree_model: a #GtkTreeModel
1408 * @iter: a row in @tree_model
1409 * @var_args: <type>va_list</type> of column/return location pairs
1411 * See gtk_tree_model_get(), this version takes a <type>va_list</type>
1412 * for language bindings to use.
1415 gtk_tree_model_get_valist (GtkTreeModel *tree_model,
1421 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1422 g_return_if_fail (iter != NULL);
1424 column = va_arg (var_args, gint);
1426 while (column != -1)
1428 GValue value = { 0, };
1429 gchar *error = NULL;
1431 if (column >= gtk_tree_model_get_n_columns (tree_model))
1433 g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
1437 gtk_tree_model_get_value (GTK_TREE_MODEL (tree_model), iter, column, &value);
1439 G_VALUE_LCOPY (&value, var_args, 0, &error);
1442 g_warning ("%s: %s", G_STRLOC, error);
1445 /* we purposely leak the value here, it might not be
1446 * in a sane state if an error condition occoured
1451 g_value_unset (&value);
1453 column = va_arg (var_args, gint);
1458 * gtk_tree_model_row_changed:
1459 * @tree_model: A #GtkTreeModel
1460 * @path: A #GtkTreePath pointing to the changed row
1461 * @iter: A valid #GtkTreeIter pointing to the changed row
1463 * Emits the "row_changed" signal on @tree_model.
1466 gtk_tree_model_row_changed (GtkTreeModel *tree_model,
1470 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1471 g_return_if_fail (path != NULL);
1472 g_return_if_fail (iter != NULL);
1474 g_signal_emit (tree_model, tree_model_signals[ROW_CHANGED], 0, path, iter);
1478 * gtk_tree_model_row_inserted:
1479 * @tree_model: A #GtkTreeModel
1480 * @path: A #GtkTreePath pointing to the inserted row
1481 * @iter: A valid #GtkTreeIter pointing to the inserted row
1483 * Emits the "row_inserted" signal on @tree_model
1486 gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
1490 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1491 g_return_if_fail (path != NULL);
1492 g_return_if_fail (iter != NULL);
1494 g_signal_emit (tree_model, tree_model_signals[ROW_INSERTED], 0, path, iter);
1498 * gtk_tree_model_row_has_child_toggled:
1499 * @tree_model: A #GtkTreeModel
1500 * @path: A #GtkTreePath pointing to the changed row
1501 * @iter: A valid #GtkTreeIter pointing to the changed row
1503 * Emits the "row_has_child_toggled" signal on @tree_model. This should be
1504 * called by models after the child state of a node changes.
1507 gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
1511 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1512 g_return_if_fail (path != NULL);
1513 g_return_if_fail (iter != NULL);
1515 g_signal_emit (tree_model, tree_model_signals[ROW_HAS_CHILD_TOGGLED], 0, path, iter);
1519 * gtk_tree_model_row_deleted:
1520 * @tree_model: A #GtkTreeModel
1521 * @path: A #GtkTreePath pointing to the previous location of the deleted row.
1523 * Emits the "row_deleted" signal on @tree_model. This should be called by
1524 * models after a row has been removed. The location pointed to by @path
1525 * should be the location that the row previously was at. It may not be a
1526 * valid location anymore.
1529 gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
1532 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1533 g_return_if_fail (path != NULL);
1535 g_signal_emit (tree_model, tree_model_signals[ROW_DELETED], 0, path);
1539 * gtk_tree_model_rows_reordered:
1540 * @tree_model: A #GtkTreeModel
1541 * @path: A #GtkTreePath pointing to the tree node whose children have been
1543 * @iter: A valid #GtkTreeIter pointing to the node whose children have been
1544 * reordered, or %NULL if the depth of @path is 0.
1545 * @new_order: an array of integers mapping the current position of each child
1546 * to its old position before the re-ordering,
1547 * i.e. @new_order<literal>[newpos] = oldpos</literal>.
1549 * Emits the "rows_reordered" signal on @tree_model. This should be called by
1550 * models when their rows have been reordered.
1553 gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
1558 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1559 g_return_if_fail (new_order != NULL);
1561 g_signal_emit (tree_model, tree_model_signals[ROWS_REORDERED], 0, path, iter, new_order);
1566 gtk_tree_model_foreach_helper (GtkTreeModel *model,
1569 GtkTreeModelForeachFunc func,
1576 if ((* func) (model, path, iter, user_data))
1579 if (gtk_tree_model_iter_children (model, &child, iter))
1581 gtk_tree_path_down (path);
1582 if (gtk_tree_model_foreach_helper (model, &child, path, func, user_data))
1584 gtk_tree_path_up (path);
1587 gtk_tree_path_next (path);
1589 while (gtk_tree_model_iter_next (model, iter));
1595 * gtk_tree_model_foreach:
1596 * @model: A #GtkTreeModel
1597 * @func: A function to be called on each row
1598 * @user_data: User data to passed to func.
1600 * Calls func on each node in model in a depth-first fashion.
1601 * If @func returns %TRUE, then the tree ceases to be walked, and
1602 * gtk_tree_model_foreach() returns.
1605 gtk_tree_model_foreach (GtkTreeModel *model,
1606 GtkTreeModelForeachFunc func,
1612 g_return_if_fail (GTK_IS_TREE_MODEL (model));
1613 g_return_if_fail (func != NULL);
1615 path = gtk_tree_path_new_first ();
1616 if (gtk_tree_model_get_iter (model, &iter, path) == FALSE)
1618 gtk_tree_path_free (path);
1622 gtk_tree_model_foreach_helper (model, &iter, path, func, user_data);
1623 gtk_tree_path_free (path);
1628 * GtkTreeRowReference
1631 static void gtk_tree_row_reference_unref_path (GtkTreePath *path,
1632 GtkTreeModel *model,
1637 gtk_tree_row_reference_get_type (void)
1639 static GType our_type = 0;
1642 our_type = g_boxed_type_register_static (I_("GtkTreeRowReference"),
1643 (GBoxedCopyFunc) gtk_tree_row_reference_copy,
1644 (GBoxedFreeFunc) gtk_tree_row_reference_free);
1650 struct _GtkTreeRowReference
1653 GtkTreeModel *model;
1659 release_row_references (gpointer data)
1661 RowRefList *refs = data;
1662 GSList *tmp_list = NULL;
1664 tmp_list = refs->list;
1665 while (tmp_list != NULL)
1667 GtkTreeRowReference *reference = tmp_list->data;
1669 if (reference->proxy == (GObject *)reference->model)
1670 reference->model = NULL;
1671 reference->proxy = NULL;
1673 /* we don't free the reference, users are responsible for that. */
1675 tmp_list = g_slist_next (tmp_list);
1678 g_slist_free (refs->list);
1683 gtk_tree_row_ref_inserted (RowRefList *refs,
1692 /* This function corrects the path stored in the reference to
1693 * account for an insertion. Note that it's called _after_ the insertion
1694 * with the path to the newly-inserted row. Which means that
1695 * the inserted path is in a different "coordinate system" than
1696 * the old path (e.g. if the inserted path was just before the old path,
1697 * then inserted path and old path will be the same, and old path must be
1701 tmp_list = refs->list;
1703 while (tmp_list != NULL)
1705 GtkTreeRowReference *reference = tmp_list->data;
1707 if (reference->path == NULL)
1710 if (reference->path->depth >= path->depth)
1713 gboolean ancestor = TRUE;
1715 for (i = 0; i < path->depth - 1; i ++)
1717 if (path->indices[i] != reference->path->indices[i])
1723 if (ancestor == FALSE)
1726 if (path->indices[path->depth-1] <= reference->path->indices[path->depth-1])
1727 reference->path->indices[path->depth-1] += 1;
1730 tmp_list = g_slist_next (tmp_list);
1735 gtk_tree_row_ref_deleted (RowRefList *refs,
1743 /* This function corrects the path stored in the reference to
1744 * account for an deletion. Note that it's called _after_ the
1745 * deletion with the old path of the just-deleted row. Which means
1746 * that the deleted path is the same now-defunct "coordinate system"
1747 * as the path saved in the reference, which is what we want to fix.
1750 tmp_list = refs->list;
1752 while (tmp_list != NULL)
1754 GtkTreeRowReference *reference = tmp_list->data;
1756 if (reference->path)
1760 if (path->depth > reference->path->depth)
1762 for (i = 0; i < path->depth - 1; i++)
1764 if (path->indices[i] != reference->path->indices[i])
1768 /* We know it affects us. */
1769 if (path->indices[i] == reference->path->indices[i])
1771 if (reference->path->depth > path->depth)
1772 /* some parent was deleted, trying to unref any node
1773 * between the deleted parent and the node the reference
1774 * is pointing to is bad, as those nodes are already gone.
1776 gtk_tree_row_reference_unref_path (reference->path, reference->model, path->depth - 1);
1778 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth - 1);
1779 gtk_tree_path_free (reference->path);
1780 reference->path = NULL;
1782 else if (path->indices[i] < reference->path->indices[i])
1784 reference->path->indices[path->depth-1]-=1;
1789 tmp_list = g_slist_next (tmp_list);
1794 gtk_tree_row_ref_reordered (RowRefList *refs,
1805 tmp_list = refs->list;
1807 while (tmp_list != NULL)
1809 GtkTreeRowReference *reference = tmp_list->data;
1811 length = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (reference->model), iter);
1816 if ((reference->path) &&
1817 (gtk_tree_path_is_ancestor (path, reference->path)))
1819 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1820 gint depth = gtk_tree_path_get_depth (path);
1822 if (ref_depth > depth)
1825 gint *indices = gtk_tree_path_get_indices (reference->path);
1827 for (i = 0; i < length; i++)
1829 if (new_order[i] == indices[depth])
1838 tmp_list = g_slist_next (tmp_list);
1842 /* We do this recursively so that we can unref children nodes before their parent */
1844 gtk_tree_row_reference_unref_path_helper (GtkTreePath *path,
1845 GtkTreeModel *model,
1846 GtkTreeIter *parent_iter,
1852 if (depth == current_depth)
1855 gtk_tree_model_iter_nth_child (model, &iter, parent_iter, path->indices[current_depth]);
1856 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, current_depth + 1);
1857 gtk_tree_model_unref_node (model, &iter);
1861 gtk_tree_row_reference_unref_path (GtkTreePath *path,
1862 GtkTreeModel *model,
1870 gtk_tree_model_iter_nth_child (model, &iter, NULL, path->indices[0]);
1871 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, 1);
1872 gtk_tree_model_unref_node (model, &iter);
1876 * gtk_tree_row_reference_new:
1877 * @model: A #GtkTreeModel
1878 * @path: A valid #GtkTreePath to monitor
1880 * Creates a row reference based on @path. This reference will keep pointing
1881 * to the node pointed to by @path, so long as it exists. It listens to all
1882 * signals emitted by @model, and updates its path appropriately. If @path
1883 * isn't a valid path in @model, then %NULL is returned.
1885 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1887 GtkTreeRowReference *
1888 gtk_tree_row_reference_new (GtkTreeModel *model,
1891 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1892 g_return_val_if_fail (path != NULL, NULL);
1894 /* We use the model itself as the proxy object; and call
1895 * gtk_tree_row_reference_inserted(), etc, in the
1896 * class closure (default handler) marshalers for the signal.
1898 return gtk_tree_row_reference_new_proxy (G_OBJECT (model), model, path);
1902 * gtk_tree_row_reference_new_proxy:
1903 * @proxy: A proxy #GObject
1904 * @model: A #GtkTreeModel
1905 * @path: A valid #GtkTreePath to monitor
1907 * You do not need to use this function. Creates a row reference based on
1908 * @path. This reference will keep pointing to the node pointed to by @path,
1909 * so long as it exists. If @path isn't a valid path in @model, then %NULL is
1910 * returned. However, unlike references created with
1911 * gtk_tree_row_reference_new(), it does not listen to the model for changes.
1912 * The creator of the row reference must do this explicitly using
1913 * gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(),
1914 * gtk_tree_row_reference_reordered().
1916 * These functions must be called exactly once per proxy when the
1917 * corresponding signal on the model is emitted. This single call
1918 * updates all row references for that proxy. Since built-in GTK+
1919 * objects like #GtkTreeView already use this mechanism internally,
1920 * using them as the proxy object will produce unpredictable results.
1921 * Further more, passing the same object as @model and @proxy
1922 * doesn't work for reasons of internal implementation.
1924 * This type of row reference is primarily meant by structures that need to
1925 * carefully monitor exactly when a row reference updates itself, and is not
1926 * generally needed by most applications.
1928 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1930 GtkTreeRowReference *
1931 gtk_tree_row_reference_new_proxy (GObject *proxy,
1932 GtkTreeModel *model,
1935 GtkTreeRowReference *reference;
1937 GtkTreeIter parent_iter;
1940 g_return_val_if_fail (G_IS_OBJECT (proxy), NULL);
1941 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1942 g_return_val_if_fail (path != NULL, NULL);
1943 g_return_val_if_fail (path->depth > 0, NULL);
1945 /* check that the path is valid */
1946 if (gtk_tree_model_get_iter (model, &parent_iter, path) == FALSE)
1949 /* Now we want to ref every node */
1950 gtk_tree_model_iter_nth_child (model, &parent_iter, NULL, path->indices[0]);
1951 gtk_tree_model_ref_node (model, &parent_iter);
1953 for (i = 1; i < path->depth; i++)
1956 gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, path->indices[i]);
1957 gtk_tree_model_ref_node (model, &iter);
1961 /* Make the row reference */
1962 reference = g_new (GtkTreeRowReference, 1);
1964 g_object_ref (proxy);
1965 g_object_ref (model);
1966 reference->proxy = proxy;
1967 reference->model = model;
1968 reference->path = gtk_tree_path_copy (path);
1970 refs = g_object_get_data (G_OBJECT (proxy), ROW_REF_DATA_STRING);
1974 refs = g_new (RowRefList, 1);
1977 g_object_set_data_full (G_OBJECT (proxy),
1978 I_(ROW_REF_DATA_STRING),
1979 refs, release_row_references);
1982 refs->list = g_slist_prepend (refs->list, reference);
1988 * gtk_tree_row_reference_get_path:
1989 * @reference: A #GtkTreeRowReference
1991 * Returns a path that the row reference currently points to, or %NULL if the
1992 * path pointed to is no longer valid.
1994 * Return value: A current path, or %NULL.
1997 gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
1999 g_return_val_if_fail (reference != NULL, NULL);
2001 if (reference->proxy == NULL)
2004 if (reference->path == NULL)
2007 return gtk_tree_path_copy (reference->path);
2011 * gtk_tree_row_reference_get_model:
2012 * @reference: A #GtkTreeRowReference
2014 * Returns the model that the row reference is monitoring.
2016 * Return value: the model
2021 gtk_tree_row_reference_get_model (GtkTreeRowReference *reference)
2023 g_return_val_if_fail (reference != NULL, NULL);
2025 return reference->model;
2029 * gtk_tree_row_reference_valid:
2030 * @reference: A #GtkTreeRowReference, or %NULL
2032 * Returns %TRUE if the @reference is non-%NULL and refers to a current valid
2035 * Return value: %TRUE if @reference points to a valid path.
2038 gtk_tree_row_reference_valid (GtkTreeRowReference *reference)
2040 if (reference == NULL || reference->path == NULL)
2048 * gtk_tree_row_reference_copy:
2049 * @reference: a #GtkTreeRowReference
2051 * Copies a #GtkTreeRowReference.
2053 * Return value: a copy of @reference.
2057 GtkTreeRowReference *
2058 gtk_tree_row_reference_copy (GtkTreeRowReference *reference)
2060 return gtk_tree_row_reference_new_proxy (reference->proxy,
2066 * gtk_tree_row_reference_free:
2067 * @reference: A #GtkTreeRowReference, or %NULL
2069 * Free's @reference. @reference may be %NULL.
2072 gtk_tree_row_reference_free (GtkTreeRowReference *reference)
2076 if (reference == NULL)
2079 refs = g_object_get_data (G_OBJECT (reference->proxy), ROW_REF_DATA_STRING);
2083 g_warning (G_STRLOC": bad row reference, proxy has no outstanding row references");
2087 refs->list = g_slist_remove (refs->list, reference);
2089 if (refs->list == NULL)
2091 g_object_set_data (G_OBJECT (reference->proxy),
2092 I_(ROW_REF_DATA_STRING),
2096 if (reference->path)
2098 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth);
2099 gtk_tree_path_free (reference->path);
2102 g_object_unref (reference->proxy);
2103 g_object_unref (reference->model);
2108 * gtk_tree_row_reference_inserted:
2109 * @proxy: A #GObject
2110 * @path: The row position that was inserted
2112 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
2113 * know that the model emitted the "row_inserted" signal.
2116 gtk_tree_row_reference_inserted (GObject *proxy,
2119 g_return_if_fail (G_IS_OBJECT (proxy));
2121 gtk_tree_row_ref_inserted ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path, NULL);
2125 * gtk_tree_row_reference_deleted:
2126 * @proxy: A #GObject
2127 * @path: The path position that was deleted
2129 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
2130 * know that the model emitted the "row_deleted" signal.
2133 gtk_tree_row_reference_deleted (GObject *proxy,
2136 g_return_if_fail (G_IS_OBJECT (proxy));
2138 gtk_tree_row_ref_deleted ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path);
2142 * gtk_tree_row_reference_reordered:
2143 * @proxy: A #GObject
2144 * @path: The parent path of the reordered signal
2145 * @iter: The iter pointing to the parent of the reordered
2146 * @new_order: The new order of rows
2148 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
2149 * know that the model emitted the "rows_reordered" signal.
2152 gtk_tree_row_reference_reordered (GObject *proxy,
2157 g_return_if_fail (G_IS_OBJECT (proxy));
2159 gtk_tree_row_ref_reordered ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path, iter, new_order);
2162 #define __GTK_TREE_MODEL_C__
2163 #include "gtkaliasdef.c"