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;
141 row_inserted_params[1] = GTK_TYPE_TREE_ITER;
143 row_deleted_params[0] = GTK_TYPE_TREE_PATH;
145 rows_reordered_params[0] = GTK_TYPE_TREE_PATH;
146 rows_reordered_params[1] = GTK_TYPE_TREE_ITER;
147 rows_reordered_params[2] = G_TYPE_POINTER;
149 tree_model_signals[ROW_CHANGED] =
150 g_signal_new (I_("row_changed"),
153 G_STRUCT_OFFSET (GtkTreeModelIface, row_changed),
155 _gtk_marshal_VOID__BOXED_BOXED,
160 /* We need to get notification about structure changes
161 * to update row references., so instead of using the
162 * standard g_signal_new() with an offset into our interface
163 * structure, we use a customs closures for the class
164 * closures (default handlers) that first update row references
165 * and then calls the function from the interface structure.
167 * The reason we don't simply update the row references from
168 * the wrapper functions (gtk_tree_model_row_inserted(), etc.)
169 * is to keep proper ordering with respect to signal handlers
170 * connected normally and after.
172 closure = g_closure_new_simple (sizeof (GClosure), NULL);
173 g_closure_set_marshal (closure, row_inserted_marshal);
174 tree_model_signals[ROW_INSERTED] =
175 g_signal_newv (I_("row_inserted"),
180 _gtk_marshal_VOID__BOXED_BOXED,
182 row_inserted_params);
184 tree_model_signals[ROW_HAS_CHILD_TOGGLED] =
185 g_signal_new (I_("row_has_child_toggled"),
188 G_STRUCT_OFFSET (GtkTreeModelIface, row_has_child_toggled),
190 _gtk_marshal_VOID__BOXED_BOXED,
195 closure = g_closure_new_simple (sizeof (GClosure), NULL);
196 g_closure_set_marshal (closure, row_deleted_marshal);
197 tree_model_signals[ROW_DELETED] =
198 g_signal_newv (I_("row_deleted"),
203 _gtk_marshal_VOID__BOXED,
207 closure = g_closure_new_simple (sizeof (GClosure), NULL);
208 g_closure_set_marshal (closure, rows_reordered_marshal);
209 tree_model_signals[ROWS_REORDERED] =
210 g_signal_newv (I_("rows_reordered"),
215 _gtk_marshal_VOID__BOXED_BOXED_POINTER,
217 rows_reordered_params);
223 row_inserted_marshal (GClosure *closure,
224 GValue /* out */ *return_value,
225 guint n_param_values,
226 const GValue *param_values,
227 gpointer invocation_hint,
228 gpointer marshal_data)
230 GtkTreeModelIface *iface;
232 void (* row_inserted_callback) (GtkTreeModel *tree_model,
234 GtkTreeIter *iter) = NULL;
236 GObject *model = g_value_get_object (param_values + 0);
237 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
238 GtkTreeIter *iter = (GtkTreeIter *)g_value_get_boxed (param_values + 2);
240 /* first, we need to update internal row references */
241 gtk_tree_row_ref_inserted ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
244 /* fetch the interface ->row_inserted implementation */
245 iface = GTK_TREE_MODEL_GET_IFACE (model);
246 row_inserted_callback = G_STRUCT_MEMBER (gpointer, iface,
247 G_STRUCT_OFFSET (GtkTreeModelIface,
250 /* Call that default signal handler, it if has been set */
251 if (row_inserted_callback)
252 row_inserted_callback (GTK_TREE_MODEL (model), path, iter);
256 row_deleted_marshal (GClosure *closure,
257 GValue /* out */ *return_value,
258 guint n_param_values,
259 const GValue *param_values,
260 gpointer invocation_hint,
261 gpointer marshal_data)
263 GtkTreeModelIface *iface;
264 void (* row_deleted_callback) (GtkTreeModel *tree_model,
265 GtkTreePath *path) = NULL;
266 GObject *model = g_value_get_object (param_values + 0);
267 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
270 /* first, we need to update internal row references */
271 gtk_tree_row_ref_deleted ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
274 /* fetch the interface ->row_deleted implementation */
275 iface = GTK_TREE_MODEL_GET_IFACE (model);
276 row_deleted_callback = G_STRUCT_MEMBER (gpointer, iface,
277 G_STRUCT_OFFSET (GtkTreeModelIface,
280 /* Call that default signal handler, it if has been set */
281 if (row_deleted_callback)
282 row_deleted_callback (GTK_TREE_MODEL (model), path);
286 rows_reordered_marshal (GClosure *closure,
287 GValue /* out */ *return_value,
288 guint n_param_values,
289 const GValue *param_values,
290 gpointer invocation_hint,
291 gpointer marshal_data)
293 GtkTreeModelIface *iface;
294 void (* rows_reordered_callback) (GtkTreeModel *tree_model,
299 GObject *model = g_value_get_object (param_values + 0);
300 GtkTreePath *path = (GtkTreePath *)g_value_get_boxed (param_values + 1);
301 GtkTreeIter *iter = (GtkTreeIter *)g_value_get_boxed (param_values + 2);
302 gint *new_order = (gint *)g_value_get_pointer (param_values + 3);
304 /* first, we need to update internal row references */
305 gtk_tree_row_ref_reordered ((RowRefList *)g_object_get_data (model, ROW_REF_DATA_STRING),
306 path, iter, new_order);
308 /* fetch the interface ->rows_reordered implementation */
309 iface = GTK_TREE_MODEL_GET_IFACE (model);
310 rows_reordered_callback = G_STRUCT_MEMBER (gpointer, iface,
311 G_STRUCT_OFFSET (GtkTreeModelIface,
314 /* Call that default signal handler, it if has been set */
315 if (rows_reordered_callback)
316 rows_reordered_callback (GTK_TREE_MODEL (model), path, iter, new_order);
322 * Creates a new #GtkTreePath. This structure refers to a row.
324 * Return value: A newly created #GtkTreePath.
326 /* GtkTreePath Operations */
328 gtk_tree_path_new (void)
331 retval = (GtkTreePath *) g_new (GtkTreePath, 1);
333 retval->indices = NULL;
339 * gtk_tree_path_new_from_string:
340 * @path: The string representation of a path.
342 * Creates a new #GtkTreePath initialized to @path. @path is expected to be a
343 * colon separated list of numbers. For example, the string "10:4:0" would
344 * create a path of depth 3 pointing to the 11th child of the root node, the 5th
345 * child of that 11th child, and the 1st child of that 5th child. If an invalid
346 * path string is passed in, %NULL is returned.
348 * Return value: A newly-created #GtkTreePath, or %NULL
351 gtk_tree_path_new_from_string (const gchar *path)
354 const gchar *orig_path = path;
358 g_return_val_if_fail (path != NULL, NULL);
359 g_return_val_if_fail (*path != '\000', NULL);
361 retval = gtk_tree_path_new ();
365 i = strtol (path, &ptr, 10);
368 g_warning (G_STRLOC ": Negative numbers in path %s passed to gtk_tree_path_new_from_string", orig_path);
369 gtk_tree_path_free (retval);
373 gtk_tree_path_append_index (retval, i);
377 if (ptr == path || *ptr != ':')
379 g_warning (G_STRLOC ": Invalid path %s passed to gtk_tree_path_new_from_string", orig_path);
380 gtk_tree_path_free (retval);
390 * gtk_tree_path_new_from_indices:
391 * @first_index: first integer
392 * @varargs: list of integers terminated by -1
394 * Creates a new path with @first_index and @varargs as indices.
396 * Return value: A newly created #GtkTreePath.
401 gtk_tree_path_new_from_indices (gint first_index,
408 path = gtk_tree_path_new ();
410 va_start (args, first_index);
415 gtk_tree_path_append_index (path, arg);
416 arg = va_arg (args, gint);
425 * gtk_tree_path_to_string:
426 * @path: A #GtkTreePath
428 * Generates a string representation of the path. This string is a ':'
429 * separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
431 * Return value: A newly-allocated string. Must be freed with g_free().
434 gtk_tree_path_to_string (GtkTreePath *path)
439 g_return_val_if_fail (path != NULL, NULL);
441 if (path->depth == 0)
444 ptr = retval = (gchar *) g_new0 (char *, path->depth*8);
445 g_sprintf (retval, "%d", path->indices[0]);
446 while (*ptr != '\000')
449 for (i = 1; i < path->depth; i++)
451 g_sprintf (ptr, ":%d", path->indices[i]);
452 while (*ptr != '\000')
460 * gtk_tree_path_new_first:
462 * Creates a new #GtkTreePath. The string representation of this path is "0"
464 * Return value: A new #GtkTreePath.
467 gtk_tree_path_new_first (void)
471 retval = gtk_tree_path_new ();
472 gtk_tree_path_append_index (retval, 0);
478 * gtk_tree_path_append_index:
479 * @path: A #GtkTreePath.
480 * @index_: The index.
482 * Appends a new index to a path. As a result, the depth of the path is
486 gtk_tree_path_append_index (GtkTreePath *path,
489 g_return_if_fail (path != NULL);
490 g_return_if_fail (index >= 0);
493 path->indices = g_realloc (path->indices, path->depth * sizeof(gint));
494 path->indices[path->depth - 1] = index;
498 * gtk_tree_path_prepend_index:
499 * @path: A #GtkTreePath.
500 * @index_: The index.
502 * Prepends a new index to a path. As a result, the depth of the path is
506 gtk_tree_path_prepend_index (GtkTreePath *path,
512 new_indices = g_new (gint, path->depth);
514 if (path->indices == NULL)
516 path->indices = new_indices;
517 path->indices[0] = index;
520 memcpy (new_indices + 1, path->indices, (path->depth - 1)*sizeof (gint));
521 g_free (path->indices);
522 path->indices = new_indices;
523 path->indices[0] = index;
527 * gtk_tree_path_get_depth:
528 * @path: A #GtkTreePath.
530 * Returns the current depth of @path.
532 * Return value: The depth of @path
535 gtk_tree_path_get_depth (GtkTreePath *path)
537 g_return_val_if_fail (path != NULL, 0);
543 * gtk_tree_path_get_indices:
544 * @path: A #GtkTreePath.
546 * Returns the current indices of @path. This is an array of integers, each
547 * representing a node in a tree. This value should not be freed.
549 * Return value: The current indices, or %NULL.
552 gtk_tree_path_get_indices (GtkTreePath *path)
554 g_return_val_if_fail (path != NULL, NULL);
556 return path->indices;
560 * gtk_tree_path_free:
561 * @path: A #GtkTreePath.
566 gtk_tree_path_free (GtkTreePath *path)
571 g_free (path->indices);
576 * gtk_tree_path_copy:
577 * @path: A #GtkTreePath.
579 * Creates a new #GtkTreePath as a copy of @path.
581 * Return value: A new #GtkTreePath.
584 gtk_tree_path_copy (const GtkTreePath *path)
588 g_return_val_if_fail (path != NULL, NULL);
590 retval = g_new (GtkTreePath, 1);
591 retval->depth = path->depth;
592 retval->indices = g_new (gint, path->depth);
593 memcpy (retval->indices, path->indices, path->depth * sizeof (gint));
598 gtk_tree_path_get_type (void)
600 static GType our_type = 0;
603 our_type = g_boxed_type_register_static (I_("GtkTreePath"),
604 (GBoxedCopyFunc) gtk_tree_path_copy,
605 (GBoxedFreeFunc) gtk_tree_path_free);
611 * gtk_tree_path_compare:
612 * @a: A #GtkTreePath.
613 * @b: A #GtkTreePath to compare with.
615 * Compares two paths. If @a appears before @b in a tree, then -1 is returned.
616 * If @b appears before @a, then 1 is returned. If the two nodes are equal,
617 * then 0 is returned.
619 * Return value: The relative positions of @a and @b
622 gtk_tree_path_compare (const GtkTreePath *a,
623 const GtkTreePath *b)
627 g_return_val_if_fail (a != NULL, 0);
628 g_return_val_if_fail (b != NULL, 0);
629 g_return_val_if_fail (a->depth > 0, 0);
630 g_return_val_if_fail (b->depth > 0, 0);
634 if (a->indices[p] == b->indices[q])
636 return (a->indices[p] < b->indices[q]?-1:1);
638 while (++p < a->depth && ++q < b->depth);
639 if (a->depth == b->depth)
641 return (a->depth < b->depth?-1:1);
645 * gtk_tree_path_is_ancestor:
646 * @path: a #GtkTreePath
647 * @descendant: another #GtkTreePath
649 * Returns %TRUE if @descendant is a descendant of @path.
651 * Return value: %TRUE if @descendant is contained inside @path
654 gtk_tree_path_is_ancestor (GtkTreePath *path,
655 GtkTreePath *descendant)
659 g_return_val_if_fail (path != NULL, FALSE);
660 g_return_val_if_fail (descendant != NULL, FALSE);
662 /* can't be an ancestor if we're deeper */
663 if (path->depth >= descendant->depth)
667 while (i < path->depth)
669 if (path->indices[i] != descendant->indices[i])
678 * gtk_tree_path_is_descendant:
679 * @path: a #GtkTreePath
680 * @ancestor: another #GtkTreePath
682 * Returns %TRUE if @path is a descendant of @ancestor.
684 * Return value: %TRUE if @ancestor contains @path somewhere below it
687 gtk_tree_path_is_descendant (GtkTreePath *path,
688 GtkTreePath *ancestor)
692 g_return_val_if_fail (path != NULL, FALSE);
693 g_return_val_if_fail (ancestor != NULL, FALSE);
695 /* can't be a descendant if we're shallower in the tree */
696 if (path->depth <= ancestor->depth)
700 while (i < ancestor->depth)
702 if (path->indices[i] != ancestor->indices[i])
712 * gtk_tree_path_next:
713 * @path: A #GtkTreePath.
715 * Moves the @path to point to the next node at the current depth.
718 gtk_tree_path_next (GtkTreePath *path)
720 g_return_if_fail (path != NULL);
721 g_return_if_fail (path->depth > 0);
723 path->indices[path->depth - 1] ++;
727 * gtk_tree_path_prev:
728 * @path: A #GtkTreePath.
730 * Moves the @path to point to the previous node at the current depth,
733 * Return value: %TRUE if @path has a previous node, and the move was made.
736 gtk_tree_path_prev (GtkTreePath *path)
738 g_return_val_if_fail (path != NULL, FALSE);
740 if (path->depth == 0)
743 if (path->indices[path->depth - 1] == 0)
746 path->indices[path->depth - 1] -= 1;
753 * @path: A #GtkTreePath.
755 * Moves the @path to point to its parent node, if it has a parent.
757 * Return value: %TRUE if @path has a parent, and the move was made.
760 gtk_tree_path_up (GtkTreePath *path)
762 g_return_val_if_fail (path != NULL, FALSE);
764 if (path->depth == 0)
773 * gtk_tree_path_down:
774 * @path: A #GtkTreePath.
776 * Moves @path to point to the first child of the current path.
779 gtk_tree_path_down (GtkTreePath *path)
781 g_return_if_fail (path != NULL);
783 gtk_tree_path_append_index (path, 0);
787 * gtk_tree_iter_copy:
788 * @iter: A #GtkTreeIter.
790 * Creates a dynamically allocated tree iterator as a copy of @iter. This
791 * function is not intended for use in applications, because you can just copy
792 * the structs by value (<literal>GtkTreeIter new_iter = iter;</literal>). You
793 * must free this iter with gtk_tree_iter_free ().
795 * Return value: a newly-allocated copy of @iter.
798 gtk_tree_iter_copy (GtkTreeIter *iter)
802 g_return_val_if_fail (iter != NULL, NULL);
804 retval = g_new (GtkTreeIter, 1);
811 * gtk_tree_iter_free:
812 * @iter: A dynamically allocated tree iterator.
814 * Frees an iterator that has been allocated on the heap. This function is
815 * mainly used for language bindings.
818 gtk_tree_iter_free (GtkTreeIter *iter)
820 g_return_if_fail (iter != NULL);
826 gtk_tree_iter_get_type (void)
828 static GType our_type = 0;
831 our_type = g_boxed_type_register_static (I_("GtkTreeIter"),
832 (GBoxedCopyFunc) gtk_tree_iter_copy,
833 (GBoxedFreeFunc) gtk_tree_iter_free);
839 * gtk_tree_model_get_flags:
840 * @tree_model: A #GtkTreeModel.
842 * Returns a set of flags supported by this interface. The flags are a bitwise
843 * combination of #GtkTreeModelFlags. The flags supported should not change
844 * during the lifecycle of the @tree_model.
846 * Return value: The flags supported by this interface.
849 gtk_tree_model_get_flags (GtkTreeModel *tree_model)
851 GtkTreeModelIface *iface;
853 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
855 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
856 if (iface->get_flags)
857 return (* iface->get_flags) (tree_model);
863 * gtk_tree_model_get_n_columns:
864 * @tree_model: A #GtkTreeModel.
866 * Returns the number of columns supported by @tree_model.
868 * Return value: The number of columns.
871 gtk_tree_model_get_n_columns (GtkTreeModel *tree_model)
873 GtkTreeModelIface *iface;
874 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
876 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
877 g_return_val_if_fail (iface->get_n_columns != NULL, 0);
879 return (* iface->get_n_columns) (tree_model);
883 * gtk_tree_model_get_column_type:
884 * @tree_model: A #GtkTreeModel.
885 * @index_: The column index.
887 * Returns the type of the column.
889 * Return value: The type of the column.
892 gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
895 GtkTreeModelIface *iface;
897 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), G_TYPE_INVALID);
899 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
900 g_return_val_if_fail (iface->get_column_type != NULL, G_TYPE_INVALID);
901 g_return_val_if_fail (index >= 0, G_TYPE_INVALID);
903 return (* iface->get_column_type) (tree_model, index);
907 * gtk_tree_model_get_iter:
908 * @tree_model: A #GtkTreeModel.
909 * @iter: The uninitialized #GtkTreeIter.
910 * @path: The #GtkTreePath.
912 * Sets @iter to a valid iterator pointing to @path.
914 * Return value: %TRUE, if @iter was set.
917 gtk_tree_model_get_iter (GtkTreeModel *tree_model,
921 GtkTreeModelIface *iface;
923 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
924 g_return_val_if_fail (iter != NULL, FALSE);
925 g_return_val_if_fail (path != NULL, FALSE);
927 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
928 g_return_val_if_fail (iface->get_iter != NULL, FALSE);
929 g_return_val_if_fail (path->depth > 0, FALSE);
931 INITIALIZE_TREE_ITER (iter);
933 return (* iface->get_iter) (tree_model, iter, path);
937 * gtk_tree_model_get_iter_from_string:
938 * @tree_model: A #GtkTreeModel.
939 * @iter: An uninitialized #GtkTreeIter.
940 * @path_string: A string representation of a #GtkTreePath.
942 * Sets @iter to a valid iterator pointing to @path_string, if it
943 * exists. Otherwise, @iter is left invalid and %FALSE is returned.
945 * Return value: %TRUE, if @iter was set.
948 gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
950 const gchar *path_string)
955 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
956 g_return_val_if_fail (iter != NULL, FALSE);
957 g_return_val_if_fail (path_string != NULL, FALSE);
959 path = gtk_tree_path_new_from_string (path_string);
961 g_return_val_if_fail (path != NULL, FALSE);
963 retval = gtk_tree_model_get_iter (tree_model, iter, path);
964 gtk_tree_path_free (path);
970 * gtk_tree_model_get_string_from_iter:
971 * @tree_model: A #GtkTreeModel.
972 * @iter: An #GtkTreeIter.
974 * Generates a string representation of the iter. This string is a ':'
975 * separated list of numbers. For example, "4:10:0:3" would be an
976 * acceptable return value for this string.
978 * Return value: A newly-allocated string. Must be freed with g_free().
983 gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
989 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
990 g_return_val_if_fail (iter != NULL, NULL);
992 path = gtk_tree_model_get_path (tree_model, iter);
994 g_return_val_if_fail (path != NULL, NULL);
996 ret = gtk_tree_path_to_string (path);
997 gtk_tree_path_free (path);
1003 * gtk_tree_model_get_iter_first:
1004 * @tree_model: A #GtkTreeModel.
1005 * @iter: The uninitialized #GtkTreeIter.
1007 * Initializes @iter with the first iterator in the tree (the one at the path
1008 * "0") and returns %TRUE. Returns %FALSE if the tree is empty.
1010 * Return value: %TRUE, if @iter was set.
1013 gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
1019 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1020 g_return_val_if_fail (iter != NULL, FALSE);
1022 path = gtk_tree_path_new_first ();
1023 retval = gtk_tree_model_get_iter (tree_model, iter, path);
1024 gtk_tree_path_free (path);
1030 * gtk_tree_model_get_path:
1031 * @tree_model: A #GtkTreeModel.
1032 * @iter: The #GtkTreeIter.
1034 * Returns a newly-created #GtkTreePath referenced by @iter. This path should
1035 * be freed with gtk_tree_path_free().
1037 * Return value: a newly-created #GtkTreePath.
1040 gtk_tree_model_get_path (GtkTreeModel *tree_model,
1043 GtkTreeModelIface *iface;
1045 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
1046 g_return_val_if_fail (iter != NULL, NULL);
1048 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1049 g_return_val_if_fail (iface->get_path != NULL, NULL);
1051 return (* iface->get_path) (tree_model, iter);
1055 * gtk_tree_model_get_value:
1056 * @tree_model: A #GtkTreeModel.
1057 * @iter: The #GtkTreeIter.
1058 * @column: The column to lookup the value at.
1059 * @value: An empty #GValue to set.
1061 * Sets initializes and sets @value to that at @column. When done with @value,
1062 * g_value_unset() needs to be called to free any allocated memory.
1065 gtk_tree_model_get_value (GtkTreeModel *tree_model,
1070 GtkTreeModelIface *iface;
1072 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1073 g_return_if_fail (iter != NULL);
1074 g_return_if_fail (value != NULL);
1076 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1077 g_return_if_fail (iface->get_value != NULL);
1079 (* iface->get_value) (tree_model, iter, column, value);
1083 * gtk_tree_model_iter_next:
1084 * @tree_model: A #GtkTreeModel.
1085 * @iter: The #GtkTreeIter.
1087 * Sets @iter to point to the node following it at the current level. If there
1088 * is no next @iter, %FALSE is returned and @iter is set to be invalid.
1090 * Return value: %TRUE if @iter has been changed to the next node.
1093 gtk_tree_model_iter_next (GtkTreeModel *tree_model,
1096 GtkTreeModelIface *iface;
1098 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1099 g_return_val_if_fail (iter != NULL, FALSE);
1101 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1102 g_return_val_if_fail (iface->iter_next != NULL, FALSE);
1104 return (* iface->iter_next) (tree_model, iter);
1108 * gtk_tree_model_iter_children:
1109 * @tree_model: A #GtkTreeModel.
1110 * @iter: The new #GtkTreeIter to be set to the child.
1111 * @parent: The #GtkTreeIter, or %NULL
1113 * Sets @iter to point to the first child of @parent. If @parent has no
1114 * children, %FALSE is returned and @iter is set to be invalid. @parent
1115 * will remain a valid node after this function has been called.
1117 * If @parent is %NULL returns the first node, equivalent to
1118 * <literal>gtk_tree_model_get_iter_first (tree_model, iter);</literal>
1120 * Return value: %TRUE, if @child has been set to the first child.
1123 gtk_tree_model_iter_children (GtkTreeModel *tree_model,
1125 GtkTreeIter *parent)
1127 GtkTreeModelIface *iface;
1129 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1130 g_return_val_if_fail (iter != NULL, FALSE);
1132 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1133 g_return_val_if_fail (iface->iter_children != NULL, FALSE);
1135 INITIALIZE_TREE_ITER (iter);
1137 return (* iface->iter_children) (tree_model, iter, parent);
1141 * gtk_tree_model_iter_has_child:
1142 * @tree_model: A #GtkTreeModel.
1143 * @iter: The #GtkTreeIter to test for children.
1145 * Returns %TRUE if @iter has children, %FALSE otherwise.
1147 * Return value: %TRUE if @iter has children.
1150 gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
1153 GtkTreeModelIface *iface;
1155 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1156 g_return_val_if_fail (iter != NULL, FALSE);
1158 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1159 g_return_val_if_fail (iface->iter_has_child != NULL, FALSE);
1161 return (* iface->iter_has_child) (tree_model, iter);
1165 * gtk_tree_model_iter_n_children:
1166 * @tree_model: A #GtkTreeModel.
1167 * @iter: The #GtkTreeIter, or %NULL.
1169 * Returns the number of children that @iter has. As a special case, if @iter
1170 * is %NULL, then the number of toplevel nodes is returned.
1172 * Return value: The number of children of @iter.
1175 gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
1178 GtkTreeModelIface *iface;
1180 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
1182 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1183 g_return_val_if_fail (iface->iter_n_children != NULL, 0);
1185 return (* iface->iter_n_children) (tree_model, iter);
1189 * gtk_tree_model_iter_nth_child:
1190 * @tree_model: A #GtkTreeModel.
1191 * @iter: The #GtkTreeIter to set to the nth child.
1192 * @parent: The #GtkTreeIter to get the child from, or %NULL.
1193 * @n: Then index of the desired child.
1195 * Sets @iter to be the child of @parent, using the given index. The first
1196 * index is 0. If @n is too big, or @parent has no children, @iter is set
1197 * to an invalid iterator and %FALSE is returned. @parent will remain a valid
1198 * node after this function has been called. As a special case, if @parent is
1199 * %NULL, then the @n<!-- -->th root node is set.
1201 * Return value: %TRUE, if @parent has an @n<!-- -->th child.
1204 gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
1206 GtkTreeIter *parent,
1209 GtkTreeModelIface *iface;
1211 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1212 g_return_val_if_fail (iter != NULL, FALSE);
1213 g_return_val_if_fail (n >= 0, FALSE);
1215 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1216 g_return_val_if_fail (iface->iter_nth_child != NULL, FALSE);
1218 INITIALIZE_TREE_ITER (iter);
1220 return (* iface->iter_nth_child) (tree_model, iter, parent, n);
1224 * gtk_tree_model_iter_parent:
1225 * @tree_model: A #GtkTreeModel
1226 * @iter: The new #GtkTreeIter to set to the parent.
1227 * @child: The #GtkTreeIter.
1229 * Sets @iter to be the parent of @child. If @child is at the toplevel, and
1230 * doesn't have a parent, then @iter is set to an invalid iterator and %FALSE
1231 * is returned. @child will remain a valid node after this function has been
1234 * Return value: %TRUE, if @iter is set to the parent of @child.
1237 gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
1241 GtkTreeModelIface *iface;
1243 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
1244 g_return_val_if_fail (iter != NULL, FALSE);
1245 g_return_val_if_fail (child != NULL, FALSE);
1247 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1248 g_return_val_if_fail (iface->iter_parent != NULL, FALSE);
1250 INITIALIZE_TREE_ITER (iter);
1252 return (* iface->iter_parent) (tree_model, iter, child);
1256 * gtk_tree_model_ref_node:
1257 * @tree_model: A #GtkTreeModel.
1258 * @iter: The #GtkTreeIter.
1260 * Lets the tree ref the node. This is an optional method for models to
1261 * implement. To be more specific, models may ignore this call as it exists
1262 * primarily for performance reasons.
1264 * This function is primarily meant as a way for views to let caching model
1265 * know when nodes are being displayed (and hence, whether or not to cache that
1266 * node.) For example, a file-system based model would not want to keep the
1267 * entire file-hierarchy in memory, just the sections that are currently being
1268 * displayed by every current view.
1270 * A model should be expected to be able to get an iter independent of its
1274 gtk_tree_model_ref_node (GtkTreeModel *tree_model,
1277 GtkTreeModelIface *iface;
1279 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1281 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1282 if (iface->ref_node)
1283 (* iface->ref_node) (tree_model, iter);
1287 * gtk_tree_model_unref_node:
1288 * @tree_model: A #GtkTreeModel.
1289 * @iter: The #GtkTreeIter.
1291 * Lets the tree unref the node. This is an optional method for models to
1292 * implement. To be more specific, models may ignore this call as it exists
1293 * primarily for performance reasons.
1295 * For more information on what this means, see gtk_tree_model_ref_node().
1296 * Please note that nodes that are deleted are not unreffed.
1299 gtk_tree_model_unref_node (GtkTreeModel *tree_model,
1302 GtkTreeModelIface *iface;
1304 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1305 g_return_if_fail (iter != NULL);
1307 iface = GTK_TREE_MODEL_GET_IFACE (tree_model);
1308 if (iface->unref_node)
1309 (* iface->unref_node) (tree_model, iter);
1313 * gtk_tree_model_get:
1314 * @tree_model: a #GtkTreeModel
1315 * @iter: a row in @tree_model
1316 * @Varargs: pairs of column number and value return locations, terminated by -1
1318 * Gets the value of one or more cells in the row referenced by @iter.
1319 * The variable argument list should contain integer column numbers,
1320 * each column number followed by a place to store the value being
1321 * retrieved. The list is terminated by a -1. For example, to get a
1322 * value from column 0 with type %G_TYPE_STRING, you would
1323 * write: <literal>gtk_tree_model_get (model, iter, 0, &place_string_here, -1)</literal>,
1324 * where <literal>place_string_here</literal> is a <type>gchar*</type> to be
1325 * filled with the string.
1326 * If appropriate, the returned values have to be freed or unreferenced.
1330 gtk_tree_model_get (GtkTreeModel *tree_model,
1336 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1337 g_return_if_fail (iter != NULL);
1339 va_start (var_args, iter);
1340 gtk_tree_model_get_valist (tree_model, iter, var_args);
1345 * gtk_tree_model_get_valist:
1346 * @tree_model: a #GtkTreeModel
1347 * @iter: a row in @tree_model
1348 * @var_args: <type>va_list</type> of column/return location pairs
1350 * See gtk_tree_model_get(), this version takes a <type>va_list</type>
1351 * for language bindings to use.
1354 gtk_tree_model_get_valist (GtkTreeModel *tree_model,
1360 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1361 g_return_if_fail (iter != NULL);
1363 column = va_arg (var_args, gint);
1365 while (column != -1)
1367 GValue value = { 0, };
1368 gchar *error = NULL;
1370 if (column >= gtk_tree_model_get_n_columns (tree_model))
1372 g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
1376 gtk_tree_model_get_value (GTK_TREE_MODEL (tree_model), iter, column, &value);
1378 G_VALUE_LCOPY (&value, var_args, 0, &error);
1381 g_warning ("%s: %s", G_STRLOC, error);
1384 /* we purposely leak the value here, it might not be
1385 * in a sane state if an error condition occoured
1390 g_value_unset (&value);
1392 column = va_arg (var_args, gint);
1397 * gtk_tree_model_row_changed:
1398 * @tree_model: A #GtkTreeModel
1399 * @path: A #GtkTreePath pointing to the changed row
1400 * @iter: A valid #GtkTreeIter pointing to the changed row
1402 * Emits the "row_changed" signal on @tree_model.
1405 gtk_tree_model_row_changed (GtkTreeModel *tree_model,
1409 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1410 g_return_if_fail (path != NULL);
1411 g_return_if_fail (iter != NULL);
1413 g_signal_emit (tree_model, tree_model_signals[ROW_CHANGED], 0, path, iter);
1417 * gtk_tree_model_row_inserted:
1418 * @tree_model: A #GtkTreeModel
1419 * @path: A #GtkTreePath pointing to the inserted row
1420 * @iter: A valid #GtkTreeIter pointing to the inserted row
1422 * Emits the "row_inserted" signal on @tree_model
1425 gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
1429 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1430 g_return_if_fail (path != NULL);
1431 g_return_if_fail (iter != NULL);
1433 g_signal_emit (tree_model, tree_model_signals[ROW_INSERTED], 0, path, iter);
1437 * gtk_tree_model_row_has_child_toggled:
1438 * @tree_model: A #GtkTreeModel
1439 * @path: A #GtkTreePath pointing to the changed row
1440 * @iter: A valid #GtkTreeIter pointing to the changed row
1442 * Emits the "row_has_child_toggled" signal on @tree_model. This should be
1443 * called by models after the child state of a node changes.
1446 gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
1450 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1451 g_return_if_fail (path != NULL);
1452 g_return_if_fail (iter != NULL);
1454 g_signal_emit (tree_model, tree_model_signals[ROW_HAS_CHILD_TOGGLED], 0, path, iter);
1458 * gtk_tree_model_row_deleted:
1459 * @tree_model: A #GtkTreeModel
1460 * @path: A #GtkTreePath pointing to the previous location of the deleted row.
1462 * Emits the "row_deleted" signal on @tree_model. This should be called by
1463 * models after a row has been removed. The location pointed to by @path
1464 * should be the location that the row previously was at. It may not be a
1465 * valid location anymore.
1468 gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
1471 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1472 g_return_if_fail (path != NULL);
1474 g_signal_emit (tree_model, tree_model_signals[ROW_DELETED], 0, path);
1478 * gtk_tree_model_rows_reordered:
1479 * @tree_model: A #GtkTreeModel
1480 * @path: A #GtkTreePath pointing to the tree node whose children have been
1482 * @iter: A valid #GtkTreeIter pointing to the node whose children have been
1483 * reordered, or %NULL if the depth of @path is 0.
1484 * @new_order: an array of integers mapping the current position of each child
1485 * to its old position before the re-ordering,
1486 * i.e. @new_order<literal>[newpos] = oldpos</literal>.
1488 * Emits the "rows_reordered" signal on @tree_model. This should be called by
1489 * models when their rows have been reordered.
1492 gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
1497 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1498 g_return_if_fail (new_order != NULL);
1500 g_signal_emit (tree_model, tree_model_signals[ROWS_REORDERED], 0, path, iter, new_order);
1505 gtk_tree_model_foreach_helper (GtkTreeModel *model,
1508 GtkTreeModelForeachFunc func,
1515 if ((* func) (model, path, iter, user_data))
1518 if (gtk_tree_model_iter_children (model, &child, iter))
1520 gtk_tree_path_down (path);
1521 if (gtk_tree_model_foreach_helper (model, &child, path, func, user_data))
1523 gtk_tree_path_up (path);
1526 gtk_tree_path_next (path);
1528 while (gtk_tree_model_iter_next (model, iter));
1534 * gtk_tree_model_foreach:
1535 * @model: A #GtkTreeModel
1536 * @func: A function to be called on each row
1537 * @user_data: User data to passed to func.
1539 * Calls func on each node in model in a depth-first fashion.
1540 * If @func returns %TRUE, then the tree ceases to be walked, and
1541 * gtk_tree_model_foreach() returns.
1544 gtk_tree_model_foreach (GtkTreeModel *model,
1545 GtkTreeModelForeachFunc func,
1551 g_return_if_fail (GTK_IS_TREE_MODEL (model));
1552 g_return_if_fail (func != NULL);
1554 path = gtk_tree_path_new_first ();
1555 if (gtk_tree_model_get_iter (model, &iter, path) == FALSE)
1557 gtk_tree_path_free (path);
1561 gtk_tree_model_foreach_helper (model, &iter, path, func, user_data);
1562 gtk_tree_path_free (path);
1567 * GtkTreeRowReference
1570 static void gtk_tree_row_reference_unref_path (GtkTreePath *path,
1571 GtkTreeModel *model,
1576 gtk_tree_row_reference_get_type (void)
1578 static GType our_type = 0;
1581 our_type = g_boxed_type_register_static (I_("GtkTreeRowReference"),
1582 (GBoxedCopyFunc) gtk_tree_row_reference_copy,
1583 (GBoxedFreeFunc) gtk_tree_row_reference_free);
1589 struct _GtkTreeRowReference
1592 GtkTreeModel *model;
1598 release_row_references (gpointer data)
1600 RowRefList *refs = data;
1601 GSList *tmp_list = NULL;
1603 tmp_list = refs->list;
1604 while (tmp_list != NULL)
1606 GtkTreeRowReference *reference = tmp_list->data;
1608 if (reference->proxy == (GObject *)reference->model)
1609 reference->model = NULL;
1610 reference->proxy = NULL;
1612 /* we don't free the reference, users are responsible for that. */
1614 tmp_list = g_slist_next (tmp_list);
1617 g_slist_free (refs->list);
1622 gtk_tree_row_ref_inserted (RowRefList *refs,
1631 /* This function corrects the path stored in the reference to
1632 * account for an insertion. Note that it's called _after_ the insertion
1633 * with the path to the newly-inserted row. Which means that
1634 * the inserted path is in a different "coordinate system" than
1635 * the old path (e.g. if the inserted path was just before the old path,
1636 * then inserted path and old path will be the same, and old path must be
1640 tmp_list = refs->list;
1642 while (tmp_list != NULL)
1644 GtkTreeRowReference *reference = tmp_list->data;
1646 if (reference->path == NULL)
1649 if (reference->path->depth >= path->depth)
1652 gboolean ancestor = TRUE;
1654 for (i = 0; i < path->depth - 1; i ++)
1656 if (path->indices[i] != reference->path->indices[i])
1662 if (ancestor == FALSE)
1665 if (path->indices[path->depth-1] <= reference->path->indices[path->depth-1])
1666 reference->path->indices[path->depth-1] += 1;
1669 tmp_list = g_slist_next (tmp_list);
1674 gtk_tree_row_ref_deleted (RowRefList *refs,
1682 /* This function corrects the path stored in the reference to
1683 * account for an deletion. Note that it's called _after_ the
1684 * deletion with the old path of the just-deleted row. Which means
1685 * that the deleted path is the same now-defunct "coordinate system"
1686 * as the path saved in the reference, which is what we want to fix.
1689 tmp_list = refs->list;
1691 while (tmp_list != NULL)
1693 GtkTreeRowReference *reference = tmp_list->data;
1695 if (reference->path)
1699 if (path->depth > reference->path->depth)
1701 for (i = 0; i < path->depth - 1; i++)
1703 if (path->indices[i] != reference->path->indices[i])
1707 /* We know it affects us. */
1708 if (path->indices[i] == reference->path->indices[i])
1710 if (reference->path->depth > path->depth)
1711 /* some parent was deleted, trying to unref any node
1712 * between the deleted parent and the node the reference
1713 * is pointing to is bad, as those nodes are already gone.
1715 gtk_tree_row_reference_unref_path (reference->path, reference->model, path->depth - 1);
1717 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth - 1);
1718 gtk_tree_path_free (reference->path);
1719 reference->path = NULL;
1721 else if (path->indices[i] < reference->path->indices[i])
1723 reference->path->indices[path->depth-1]-=1;
1728 tmp_list = g_slist_next (tmp_list);
1733 gtk_tree_row_ref_reordered (RowRefList *refs,
1744 tmp_list = refs->list;
1746 while (tmp_list != NULL)
1748 GtkTreeRowReference *reference = tmp_list->data;
1750 length = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (reference->model), iter);
1755 if ((reference->path) &&
1756 (gtk_tree_path_is_ancestor (path, reference->path)))
1758 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1759 gint depth = gtk_tree_path_get_depth (path);
1761 if (ref_depth > depth)
1764 gint *indices = gtk_tree_path_get_indices (reference->path);
1766 for (i = 0; i < length; i++)
1768 if (new_order[i] == indices[depth])
1777 tmp_list = g_slist_next (tmp_list);
1781 /* We do this recursively so that we can unref children nodes before their parent */
1783 gtk_tree_row_reference_unref_path_helper (GtkTreePath *path,
1784 GtkTreeModel *model,
1785 GtkTreeIter *parent_iter,
1791 if (depth == current_depth)
1794 gtk_tree_model_iter_nth_child (model, &iter, parent_iter, path->indices[current_depth]);
1795 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, current_depth + 1);
1796 gtk_tree_model_unref_node (model, &iter);
1800 gtk_tree_row_reference_unref_path (GtkTreePath *path,
1801 GtkTreeModel *model,
1809 gtk_tree_model_iter_nth_child (model, &iter, NULL, path->indices[0]);
1810 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, 1);
1811 gtk_tree_model_unref_node (model, &iter);
1815 * gtk_tree_row_reference_new:
1816 * @model: A #GtkTreeModel
1817 * @path: A valid #GtkTreePath to monitor
1819 * Creates a row reference based on @path. This reference will keep pointing
1820 * to the node pointed to by @path, so long as it exists. It listens to all
1821 * signals emitted by @model, and updates its path appropriately. If @path
1822 * isn't a valid path in @model, then %NULL is returned.
1824 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1826 GtkTreeRowReference *
1827 gtk_tree_row_reference_new (GtkTreeModel *model,
1830 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1831 g_return_val_if_fail (path != NULL, NULL);
1833 /* We use the model itself as the proxy object; and call
1834 * gtk_tree_row_reference_inserted(), etc, in the
1835 * class closure (default handler) marshalers for the signal.
1837 return gtk_tree_row_reference_new_proxy (G_OBJECT (model), model, path);
1841 * gtk_tree_row_reference_new_proxy:
1842 * @proxy: A proxy #GObject
1843 * @model: A #GtkTreeModel
1844 * @path: A valid #GtkTreePath to monitor
1846 * You do not need to use this function. Creates a row reference based on
1847 * @path. This reference will keep pointing to the node pointed to by @path,
1848 * so long as it exists. If @path isn't a valid path in @model, then %NULL is
1849 * returned. However, unlike references created with
1850 * gtk_tree_row_reference_new(), it does not listen to the model for changes.
1851 * The creator of the row reference must do this explicitly using
1852 * gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(),
1853 * gtk_tree_row_reference_reordered().
1855 * These functions must be called exactly once per proxy when the
1856 * corresponding signal on the model is emitted. This single call
1857 * updates all row references for that proxy. Since built-in GTK+
1858 * objects like #GtkTreeView already use this mechanism internally,
1859 * using them as the proxy object will produce unpredictable results.
1860 * Further more, passing the same object as @model and @proxy
1861 * doesn't work for reasons of internal implementation.
1863 * This type of row reference is primarily meant by structures that need to
1864 * carefully monitor exactly when a row reference updates itself, and is not
1865 * generally needed by most applications.
1867 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1869 GtkTreeRowReference *
1870 gtk_tree_row_reference_new_proxy (GObject *proxy,
1871 GtkTreeModel *model,
1874 GtkTreeRowReference *reference;
1876 GtkTreeIter parent_iter;
1879 g_return_val_if_fail (G_IS_OBJECT (proxy), NULL);
1880 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1881 g_return_val_if_fail (path != NULL, NULL);
1882 g_return_val_if_fail (path->depth > 0, NULL);
1884 /* check that the path is valid */
1885 if (gtk_tree_model_get_iter (model, &parent_iter, path) == FALSE)
1888 /* Now we want to ref every node */
1889 gtk_tree_model_iter_nth_child (model, &parent_iter, NULL, path->indices[0]);
1890 gtk_tree_model_ref_node (model, &parent_iter);
1892 for (i = 1; i < path->depth; i++)
1895 gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, path->indices[i]);
1896 gtk_tree_model_ref_node (model, &iter);
1900 /* Make the row reference */
1901 reference = g_new (GtkTreeRowReference, 1);
1903 g_object_ref (proxy);
1904 g_object_ref (model);
1905 reference->proxy = proxy;
1906 reference->model = model;
1907 reference->path = gtk_tree_path_copy (path);
1909 refs = g_object_get_data (G_OBJECT (proxy), ROW_REF_DATA_STRING);
1913 refs = g_new (RowRefList, 1);
1916 g_object_set_data_full (G_OBJECT (proxy),
1917 I_(ROW_REF_DATA_STRING),
1918 refs, release_row_references);
1921 refs->list = g_slist_prepend (refs->list, reference);
1927 * gtk_tree_row_reference_get_path:
1928 * @reference: A #GtkTreeRowReference
1930 * Returns a path that the row reference currently points to, or %NULL if the
1931 * path pointed to is no longer valid.
1933 * Return value: A current path, or %NULL.
1936 gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
1938 g_return_val_if_fail (reference != NULL, NULL);
1940 if (reference->proxy == NULL)
1943 if (reference->path == NULL)
1946 return gtk_tree_path_copy (reference->path);
1950 * gtk_tree_row_reference_get_model:
1951 * @reference: A #GtkTreeRowReference
1953 * Returns the model that the row reference is monitoring.
1955 * Return value: the model
1960 gtk_tree_row_reference_get_model (GtkTreeRowReference *reference)
1962 g_return_val_if_fail (reference != NULL, NULL);
1964 return reference->model;
1968 * gtk_tree_row_reference_valid:
1969 * @reference: A #GtkTreeRowReference, or %NULL
1971 * Returns %TRUE if the @reference is non-%NULL and refers to a current valid
1974 * Return value: %TRUE if @reference points to a valid path.
1977 gtk_tree_row_reference_valid (GtkTreeRowReference *reference)
1979 if (reference == NULL || reference->path == NULL)
1987 * gtk_tree_row_reference_copy:
1988 * @reference: a #GtkTreeRowReference
1990 * Copies a #GtkTreeRowReference.
1992 * Return value: a copy of @reference.
1996 GtkTreeRowReference *
1997 gtk_tree_row_reference_copy (GtkTreeRowReference *reference)
1999 return gtk_tree_row_reference_new_proxy (reference->proxy,
2005 * gtk_tree_row_reference_free:
2006 * @reference: A #GtkTreeRowReference, or %NULL
2008 * Free's @reference. @reference may be %NULL.
2011 gtk_tree_row_reference_free (GtkTreeRowReference *reference)
2015 if (reference == NULL)
2018 refs = g_object_get_data (G_OBJECT (reference->proxy), ROW_REF_DATA_STRING);
2022 g_warning (G_STRLOC": bad row reference, proxy has no outstanding row references");
2026 refs->list = g_slist_remove (refs->list, reference);
2028 if (refs->list == NULL)
2030 g_object_set_data (G_OBJECT (reference->proxy),
2031 I_(ROW_REF_DATA_STRING),
2035 if (reference->path)
2037 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth);
2038 gtk_tree_path_free (reference->path);
2041 g_object_unref (reference->proxy);
2042 g_object_unref (reference->model);
2047 * gtk_tree_row_reference_inserted:
2048 * @proxy: A #GObject
2049 * @path: The row position that was inserted
2051 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
2052 * know that the model emitted the "row_inserted" signal.
2055 gtk_tree_row_reference_inserted (GObject *proxy,
2058 g_return_if_fail (G_IS_OBJECT (proxy));
2060 gtk_tree_row_ref_inserted ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path, NULL);
2064 * gtk_tree_row_reference_deleted:
2065 * @proxy: A #GObject
2066 * @path: The path position that was deleted
2068 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
2069 * know that the model emitted the "row_deleted" signal.
2072 gtk_tree_row_reference_deleted (GObject *proxy,
2075 g_return_if_fail (G_IS_OBJECT (proxy));
2077 gtk_tree_row_ref_deleted ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path);
2081 * gtk_tree_row_reference_reordered:
2082 * @proxy: A #GObject
2083 * @path: The parent path of the reordered signal
2084 * @iter: The iter pointing to the parent of the reordered
2085 * @new_order: The new order of rows
2087 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
2088 * know that the model emitted the "rows_reordered" signal.
2091 gtk_tree_row_reference_reordered (GObject *proxy,
2096 g_return_if_fail (G_IS_OBJECT (proxy));
2098 gtk_tree_row_ref_reordered ((RowRefList *)g_object_get_data (proxy, ROW_REF_DATA_STRING), path, iter, new_order);
2101 #define __GTK_TREE_MODEL_C__
2102 #include "gtkaliasdef.c"