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>
27 #include "gtktreemodel.h"
28 #include "gtktreeview.h"
29 #include "gtktreeprivate.h"
30 #include "gtkmarshalers.h"
33 #define INITIALIZE_TREE_ITER(Iter) \
36 (Iter)->user_data = NULL; \
37 (Iter)->user_data2 = NULL; \
38 (Iter)->user_data3 = NULL; \
41 #define ROW_REF_DATA_STRING "gtk-tree-row-refs"
46 ROW_HAS_CHILD_TOGGLED,
52 static guint tree_model_signals[LAST_SIGNAL] = { 0 };
65 static void gtk_tree_model_base_init (gpointer g_class);
68 static void row_inserted_marshal (GClosure *closure,
69 GValue /* out */ *return_value,
71 const GValue *param_values,
72 gpointer invocation_hint,
73 gpointer marshal_data);
74 static void row_deleted_marshal (GClosure *closure,
75 GValue /* out */ *return_value,
77 const GValue *param_values,
78 gpointer invocation_hint,
79 gpointer marshal_data);
80 static void rows_reordered_marshal (GClosure *closure,
81 GValue /* out */ *return_value,
83 const GValue *param_values,
84 gpointer invocation_hint,
85 gpointer marshal_data);
87 static void gtk_tree_row_ref_inserted (RowRefList *refs,
90 static void gtk_tree_row_ref_deleted (RowRefList *refs,
92 static void gtk_tree_row_ref_reordered (RowRefList *refs,
98 gtk_tree_model_get_type (void)
100 static GType tree_model_type = 0;
102 if (! tree_model_type)
104 static const GTypeInfo tree_model_info =
106 sizeof (GtkTreeModelIface), /* class_size */
107 gtk_tree_model_base_init, /* base_init */
108 NULL, /* base_finalize */
110 NULL, /* class_finalize */
111 NULL, /* class_data */
118 g_type_register_static (G_TYPE_INTERFACE, "GtkTreeModel",
119 &tree_model_info, 0);
121 g_type_interface_add_prerequisite (tree_model_type, G_TYPE_OBJECT);
124 return tree_model_type;
128 gtk_tree_model_base_init (gpointer g_class)
130 static gboolean initialized = FALSE;
135 GType row_inserted_params[2];
136 GType row_deleted_params[1];
137 GType rows_reordered_params[3];
139 row_inserted_params[0] = GTK_TYPE_TREE_PATH;
140 row_inserted_params[1] = GTK_TYPE_TREE_ITER;
142 row_deleted_params[0] = GTK_TYPE_TREE_PATH;
144 rows_reordered_params[0] = GTK_TYPE_TREE_PATH;
145 rows_reordered_params[1] = GTK_TYPE_TREE_ITER;
146 rows_reordered_params[2] = G_TYPE_POINTER;
148 tree_model_signals[ROW_CHANGED] =
149 g_signal_new ("row_changed",
152 G_STRUCT_OFFSET (GtkTreeModelIface, row_changed),
154 _gtk_marshal_VOID__BOXED_BOXED,
159 /* We need to get notification about structure changes
160 * to update row references., so instead of using the
161 * standard g_signal_new() with an offset into our interface
162 * structure, we use a customs closures for the class
163 * closures (default handlers) that first update row references
164 * and then calls the function from the interface structure.
166 * The reason we don't simply update the row references from
167 * the wrapper functions (gtk_tree_model_row_inserted(), etc.)
168 * is to keep proper ordering with respect to signal handlers
169 * connected normally and after.
171 closure = g_closure_new_simple (sizeof (GClosure), NULL);
172 g_closure_set_marshal (closure, row_inserted_marshal);
173 tree_model_signals[ROW_INSERTED] =
174 g_signal_newv ("row_inserted",
179 _gtk_marshal_VOID__BOXED_BOXED,
181 row_inserted_params);
183 tree_model_signals[ROW_HAS_CHILD_TOGGLED] =
184 g_signal_new ("row_has_child_toggled",
187 G_STRUCT_OFFSET (GtkTreeModelIface, row_has_child_toggled),
189 _gtk_marshal_VOID__BOXED_BOXED,
194 closure = g_closure_new_simple (sizeof (GClosure), NULL);
195 g_closure_set_marshal (closure, row_deleted_marshal);
196 tree_model_signals[ROW_DELETED] =
197 g_signal_newv ("row_deleted",
202 _gtk_marshal_VOID__BOXED,
206 closure = g_closure_new_simple (sizeof (GClosure), NULL);
207 g_closure_set_marshal (closure, rows_reordered_marshal);
208 tree_model_signals[ROWS_REORDERED] =
209 g_signal_newv ("rows_reordered",
214 _gtk_marshal_VOID__BOXED_BOXED_POINTER,
216 rows_reordered_params);
222 row_inserted_marshal (GClosure *closure,
223 GValue /* out */ *return_value,
224 guint n_param_values,
225 const GValue *param_values,
226 gpointer invocation_hint,
227 gpointer marshal_data)
229 GtkTreeModelIface *iface;
231 void (* row_inserted_callback) (GtkTreeModel *tree_model,
233 GtkTreeIter *iter) = 0;
235 GObject *model = g_value_get_object (param_values + 0);
236 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
237 GtkTreeIter *iter = (GtkTreeIter *)g_value_get_boxed (param_values + 2);
239 /* first, we need to update internal row references */
240 gtk_tree_row_ref_inserted ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
243 /* fetch the interface ->row_inserted implementation */
244 iface = GTK_TREE_MODEL_GET_IFACE (model);
245 row_inserted_callback = G_STRUCT_MEMBER (gpointer, iface,
246 G_STRUCT_OFFSET (GtkTreeModelIface,
249 /* Call that default signal handler, it if has been set */
250 if (row_inserted_callback)
251 row_inserted_callback (GTK_TREE_MODEL (model), path, iter);
255 row_deleted_marshal (GClosure *closure,
256 GValue /* out */ *return_value,
257 guint n_param_values,
258 const GValue *param_values,
259 gpointer invocation_hint,
260 gpointer marshal_data)
262 GtkTreeModelIface *iface;
263 void (* row_deleted_callback) (GtkTreeModel *tree_model,
264 GtkTreePath *path) = 0;
265 GObject *model = g_value_get_object (param_values + 0);
266 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
269 /* first, we need to update internal row references */
270 gtk_tree_row_ref_deleted ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
273 /* fetch the interface ->row_deleted implementation */
274 iface = GTK_TREE_MODEL_GET_IFACE (model);
275 row_deleted_callback = G_STRUCT_MEMBER (gpointer, iface,
276 G_STRUCT_OFFSET (GtkTreeModelIface,
279 /* Call that default signal handler, it if has been set */
280 if (row_deleted_callback)
281 row_deleted_callback (GTK_TREE_MODEL (model), path);
285 rows_reordered_marshal (GClosure *closure,
286 GValue /* out */ *return_value,
287 guint n_param_values,
288 const GValue *param_values,
289 gpointer invocation_hint,
290 gpointer marshal_data)
292 GtkTreeModelIface *iface;
293 void (* rows_reordered_callback) (GtkTreeModel *tree_model,
298 GObject *model = g_value_get_object (param_values + 0);
299 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
300 GtkTreeIter *iter = (GtkTreeIter *)g_value_get_boxed (param_values + 2);
301 gint *new_order = (gint *)g_value_get_pointer (param_values + 3);
303 /* first, we need to update internal row references */
304 gtk_tree_row_ref_reordered ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
305 path, iter, new_order);
307 /* fetch the interface ->rows_reordered implementation */
308 iface = GTK_TREE_MODEL_GET_IFACE (model);
309 rows_reordered_callback = G_STRUCT_MEMBER (gpointer, iface,
310 G_STRUCT_OFFSET (GtkTreeModelIface,
313 /* Call that default signal handler, it if has been set */
314 if (rows_reordered_callback)
315 rows_reordered_callback (GTK_TREE_MODEL (model), path, iter, new_order);
321 * Creates a new #GtkTreePath. This structure refers to a row.
323 * Return value: A newly created #GtkTreePath.
325 /* GtkTreePath Operations */
327 gtk_tree_path_new (void)
330 retval = (GtkTreePath *) g_new (GtkTreePath, 1);
332 retval->indices = NULL;
338 * gtk_tree_path_new_from_string:
339 * @path: The string representation of a path.
341 * Creates a new #GtkTreePath initialized to @path. @path is expected to be a
342 * colon separated list of numbers. For example, the string "10:4:0" would
343 * create a path of depth 3 pointing to the 11th child of the root node, the 5th
344 * child of that 11th child, and the 1st child of that 5th child. If an invalid
345 * path string is passed in, %NULL is returned.
347 * Return value: A newly-created #GtkTreePath, or %NULL
350 gtk_tree_path_new_from_string (const gchar *path)
353 const gchar *orig_path = path;
357 g_return_val_if_fail (path != NULL, NULL);
358 g_return_val_if_fail (*path != '\000', NULL);
360 retval = gtk_tree_path_new ();
364 i = strtol (path, &ptr, 10);
365 gtk_tree_path_append_index (retval, i);
369 g_warning (G_STRLOC ": Negative numbers in path %s passed to gtk_tree_path_new_from_string", orig_path);
370 gtk_tree_path_free (retval);
375 if (ptr == path || *ptr != ':')
377 g_warning (G_STRLOC ": Invalid path %s passed to gtk_tree_path_new_from_string", orig_path);
378 gtk_tree_path_free (retval);
388 * gtk_tree_path_new_from_indices:
389 * @first_index: first integer
390 * @varargs: list of integers terminated by -1
392 * Creates a new path with @first_index and @varargs as indices.
394 * Return value: A newly created GtkTreePath.
399 gtk_tree_path_new_from_indices (gint first_index,
406 path = gtk_tree_path_new ();
408 va_start (args, first_index);
413 gtk_tree_path_append_index (path, arg);
414 arg = va_arg (args, gint);
423 * gtk_tree_path_to_string:
424 * @path: A #GtkTreePath
426 * Generates a string representation of the path. This string is a ':'
427 * separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
429 * Return value: A newly-allocated string. Must be freed with g_free().
432 gtk_tree_path_to_string (GtkTreePath *path)
437 g_return_val_if_fail (path != NULL, NULL);
439 if (path->depth == 0)
442 ptr = retval = (gchar *) g_new0 (char *, path->depth*8);
443 g_sprintf (retval, "%d", path->indices[0]);
444 while (*ptr != '\000')
447 for (i = 1; i < path->depth; i++)
449 g_sprintf (ptr, ":%d", path->indices[i]);
450 while (*ptr != '\000')
458 * gtk_tree_path_new_first:
460 * Creates a new #GtkTreePath. The string representation of this path is "0"
462 * Return value: A new #GtkTreePath.
465 gtk_tree_path_new_first (void)
469 retval = gtk_tree_path_new ();
470 gtk_tree_path_append_index (retval, 0);
476 * gtk_tree_path_append_index:
477 * @path: A #GtkTreePath.
478 * @index_: The index.
480 * Appends a new index to a path. As a result, the depth of the path is
484 gtk_tree_path_append_index (GtkTreePath *path,
487 g_return_if_fail (path != NULL);
488 g_return_if_fail (index >= 0);
491 path->indices = g_realloc (path->indices, path->depth * sizeof(gint));
492 path->indices[path->depth - 1] = index;
496 * gtk_tree_path_prepend_index:
497 * @path: A #GtkTreePath.
498 * @index_: The index.
500 * Prepends a new index to a path. As a result, the depth of the path is
504 gtk_tree_path_prepend_index (GtkTreePath *path,
510 new_indices = g_new (gint, path->depth);
512 if (path->indices == NULL)
514 path->indices = new_indices;
515 path->indices[0] = index;
518 memcpy (new_indices + 1, path->indices, (path->depth - 1)*sizeof (gint));
519 g_free (path->indices);
520 path->indices = new_indices;
521 path->indices[0] = index;
525 * gtk_tree_path_get_depth:
526 * @path: A #GtkTreePath.
528 * Returns the current depth of @path.
530 * Return value: The depth of @path
533 gtk_tree_path_get_depth (GtkTreePath *path)
535 g_return_val_if_fail (path != NULL, 0);
541 * gtk_tree_path_get_indices:
542 * @path: A #GtkTreePath.
544 * Returns the current indices of @path. This is an array of integers, each
545 * representing a node in a tree. This value should not be freed.
547 * Return value: The current indices, or %NULL.
550 gtk_tree_path_get_indices (GtkTreePath *path)
552 g_return_val_if_fail (path != NULL, NULL);
554 return path->indices;
558 * gtk_tree_path_free:
559 * @path: A #GtkTreePath.
564 gtk_tree_path_free (GtkTreePath *path)
569 g_free (path->indices);
574 * gtk_tree_path_copy:
575 * @path: A #GtkTreePath.
577 * Creates a new #GtkTreePath as a copy of @path.
579 * Return value: A new #GtkTreePath.
582 gtk_tree_path_copy (const GtkTreePath *path)
586 g_return_val_if_fail (path != NULL, NULL);
588 retval = g_new (GtkTreePath, 1);
589 retval->depth = path->depth;
590 retval->indices = g_new (gint, path->depth);
591 memcpy (retval->indices, path->indices, path->depth * sizeof (gint));
596 gtk_tree_path_get_type (void)
598 static GType our_type = 0;
601 our_type = g_boxed_type_register_static ("GtkTreePath",
602 (GBoxedCopyFunc) gtk_tree_path_copy,
603 (GBoxedFreeFunc) gtk_tree_path_free);
609 * gtk_tree_path_compare:
610 * @a: A #GtkTreePath.
611 * @b: A #GtkTreePath to compare with.
613 * Compares two paths. If @a appears before @b in a tree, then -1 is returned.
614 * If @b appears before @a, then 1 is returned. If the two nodes are equal,
615 * then 0 is returned.
617 * Return value: The relative positions of @a and @b
620 gtk_tree_path_compare (const GtkTreePath *a,
621 const GtkTreePath *b)
625 g_return_val_if_fail (a != NULL, 0);
626 g_return_val_if_fail (b != NULL, 0);
627 g_return_val_if_fail (a->depth > 0, 0);
628 g_return_val_if_fail (b->depth > 0, 0);
632 if (a->indices[p] == b->indices[q])
634 return (a->indices[p] < b->indices[q]?-1:1);
636 while (++p < a->depth && ++q < b->depth);
637 if (a->depth == b->depth)
639 return (a->depth < b->depth?-1:1);
643 * gtk_tree_path_is_ancestor:
644 * @path: a #GtkTreePath
645 * @descendant: another #GtkTreePath
647 * Returns %TRUE if @descendant is a descendant of @path.
649 * Return value: %TRUE if @descendant is contained inside @path
652 gtk_tree_path_is_ancestor (GtkTreePath *path,
653 GtkTreePath *descendant)
657 g_return_val_if_fail (path != NULL, FALSE);
658 g_return_val_if_fail (descendant != NULL, FALSE);
660 /* can't be an ancestor if we're deeper */
661 if (path->depth >= descendant->depth)
665 while (i < path->depth)
667 if (path->indices[i] != descendant->indices[i])
676 * gtk_tree_path_is_descendant:
677 * @path: a #GtkTreePath
678 * @ancestor: another #GtkTreePath
680 * Returns %TRUE if @path is a descendant of @ancestor.
682 * Return value: %TRUE if @ancestor contains @path somewhere below it
685 gtk_tree_path_is_descendant (GtkTreePath *path,
686 GtkTreePath *ancestor)
690 g_return_val_if_fail (path != NULL, FALSE);
691 g_return_val_if_fail (ancestor != NULL, FALSE);
693 /* can't be a descendant if we're shallower in the tree */
694 if (path->depth <= ancestor->depth)
698 while (i < ancestor->depth)
700 if (path->indices[i] != ancestor->indices[i])
710 * gtk_tree_path_next:
711 * @path: A #GtkTreePath.
713 * Moves the @path to point to the next node at the current depth.
716 gtk_tree_path_next (GtkTreePath *path)
718 g_return_if_fail (path != NULL);
719 g_return_if_fail (path->depth > 0);
721 path->indices[path->depth - 1] ++;
725 * gtk_tree_path_prev:
726 * @path: A #GtkTreePath.
728 * Moves the @path to point to the previous node at the current depth, if it exists.
730 * Return value: %TRUE if @path has a previous node, and the move was made.
733 gtk_tree_path_prev (GtkTreePath *path)
735 g_return_val_if_fail (path != NULL, FALSE);
737 if (path->indices[path->depth - 1] == 0)
740 path->indices[path->depth - 1] -= 1;
747 * @path: A #GtkTreePath.
749 * Moves the @path to point to its parent node, if it has a parent.
751 * Return value: %TRUE if @path has a parent, and the move was made.
754 gtk_tree_path_up (GtkTreePath *path)
756 g_return_val_if_fail (path != NULL, FALSE);
758 if (path->depth == 0)
767 * gtk_tree_path_down:
768 * @path: A #GtkTreePath.
770 * Moves @path to point to the first child of the current path.
773 gtk_tree_path_down (GtkTreePath *path)
775 g_return_if_fail (path != NULL);
777 gtk_tree_path_append_index (path, 0);
781 * gtk_tree_iter_copy:
782 * @iter: A #GtkTreeIter.
784 * Creates a dynamically allocated tree iterator as a copy of @iter. This
785 * function is not intended for use in applications, because you can just copy
786 * the structs by value (<literal>GtkTreeIter new_iter = iter;</literal>). You
787 * must free this iter with gtk_tree_iter_free ().
789 * Return value: a newly-allocated copy of @iter.
792 gtk_tree_iter_copy (GtkTreeIter *iter)
796 g_return_val_if_fail (iter != NULL, NULL);
798 retval = g_new (GtkTreeIter, 1);
805 * gtk_tree_iter_free:
806 * @iter: A dynamically allocated tree iterator.
808 * Frees an iterator that has been allocated on the heap. This function is
809 * mainly used for language bindings.
812 gtk_tree_iter_free (GtkTreeIter *iter)
814 g_return_if_fail (iter != NULL);
820 gtk_tree_iter_get_type (void)
822 static GType our_type = 0;
825 our_type = g_boxed_type_register_static ("GtkTreeIter",
826 (GBoxedCopyFunc) gtk_tree_iter_copy,
827 (GBoxedFreeFunc) gtk_tree_iter_free);
833 * gtk_tree_model_get_flags:
834 * @tree_model: A #GtkTreeModel.
836 * Returns a set of flags supported by this interface. The flags are a bitwise
837 * combination of #GtkTreeModelFlags. The flags supported should not change
838 * during the lifecycle of the tree_model.
840 * Return value: The flags supported by this interface.
843 gtk_tree_model_get_flags (GtkTreeModel *tree_model)
845 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
847 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags)
848 return (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags) (tree_model);
854 * gtk_tree_model_get_n_columns:
855 * @tree_model: A #GtkTreeModel.
857 * Returns the number of columns supported by @tree_model.
859 * Return value: The number of columns.
862 gtk_tree_model_get_n_columns (GtkTreeModel *tree_model)
864 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
865 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns != NULL, 0);
867 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns) (tree_model);
871 * gtk_tree_model_get_column_type:
872 * @tree_model: A #GtkTreeModel.
873 * @index_: The column index.
875 * Returns the type of the column.
877 * Return value: The type of the column.
880 gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
883 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), G_TYPE_INVALID);
884 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type != NULL, G_TYPE_INVALID);
885 g_return_val_if_fail (index >= 0, G_TYPE_INVALID);
887 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type) (tree_model, index);
891 * gtk_tree_model_get_iter:
892 * @tree_model: A #GtkTreeModel.
893 * @iter: The uninitialized #GtkTreeIter.
894 * @path: The #GtkTreePath.
896 * Sets @iter to a valid iterator pointing to @path.
898 * Return value: %TRUE, if @iter was set.
901 gtk_tree_model_get_iter (GtkTreeModel *tree_model,
905 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
906 g_return_val_if_fail (iter != NULL, FALSE);
907 g_return_val_if_fail (path != NULL, FALSE);
908 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter != NULL, FALSE);
909 g_return_val_if_fail (path->depth > 0, FALSE);
911 INITIALIZE_TREE_ITER (iter);
913 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter) (tree_model, iter, path);
917 * gtk_tree_model_get_iter_from_string:
918 * @tree_model: A #GtkTreeModel.
919 * @iter: An uninitialized #GtkTreeIter.
920 * @path_string: A string representation of a #GtkTreePath.
922 * Sets @iter to a valid iterator pointing to @path_string, if it
923 * exists. Otherwise, @iter is left invalid and %FALSE is returned.
925 * Return value: %TRUE, if @iter was set.
928 gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
930 const gchar *path_string)
935 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
936 g_return_val_if_fail (iter != NULL, FALSE);
937 g_return_val_if_fail (path_string != NULL, FALSE);
939 path = gtk_tree_path_new_from_string (path_string);
941 g_return_val_if_fail (path != NULL, FALSE);
943 retval = gtk_tree_model_get_iter (tree_model, iter, path);
944 gtk_tree_path_free (path);
950 * gtk_tree_model_get_string_from_iter:
951 * @tree_model: A #GtkTreeModel.
952 * @iter: An #GtkTreeIter.
954 * Generates a string representation of the iter. This string is a ':'
955 * separated list of numbers. For example, "4:10:0:3" would be an
956 * acceptable return value for this string.
958 * Return value: A newly-allocated string. Must be freed with g_free().
963 gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
969 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
970 g_return_val_if_fail (iter != NULL, NULL);
972 path = gtk_tree_model_get_path (tree_model, iter);
974 g_return_val_if_fail (path != NULL, NULL);
976 ret = gtk_tree_path_to_string (path);
977 gtk_tree_path_free (path);
983 * gtk_tree_model_get_iter_first:
984 * @tree_model: A #GtkTreeModel.
985 * @iter: The uninitialized #GtkTreeIter.
987 * Initializes @iter with the first iterator in the tree (the one at the path
988 * "0") and returns %TRUE. Returns %FALSE if the tree is empty.
990 * Return value: %TRUE, if @iter was set.
993 gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
999 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1000 g_return_val_if_fail (iter != NULL, FALSE);
1002 path = gtk_tree_path_new_first ();
1003 retval = gtk_tree_model_get_iter (tree_model, iter, path);
1004 gtk_tree_path_free (path);
1010 * gtk_tree_model_get_path:
1011 * @tree_model: A #GtkTreeModel.
1012 * @iter: The #GtkTreeIter.
1014 * Returns a newly-created #GtkTreePath referenced by @iter. This path should
1015 * be freed with gtk_tree_path_free().
1017 * Return value: a newly-created #GtkTreePath.
1020 gtk_tree_model_get_path (GtkTreeModel *tree_model,
1023 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
1024 g_return_val_if_fail (iter != NULL, NULL);
1025 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path != NULL, NULL);
1027 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path) (tree_model, iter);
1031 * gtk_tree_model_get_value:
1032 * @tree_model: A #GtkTreeModel.
1033 * @iter: The #GtkTreeIter.
1034 * @column: The column to lookup the value at.
1035 * @value: An empty #GValue to set.
1037 * Sets initializes and sets @value to that at @column. When done with @value,
1038 * g_value_unset() needs to be called to free any allocated memory.
1041 gtk_tree_model_get_value (GtkTreeModel *tree_model,
1046 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1047 g_return_if_fail (iter != NULL);
1048 g_return_if_fail (value != NULL);
1049 g_return_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value != NULL);
1051 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value) (tree_model, iter, column, value);
1055 * gtk_tree_model_iter_next:
1056 * @tree_model: A #GtkTreeModel.
1057 * @iter: The #GtkTreeIter.
1059 * Sets @iter to point to the node following it at the current level. If there
1060 * is no next @iter, %FALSE is returned and @iter is set to be invalid.
1062 * Return value: %TRUE if @iter has been changed to the next node.
1065 gtk_tree_model_iter_next (GtkTreeModel *tree_model,
1068 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1069 g_return_val_if_fail (iter != NULL, FALSE);
1070 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next != NULL, FALSE);
1072 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next) (tree_model, iter);
1076 * gtk_tree_model_iter_children:
1077 * @tree_model: A #GtkTreeModel.
1078 * @iter: The new #GtkTreeIter to be set to the child.
1079 * @parent: The #GtkTreeIter, or %NULL
1081 * Sets @iter to point to the first child of @parent. If @parent has no children,
1082 * %FALSE is returned and @iter is set to be invalid. @parent will remain a valid
1083 * node after this function has been called.
1085 * If @parent is %NULL returns the first node, equivalent to
1086 * <literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal>
1088 * Return value: %TRUE, if @child has been set to the first child.
1091 gtk_tree_model_iter_children (GtkTreeModel *tree_model,
1093 GtkTreeIter *parent)
1095 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1096 g_return_val_if_fail (iter != NULL, FALSE);
1097 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children != NULL, FALSE);
1099 INITIALIZE_TREE_ITER (iter);
1101 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children) (tree_model, iter, parent);
1105 * gtk_tree_model_iter_has_child:
1106 * @tree_model: A #GtkTreeModel.
1107 * @iter: The #GtkTreeIter to test for children.
1109 * Returns %TRUE if @iter has children, %FALSE otherwise.
1111 * Return value: %TRUE if @iter has children.
1114 gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
1117 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1118 g_return_val_if_fail (iter != NULL, FALSE);
1119 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child != NULL, FALSE);
1121 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child) (tree_model, iter);
1125 * gtk_tree_model_iter_n_children:
1126 * @tree_model: A #GtkTreeModel.
1127 * @iter: The #GtkTreeIter, or %NULL.
1129 * Returns the number of children that @iter has. As a special case, if @iter
1130 * is %NULL, then the number of toplevel nodes is returned.
1132 * Return value: The number of children of @iter.
1135 gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
1138 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
1139 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children != NULL, 0);
1141 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children) (tree_model, iter);
1145 * gtk_tree_model_iter_nth_child:
1146 * @tree_model: A #GtkTreeModel.
1147 * @iter: The #GtkTreeIter to set to the nth child.
1148 * @parent: The #GtkTreeIter to get the child from, or %NULL.
1149 * @n: Then index of the desired child.
1151 * Sets @iter to be the child of @parent, using the given index. The first
1152 * index is 0. If @n is too big, or @parent has no children, @iter is set
1153 * to an invalid iterator and %FALSE is returned. @parent will remain a valid
1154 * node after this function has been called. As a special case, if @parent is
1155 * %NULL, then the @n<!-- -->th root node is set.
1157 * Return value: %TRUE, if @parent has an @n<!-- -->th child.
1160 gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
1162 GtkTreeIter *parent,
1165 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1166 g_return_val_if_fail (iter != NULL, FALSE);
1167 g_return_val_if_fail (n >= 0, FALSE);
1168 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child != NULL, FALSE);
1170 INITIALIZE_TREE_ITER (iter);
1172 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child) (tree_model, iter, parent, n);
1176 * gtk_tree_model_iter_parent:
1177 * @tree_model: A #GtkTreeModel
1178 * @iter: The new #GtkTreeIter to set to the parent.
1179 * @child: The #GtkTreeIter.
1181 * Sets @iter to be the parent of @child. If @child is at the toplevel, and
1182 * doesn't have a parent, then @iter is set to an invalid iterator and %FALSE
1183 * is returned. @child will remain a valid node after this function has been
1186 * Return value: %TRUE, if @iter is set to the parent of @child.
1189 gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
1193 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1194 g_return_val_if_fail (iter != NULL, FALSE);
1195 g_return_val_if_fail (child != NULL, FALSE);
1196 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent != NULL, FALSE);
1198 INITIALIZE_TREE_ITER (iter);
1200 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent) (tree_model, iter, child);
1204 * gtk_tree_model_ref_node:
1205 * @tree_model: A #GtkTreeModel.
1206 * @iter: The #GtkTreeIter.
1208 * Lets the tree ref the node. This is an optional method for models to
1209 * implement. To be more specific, models may ignore this call as it exists
1210 * primarily for performance reasons.
1212 * This function is primarily meant as a way for views to let caching model know
1213 * when nodes are being displayed (and hence, whether or not to cache that
1214 * node.) For example, a file-system based model would not want to keep the
1215 * entire file-hierarchy in memory, just the sections that are currently being
1216 * displayed by every current view.
1218 * A model should be expected to be able to get an iter independent of its
1222 gtk_tree_model_ref_node (GtkTreeModel *tree_model,
1225 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1227 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node)
1228 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node) (tree_model, iter);
1232 * gtk_tree_model_unref_node:
1233 * @tree_model: A #GtkTreeModel.
1234 * @iter: The #GtkTreeIter.
1236 * Lets the tree unref the node. This is an optional method for models to
1237 * implement. To be more specific, models may ignore this call as it exists
1238 * primarily for performance reasons.
1240 * For more information on what this means, see gtk_tree_model_ref_node().
1241 * Please note that nodes that are deleted are not unreffed.
1244 gtk_tree_model_unref_node (GtkTreeModel *tree_model,
1247 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1248 g_return_if_fail (iter != NULL);
1250 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node)
1251 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node) (tree_model, iter);
1255 * gtk_tree_model_get:
1256 * @tree_model: a #GtkTreeModel
1257 * @iter: a row in @tree_model
1258 * @Varargs: pairs of column number and value return locations, terminated by -1
1260 * Gets the value of one or more cells in the row referenced by @iter.
1261 * The variable argument list should contain integer column numbers,
1262 * each column number followed by a place to store the value being
1263 * retrieved. The list is terminated by a -1. For example, to get a
1264 * value from column 0 with type %G_TYPE_STRING, you would
1265 * write: <literal>gtk_tree_model_get (model, iter, 0, &place_string_here, -1)</literal>,
1266 * where <literal>place_string_here</literal> is a <type>gchar*</type> to be
1267 * filled with the string.
1268 * If appropriate, the returned values have to be freed or unreferenced.
1272 gtk_tree_model_get (GtkTreeModel *tree_model,
1278 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1279 g_return_if_fail (iter != NULL);
1281 va_start (var_args, iter);
1282 gtk_tree_model_get_valist (tree_model, iter, var_args);
1287 * gtk_tree_model_get_valist:
1288 * @tree_model: a #GtkTreeModel
1289 * @iter: a row in @tree_model
1290 * @var_args: <type>va_list</type> of column/return location pairs
1292 * See gtk_tree_model_get(), this version takes a <type>va_list</type>
1293 * for language bindings to use.
1296 gtk_tree_model_get_valist (GtkTreeModel *tree_model,
1302 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1303 g_return_if_fail (iter != NULL);
1305 column = va_arg (var_args, gint);
1307 while (column != -1)
1309 GValue value = { 0, };
1310 gchar *error = NULL;
1312 if (column >= gtk_tree_model_get_n_columns (tree_model))
1314 g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
1318 gtk_tree_model_get_value (GTK_TREE_MODEL (tree_model), iter, column, &value);
1320 G_VALUE_LCOPY (&value, var_args, 0, &error);
1323 g_warning ("%s: %s", G_STRLOC, error);
1326 /* we purposely leak the value here, it might not be
1327 * in a sane state if an error condition occoured
1332 g_value_unset (&value);
1334 column = va_arg (var_args, gint);
1339 * gtk_tree_model_row_changed:
1340 * @tree_model: A #GtkTreeModel
1341 * @path: A #GtkTreePath pointing to the changed row
1342 * @iter: A valid #GtkTreeIter pointing to the changed row
1344 * Emits the "row_changed" signal on @tree_model.
1347 gtk_tree_model_row_changed (GtkTreeModel *tree_model,
1351 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1352 g_return_if_fail (path != NULL);
1353 g_return_if_fail (iter != NULL);
1355 g_signal_emit (tree_model, tree_model_signals[ROW_CHANGED], 0, path, iter);
1359 * gtk_tree_model_row_inserted:
1360 * @tree_model: A #GtkTreeModel
1361 * @path: A #GtkTreePath pointing to the inserted row
1362 * @iter: A valid #GtkTreeIter pointing to the inserted row
1364 * Emits the "row_inserted" signal on @tree_model
1367 gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
1371 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1372 g_return_if_fail (path != NULL);
1373 g_return_if_fail (iter != NULL);
1375 g_signal_emit (tree_model, tree_model_signals[ROW_INSERTED], 0, path, iter);
1379 * gtk_tree_model_row_has_child_toggled:
1380 * @tree_model: A #GtkTreeModel
1381 * @path: A #GtkTreePath pointing to the changed row
1382 * @iter: A valid #GtkTreeIter pointing to the changed row
1384 * Emits the "row_has_child_toggled" signal on @tree_model. This should be
1385 * called by models after the child state of a node changes.
1388 gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
1392 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1393 g_return_if_fail (path != NULL);
1394 g_return_if_fail (iter != NULL);
1396 g_signal_emit (tree_model, tree_model_signals[ROW_HAS_CHILD_TOGGLED], 0, path, iter);
1400 * gtk_tree_model_row_deleted:
1401 * @tree_model: A #GtkTreeModel
1402 * @path: A #GtkTreePath pointing to the previous location of the deleted row.
1404 * Emits the "row_deleted" signal on @tree_model. This should be called by
1405 * models after a row has been removed. The location pointed to by @path should
1406 * be the location that the row previously was at. It may not be a valid
1410 gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
1413 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1414 g_return_if_fail (path != NULL);
1416 g_signal_emit (tree_model, tree_model_signals[ROW_DELETED], 0, path);
1420 * gtk_tree_model_rows_reordered:
1421 * @tree_model: A #GtkTreeModel
1422 * @path: A #GtkTreePath pointing to the tree node whose children have been reordered
1423 * @iter: A valid #GtkTreeIter pointing to the node whose children have been reordered
1424 * @new_order: an array of integers mapping the current position of each child
1425 * to its old position before the re-ordering,
1426 * i.e. @new_order<literal>[newpos] = oldpos</literal>.
1428 * Emits the "rows_reordered" signal on @tree_model. This should be called by
1429 * models when their rows have been reordered.
1432 gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
1437 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1438 g_return_if_fail (new_order != NULL);
1440 g_signal_emit (tree_model, tree_model_signals[ROWS_REORDERED], 0, path, iter, new_order);
1445 gtk_tree_model_foreach_helper (GtkTreeModel *model,
1448 GtkTreeModelForeachFunc func,
1455 if ((* func) (model, path, iter, user_data))
1458 if (gtk_tree_model_iter_children (model, &child, iter))
1460 gtk_tree_path_down (path);
1461 if (gtk_tree_model_foreach_helper (model, &child, path, func, user_data))
1463 gtk_tree_path_up (path);
1466 gtk_tree_path_next (path);
1468 while (gtk_tree_model_iter_next (model, iter));
1474 * gtk_tree_model_foreach:
1475 * @model: A #GtkTreeModel
1476 * @func: A function to be called on each row
1477 * @user_data: User data to passed to func.
1479 * Calls func on each node in model in a depth-first fashion. If func returns
1480 * %TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach() returns.
1484 gtk_tree_model_foreach (GtkTreeModel *model,
1485 GtkTreeModelForeachFunc func,
1491 g_return_if_fail (GTK_IS_TREE_MODEL (model));
1492 g_return_if_fail (func != NULL);
1494 path = gtk_tree_path_new_first ();
1495 if (gtk_tree_model_get_iter (model, &iter, path) == FALSE)
1497 gtk_tree_path_free (path);
1501 gtk_tree_model_foreach_helper (model, &iter, path, func, user_data);
1502 gtk_tree_path_free (path);
1507 * GtkTreeRowReference
1510 static void gtk_tree_row_reference_unref_path (GtkTreePath *path,
1511 GtkTreeModel *model,
1516 gtk_tree_row_reference_get_type (void)
1518 static GType our_type = 0;
1521 our_type = g_boxed_type_register_static ("GtkTreeRowReference",
1522 (GBoxedCopyFunc) gtk_tree_row_reference_copy,
1523 (GBoxedFreeFunc) gtk_tree_row_reference_free);
1529 struct _GtkTreeRowReference
1532 GtkTreeModel *model;
1538 release_row_references (gpointer data)
1540 RowRefList *refs = data;
1541 GSList *tmp_list = NULL;
1543 tmp_list = refs->list;
1544 while (tmp_list != NULL)
1546 GtkTreeRowReference *reference = tmp_list->data;
1548 if (reference->proxy == (GObject *)reference->model)
1549 reference->model = NULL;
1550 reference->proxy = NULL;
1552 /* we don't free the reference, users are responsible for that. */
1554 tmp_list = g_slist_next (tmp_list);
1557 g_slist_free (refs->list);
1562 gtk_tree_row_ref_inserted (RowRefList *refs,
1571 /* This function corrects the path stored in the reference to
1572 * account for an insertion. Note that it's called _after_ the insertion
1573 * with the path to the newly-inserted row. Which means that
1574 * the inserted path is in a different "coordinate system" than
1575 * the old path (e.g. if the inserted path was just before the old path,
1576 * then inserted path and old path will be the same, and old path must be
1580 tmp_list = refs->list;
1582 while (tmp_list != NULL)
1584 GtkTreeRowReference *reference = tmp_list->data;
1586 if (reference->path == NULL)
1589 if (reference->path->depth >= path->depth)
1592 gboolean ancestor = TRUE;
1594 for (i = 0; i < path->depth - 1; i ++)
1596 if (path->indices[i] != reference->path->indices[i])
1602 if (ancestor == FALSE)
1605 if (path->indices[path->depth-1] <= reference->path->indices[path->depth-1])
1606 reference->path->indices[path->depth-1] += 1;
1609 tmp_list = g_slist_next (tmp_list);
1614 gtk_tree_row_ref_deleted (RowRefList *refs,
1622 /* This function corrects the path stored in the reference to
1623 * account for an deletion. Note that it's called _after_ the
1624 * deletion with the old path of the just-deleted row. Which means
1625 * that the deleted path is the same now-defunct "coordinate system"
1626 * as the path saved in the reference, which is what we want to fix.
1629 tmp_list = refs->list;
1631 while (tmp_list != NULL)
1633 GtkTreeRowReference *reference = tmp_list->data;
1635 if (reference->path)
1639 if (path->depth > reference->path->depth)
1641 for (i = 0; i < path->depth - 1; i++)
1643 if (path->indices[i] != reference->path->indices[i])
1647 /* We know it affects us. */
1648 if (path->indices[i] == reference->path->indices[i])
1650 if (reference->path->depth > path->depth)
1651 /* some parent was deleted, trying to unref any node
1652 * between the deleted parent and the node the reference
1653 * is pointing to is bad, as those nodes are already gone.
1655 gtk_tree_row_reference_unref_path (reference->path, reference->model, path->depth - 1);
1657 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth - 1);
1658 gtk_tree_path_free (reference->path);
1659 reference->path = NULL;
1661 else if (path->indices[i] < reference->path->indices[i])
1663 reference->path->indices[path->depth-1]-=1;
1668 tmp_list = g_slist_next (tmp_list);
1673 gtk_tree_row_ref_reordered (RowRefList *refs,
1684 tmp_list = refs->list;
1686 while (tmp_list != NULL)
1688 GtkTreeRowReference *reference = tmp_list->data;
1690 length = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (reference->model), iter);
1695 if ((reference->path) &&
1696 (gtk_tree_path_is_ancestor (path, reference->path)))
1698 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1699 gint depth = gtk_tree_path_get_depth (path);
1701 if (ref_depth > depth)
1704 gint *indices = gtk_tree_path_get_indices (reference->path);
1706 for (i = 0; i < length; i++)
1708 if (new_order[i] == indices[depth])
1717 tmp_list = g_slist_next (tmp_list);
1721 /* We do this recursively so that we can unref children nodes before their parent */
1723 gtk_tree_row_reference_unref_path_helper (GtkTreePath *path,
1724 GtkTreeModel *model,
1725 GtkTreeIter *parent_iter,
1731 if (depth == current_depth)
1734 gtk_tree_model_iter_nth_child (model, &iter, parent_iter, path->indices[current_depth]);
1735 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, current_depth + 1);
1736 gtk_tree_model_unref_node (model, &iter);
1740 gtk_tree_row_reference_unref_path (GtkTreePath *path,
1741 GtkTreeModel *model,
1749 gtk_tree_model_iter_nth_child (model, &iter, NULL, path->indices[0]);
1750 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, 1);
1751 gtk_tree_model_unref_node (model, &iter);
1755 * gtk_tree_row_reference_new:
1756 * @model: A #GtkTreeModel
1757 * @path: A valid #GtkTreePath to monitor
1759 * Creates a row reference based on @path. This reference will keep pointing to
1760 * the node pointed to by @path, so long as it exists. It listens to all
1761 * signals emitted by @model, and updates its path appropriately. If @path
1762 * isn't a valid path in @model, then %NULL is returned.
1764 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1766 GtkTreeRowReference *
1767 gtk_tree_row_reference_new (GtkTreeModel *model,
1770 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1771 g_return_val_if_fail (path != NULL, NULL);
1773 /* We use the model itself as the proxy object; and call
1774 * gtk_tree_row_reference_inserted(), etc, in the
1775 * class closure (default handler) marshalers for the signal.
1777 return gtk_tree_row_reference_new_proxy (G_OBJECT (model), model, path);
1781 * gtk_tree_row_reference_new_proxy:
1782 * @proxy: A proxy #GObject
1783 * @model: A #GtkTreeModel
1784 * @path: A valid #GtkTreePath to monitor
1786 * You do not need to use this function. Creates a row reference based on
1787 * @path. This reference will keep pointing to the node pointed to by @path, so
1788 * long as it exists. If @path isn't a valid path in @model, then %NULL is
1789 * returned. However, unlike references created with
1790 * gtk_tree_row_reference_new(), it does not listen to the model for changes.
1791 * The creator of the row reference must do this explicitly using
1792 * gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(),
1793 * gtk_tree_row_reference_reordered().
1795 * These functions must be called exactly once per proxy when the
1796 * corresponding signal on the model is emitted. This single call
1797 * updates all row references for that proxy. Since built-in GTK+
1798 * objects like #GtkTreeView already use this mechanism internally,
1799 * using them as the proxy object will produce unpredictable results.
1800 * Further more, passing the same object as @model and @proxy
1801 * doesn't work for reasons of internal implementation.
1803 * This type of row reference is primarily meant by structures that need to
1804 * carefully monitor exactly when a row_reference updates itself, and is not
1805 * generally needed by most applications.
1807 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1809 GtkTreeRowReference *
1810 gtk_tree_row_reference_new_proxy (GObject *proxy,
1811 GtkTreeModel *model,
1814 GtkTreeRowReference *reference;
1816 GtkTreeIter parent_iter;
1819 g_return_val_if_fail (G_IS_OBJECT (proxy), NULL);
1820 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1821 g_return_val_if_fail (path != NULL, NULL);
1822 g_return_val_if_fail (path->depth > 0, NULL);
1824 /* check that the path is valid */
1825 if (gtk_tree_model_get_iter (model, &parent_iter, path) == FALSE)
1828 /* Now we want to ref every node */
1829 gtk_tree_model_iter_nth_child (model, &parent_iter, NULL, path->indices[0]);
1830 gtk_tree_model_ref_node (model, &parent_iter);
1832 for (i = 1; i < path->depth; i++)
1835 gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, path->indices[i]);
1836 gtk_tree_model_ref_node (model, &iter);
1840 /* Make the row reference */
1841 reference = g_new (GtkTreeRowReference, 1);
1843 g_object_ref (proxy);
1844 g_object_ref (model);
1845 reference->proxy = proxy;
1846 reference->model = model;
1847 reference->path = gtk_tree_path_copy (path);
1849 refs = g_object_get_data (G_OBJECT (proxy), ROW_REF_DATA_STRING);
1853 refs = g_new (RowRefList, 1);
1856 g_object_set_data_full (G_OBJECT (proxy),
1857 ROW_REF_DATA_STRING,
1858 refs, release_row_references);
1861 refs->list = g_slist_prepend (refs->list, reference);
1867 * gtk_tree_row_reference_get_path:
1868 * @reference: A #GtkTreeRowReference
1870 * Returns a path that the row reference currently points to, or %NULL if the
1871 * path pointed to is no longer valid.
1873 * Return value: A current path, or %NULL.
1876 gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
1878 g_return_val_if_fail (reference != NULL, NULL);
1880 if (reference->proxy == NULL)
1883 if (reference->path == NULL)
1886 return gtk_tree_path_copy (reference->path);
1890 * gtk_tree_row_reference_valid:
1891 * @reference: A #GtkTreeRowReference, or NULL
1893 * Returns TRUE if the %reference is non-NULL and refers to a current valid
1896 * Return value: TRUE if %reference points to a valid path.
1899 gtk_tree_row_reference_valid (GtkTreeRowReference *reference)
1901 if (reference == NULL || reference->path == NULL)
1909 * gtk_tree_row_reference_copy:
1910 * @reference: a #GtkTreeRowReference
1912 * Copies a #GtkTreeRowReference.
1914 * Return value: a copy of @reference.
1918 GtkTreeRowReference *
1919 gtk_tree_row_reference_copy (GtkTreeRowReference *reference)
1921 return gtk_tree_row_reference_new_proxy (reference->proxy,
1927 * gtk_tree_row_reference_free:
1928 * @reference: A #GtkTreeRowReference, or NULL
1930 * Free's %reference. %reference may be NULL.
1933 gtk_tree_row_reference_free (GtkTreeRowReference *reference)
1937 if (reference == NULL)
1940 refs = g_object_get_data (G_OBJECT (reference->proxy), ROW_REF_DATA_STRING);
1944 g_warning (G_STRLOC": bad row reference, proxy has no outstanding row references");
1948 refs->list = g_slist_remove (refs->list, reference);
1950 if (refs->list == NULL)
1952 g_object_set_data (G_OBJECT (reference->proxy),
1953 ROW_REF_DATA_STRING,
1957 if (reference->path)
1959 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth);
1960 gtk_tree_path_free (reference->path);
1963 g_object_unref (reference->proxy);
1964 g_object_unref (reference->model);
1969 * gtk_tree_row_reference_inserted:
1970 * @proxy: A #GObject
1971 * @path: The row position that was inserted
1973 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
1974 * know that the model emitted the "row_inserted" signal.
1977 gtk_tree_row_reference_inserted (GObject *proxy,
1980 g_return_if_fail (G_IS_OBJECT (proxy));
1982 gtk_tree_row_ref_inserted ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path, NULL);
1986 * gtk_tree_row_reference_deleted:
1987 * @proxy: A #GObject
1988 * @path: The path position that was deleted
1990 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
1991 * know that the model emitted the "row_deleted" signal.
1994 gtk_tree_row_reference_deleted (GObject *proxy,
1997 g_return_if_fail (G_IS_OBJECT (proxy));
1999 gtk_tree_row_ref_deleted ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path);
2003 * gtk_tree_row_reference_reordered:
2004 * @proxy: A #GObject
2005 * @path: The parent path of the reordered signal
2006 * @iter: The iter pointing to the parent of the reordered
2007 * @new_order: The new order of rows
2009 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
2010 * know that the model emitted the "rows_reordered" signal.
2013 gtk_tree_row_reference_reordered (GObject *proxy,
2018 g_return_if_fail (G_IS_OBJECT (proxy));
2020 gtk_tree_row_ref_reordered ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path, iter, new_order);