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 <gobject/gvaluecollector.h>
25 #include "gtktreemodel.h"
26 #include "gtktreeview.h"
27 #include "gtktreeprivate.h"
28 #include "gtkmarshalers.h"
29 #include "gtksignal.h"
32 #define INITIALIZE_TREE_ITER(Iter) \
35 (Iter)->user_data = NULL; \
36 (Iter)->user_data2 = NULL; \
37 (Iter)->user_data3 = NULL; \
47 static void gtk_tree_model_base_init (gpointer g_class);
51 gtk_tree_model_get_type (void)
53 static GtkType tree_model_type = 0;
55 if (! tree_model_type)
57 static const GTypeInfo tree_model_info =
59 sizeof (GtkTreeModelIface), /* class_size */
60 gtk_tree_model_base_init, /* base_init */
61 NULL, /* base_finalize */
63 NULL, /* class_finalize */
64 NULL, /* class_data */
70 tree_model_type = g_type_register_static (G_TYPE_INTERFACE, "GtkTreeModel", &tree_model_info, 0);
71 g_type_interface_add_prerequisite (tree_model_type, G_TYPE_OBJECT);
74 return tree_model_type;
78 gtk_tree_model_base_init (gpointer g_class)
80 static gboolean initialized = FALSE;
84 g_signal_new ("row_changed",
87 G_STRUCT_OFFSET (GtkTreeModelIface, row_changed),
89 _gtk_marshal_VOID__BOXED_BOXED,
93 g_signal_new ("row_inserted",
96 G_STRUCT_OFFSET (GtkTreeModelIface, row_inserted),
98 _gtk_marshal_VOID__BOXED_BOXED,
102 g_signal_new ("row_has_child_toggled",
105 G_STRUCT_OFFSET (GtkTreeModelIface, row_has_child_toggled),
107 _gtk_marshal_VOID__BOXED_BOXED,
111 g_signal_new ("row_deleted",
114 G_STRUCT_OFFSET (GtkTreeModelIface, row_deleted),
116 _gtk_marshal_VOID__BOXED,
119 g_signal_new ("rows_reordered",
122 G_STRUCT_OFFSET (GtkTreeModelIface, rows_reordered),
124 _gtk_marshal_VOID__BOXED_BOXED_POINTER,
136 * Creates a new #GtkTreePath. This structure refers to a row.
138 * Return value: A newly created #GtkTreePath.
140 /* GtkTreePath Operations */
142 gtk_tree_path_new (void)
145 retval = (GtkTreePath *) g_new (GtkTreePath, 1);
147 retval->indices = NULL;
153 * gtk_tree_path_new_from_string:
154 * @path: The string representation of a path.
156 * Creates a new #GtkTreePath initialized to @path. @path is expected to be a
157 * colon separated list of numbers. For example, the string "10:4:0" would
158 * create a path of depth 3 pointing to the 11th child of the root node, the 5th
159 * child of that 11th child, and the 1st child of that 5th child. If an invalid
160 * path string is passed in, %NULL is returned.
162 * Return value: A newly-created #GtkTreePath, or %NULL
165 gtk_tree_path_new_from_string (const gchar *path)
168 const gchar *orig_path = path;
172 g_return_val_if_fail (path != NULL, NULL);
173 g_return_val_if_fail (*path != '\000', NULL);
175 retval = gtk_tree_path_new ();
179 i = strtol (path, &ptr, 10);
180 gtk_tree_path_append_index (retval, i);
184 g_warning (G_STRLOC ": Negative numbers in path %s passed to gtk_tree_path_new_from_string", orig_path);
185 gtk_tree_path_free (retval);
190 if (ptr == path || *ptr != ':')
192 g_warning (G_STRLOC ": Invalid path %s passed to gtk_tree_path_new_from_string", orig_path);
193 gtk_tree_path_free (retval);
203 * gtk_tree_path_to_string:
204 * @path: A #GtkTreePath
206 * Generates a string representation of the path. This string is a ':'
207 * separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
209 * Return value: A newly-allocated string. Must be freed with g_free().
212 gtk_tree_path_to_string (GtkTreePath *path)
217 g_return_val_if_fail (path != NULL, NULL);
219 if (path->depth == 0)
222 ptr = retval = (gchar *) g_new0 (char *, path->depth*8);
223 sprintf (retval, "%d", path->indices[0]);
224 while (*ptr != '\000')
227 for (i = 1; i < path->depth; i++)
229 sprintf (ptr, ":%d", path->indices[i]);
230 while (*ptr != '\000')
238 * gtk_tree_path_new_first:
240 * Creates a new #GtkTreePath. The string representation of this path is "0"
242 * Return value: A new #GtkTreePath.
245 gtk_tree_path_new_first (void)
249 retval = gtk_tree_path_new ();
250 gtk_tree_path_append_index (retval, 0);
256 * gtk_tree_path_append_index:
257 * @path: A #GtkTreePath.
260 * Appends a new index to a path. As a result, the depth of the path is
264 gtk_tree_path_append_index (GtkTreePath *path,
267 g_return_if_fail (path != NULL);
268 g_return_if_fail (index >= 0);
271 path->indices = g_realloc (path->indices, path->depth * sizeof(gint));
272 path->indices[path->depth - 1] = index;
276 * gtk_tree_path_prepend_index:
277 * @path: A #GtkTreePath.
280 * Prepends a new index to a path. As a result, the depth of the path is
284 gtk_tree_path_prepend_index (GtkTreePath *path,
287 gint *new_indices = g_new (gint, ++path->depth);
288 if (path->indices == NULL)
290 path->indices = new_indices;
291 path->indices[0] = index;
294 memcpy (new_indices + 1, path->indices, (path->depth - 1)*sizeof (gint));
295 g_free (path->indices);
296 path->indices = new_indices;
297 path->indices[0] = index;
301 * gtk_tree_path_get_depth:
302 * @path: A #GtkTreePath.
304 * Returns the current depth of @path.
306 * Return value: The depth of @path
309 gtk_tree_path_get_depth (GtkTreePath *path)
311 g_return_val_if_fail (path != NULL, 0);
317 * gtk_tree_path_get_indices:
318 * @path: A #GtkTreePath.
320 * Returns the current indices of @path. This is an array of integers, each
321 * representing a node in a tree. This value should not be freed.
323 * Return value: The current indices, or %NULL.
326 gtk_tree_path_get_indices (GtkTreePath *path)
328 g_return_val_if_fail (path != NULL, NULL);
330 return path->indices;
334 * gtk_tree_path_free:
335 * @path: A #GtkTreePath.
340 gtk_tree_path_free (GtkTreePath *path)
342 g_return_if_fail (path != NULL);
344 g_free (path->indices);
349 * gtk_tree_path_copy:
350 * @path: A #GtkTreePath.
352 * Creates a new #GtkTreePath as a copy of @path.
354 * Return value: A new #GtkTreePath.
357 gtk_tree_path_copy (const GtkTreePath *path)
361 g_return_val_if_fail (path != NULL, NULL);
363 retval = g_new (GtkTreePath, 1);
364 retval->depth = path->depth;
365 retval->indices = g_new (gint, path->depth);
366 memcpy (retval->indices, path->indices, path->depth * sizeof (gint));
371 gtk_tree_path_get_type (void)
373 static GType our_type = 0;
376 our_type = g_boxed_type_register_static ("GtkTypeTreePath",
377 (GBoxedCopyFunc) gtk_tree_path_copy,
378 (GBoxedFreeFunc) gtk_tree_path_free);
384 * gtk_tree_path_compare:
385 * @a: A #GtkTreePath.
386 * @b: A #GtkTreePath to compare with.
388 * Compares two paths. If @a appears before @b in a tree, then -1 is returned.
389 * If @b appears before @a, then 1 is returned. If the two nodes are equal,
390 * then 0 is returned.
392 * Return value: The relative positions of @a and @b
395 gtk_tree_path_compare (const GtkTreePath *a,
396 const GtkTreePath *b)
400 g_return_val_if_fail (a != NULL, 0);
401 g_return_val_if_fail (b != NULL, 0);
402 g_return_val_if_fail (a->depth > 0, 0);
403 g_return_val_if_fail (b->depth > 0, 0);
407 if (a->indices[p] == b->indices[q])
409 return (a->indices[p] < b->indices[q]?-1:1);
411 while (++p < a->depth && ++q < b->depth);
412 if (a->depth == b->depth)
414 return (a->depth < b->depth?-1:1);
418 * gtk_tree_path_is_ancestor:
419 * @path: a #GtkTreePath
420 * @descendant: another #GtkTreePath
422 * Returns %TRUE if @descendant is a descendant of @path.
424 * Return value: %TRUE if @descendant is contained inside @path
427 gtk_tree_path_is_ancestor (GtkTreePath *path,
428 GtkTreePath *descendant)
432 g_return_val_if_fail (path != NULL, FALSE);
433 g_return_val_if_fail (descendant != NULL, FALSE);
435 /* can't be an ancestor if we're deeper */
436 if (path->depth >= descendant->depth)
440 while (i < path->depth)
442 if (path->indices[i] != descendant->indices[i])
451 * gtk_tree_path_is_descendant:
452 * @path: a #GtkTreePath
453 * @ancestor: another #GtkTreePath
455 * Returns %TRUE if @path is a descendant of @ancestor.
457 * Return value: %TRUE if @ancestor contains @path somewhere below it
460 gtk_tree_path_is_descendant (GtkTreePath *path,
461 GtkTreePath *ancestor)
465 g_return_val_if_fail (path != NULL, FALSE);
466 g_return_val_if_fail (ancestor != NULL, FALSE);
468 /* can't be a descendant if we're shallower in the tree */
469 if (path->depth <= ancestor->depth)
473 while (i < ancestor->depth)
475 if (path->indices[i] != ancestor->indices[i])
485 * gtk_tree_path_next:
486 * @path: A #GtkTreePath.
488 * Moves the @path to point to the next node at the current depth.
491 gtk_tree_path_next (GtkTreePath *path)
493 g_return_if_fail (path != NULL);
494 g_return_if_fail (path->depth > 0);
496 path->indices[path->depth - 1] ++;
500 * gtk_tree_path_prev:
501 * @path: A #GtkTreePath.
503 * Moves the @path to point to the previous node at the current depth, if it exists.
505 * Return value: %TRUE if @path has a previous node, and the move was made.
508 gtk_tree_path_prev (GtkTreePath *path)
510 g_return_val_if_fail (path != NULL, FALSE);
512 if (path->indices[path->depth - 1] == 0)
515 path->indices[path->depth - 1] -= 1;
522 * @path: A #GtkTreePath.
524 * Moves the @path to point to it's parent node, if it has a parent.
526 * Return value: %TRUE if @path has a parent, and the move was made.
529 gtk_tree_path_up (GtkTreePath *path)
531 g_return_val_if_fail (path != NULL, FALSE);
533 if (path->depth == 0)
542 * gtk_tree_path_down:
543 * @path: A #GtkTreePath.
545 * Moves @path to point to the first child of the current path.
548 gtk_tree_path_down (GtkTreePath *path)
550 g_return_if_fail (path != NULL);
552 gtk_tree_path_append_index (path, 0);
556 * gtk_tree_iter_copy:
557 * @iter: A #GtkTreeIter.
559 * Creates a dynamically allocated tree iterator as a copy of @iter. This
560 * function is not intended for use in applications, because you can just copy
561 * the structs by value (<literal>GtkTreeIter new_iter = iter;</literal>). You
562 * must free this iter with gtk_tree_iter_free ().
564 * Return value: a newly-allocated copy of @iter.
567 gtk_tree_iter_copy (GtkTreeIter *iter)
571 g_return_val_if_fail (iter != NULL, NULL);
573 retval = g_new (GtkTreeIter, 1);
580 * gtk_tree_iter_free:
581 * @iter: A dynamically allocated tree iterator.
583 * Frees an iterator that has been allocated on the heap. This function is
584 * mainly used for language bindings.
587 gtk_tree_iter_free (GtkTreeIter *iter)
589 g_return_if_fail (iter != NULL);
595 gtk_tree_iter_get_type (void)
597 static GType our_type = 0;
600 our_type = g_boxed_type_register_static ("GtkTypeTreeIter",
601 (GBoxedCopyFunc) gtk_tree_iter_copy,
602 (GBoxedFreeFunc) gtk_tree_iter_free);
608 * gtk_tree_model_get_flags:
609 * @tree_model: A #GtkTreeModel.
611 * Returns a set of flags supported by this interface. The flags are a bitwise
612 * combination of #GtkTreeModelFlags. The flags supported should not change
613 * during the lifecycle of the tree_model.
615 * Return value: The flags supported by this interface.
618 gtk_tree_model_get_flags (GtkTreeModel *tree_model)
620 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
622 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags)
623 return (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags) (tree_model);
629 * gtk_tree_model_get_n_columns:
630 * @tree_model: A #GtkTreeModel.
632 * Returns the number of columns supported by @tree_model.
634 * Return value: The number of columns.
637 gtk_tree_model_get_n_columns (GtkTreeModel *tree_model)
639 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
640 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns != NULL, 0);
642 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns) (tree_model);
646 * gtk_tree_model_get_column_type:
647 * @tree_model: A #GtkTreeModel.
648 * @index: The column index.
650 * Returns the type of the column.
652 * Return value: The type of the column.
655 gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
658 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), G_TYPE_INVALID);
659 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type != NULL, G_TYPE_INVALID);
660 g_return_val_if_fail (index >= 0, G_TYPE_INVALID);
662 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type) (tree_model, index);
666 * gtk_tree_model_get_iter:
667 * @tree_model: A #GtkTreeModel.
668 * @iter: The uninitialized #GtkTreeIter.
669 * @path: The #GtkTreePath.
671 * Sets @iter to a valid iterator pointing to @path.
673 * Return value: %TRUE, if @iter was set.
676 gtk_tree_model_get_iter (GtkTreeModel *tree_model,
680 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
681 g_return_val_if_fail (iter != NULL, FALSE);
682 g_return_val_if_fail (path != NULL, FALSE);
683 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter != NULL, FALSE);
684 g_return_val_if_fail (path->depth > 0, FALSE);
686 INITIALIZE_TREE_ITER (iter);
688 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter) (tree_model, iter, path);
692 * gtk_tree_model_get_iter_from_string:
693 * @tree_model: A #GtkTreeModel.
694 * @iter: An uninitialized #GtkTreeIter.
695 * @path_string: A string representation of a #GtkTreePath.
697 * Sets @iter to a valid iterator pointing to @path_string, if it
698 * exists. Otherwise, @iter is left invalid and %FALSE is returned.
700 * Return value: %TRUE, if @iter was set.
703 gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
705 const gchar *path_string)
710 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
711 g_return_val_if_fail (iter != NULL, FALSE);
712 g_return_val_if_fail (path_string != NULL, FALSE);
714 path = gtk_tree_path_new_from_string (path_string);
716 g_return_val_if_fail (path != NULL, FALSE);
718 retval = gtk_tree_model_get_iter (tree_model, iter, path);
719 gtk_tree_path_free (path);
725 * gtk_tree_model_get_string_from_iter:
726 * @tree_model: A #GtkTreeModel.
727 * @iter: An #GtkTreeIter.
729 * Generates a string representation of the iter. This string is a ':'
730 * separated list of numbers. For example, "4:10:0:3" would be an
731 * acceptable return value for this string.
733 * Return value: A newly-allocated string. Must be freed with g_free().
736 gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
742 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
743 g_return_val_if_fail (iter != NULL, NULL);
745 path = gtk_tree_model_get_path (tree_model, iter);
747 g_return_val_if_fail (path != NULL, NULL);
749 ret = gtk_tree_path_to_string (path);
750 gtk_tree_path_free (path);
756 * gtk_tree_model_get_iter_first:
757 * @tree_model: A #GtkTreeModel.
758 * @iter: The uninitialized #GtkTreeIter.
760 * Initializes @iter with the first iterator in the tree (the one at the path
761 * "0") and returns %TRUE. Returns %FALSE if the tree is empty.
763 * Return value: %TRUE, if @iter was set.
766 gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
772 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
773 g_return_val_if_fail (iter != NULL, FALSE);
775 path = gtk_tree_path_new_first ();
776 retval = gtk_tree_model_get_iter (tree_model, iter, path);
777 gtk_tree_path_free (path);
783 * gtk_tree_model_get_path:
784 * @tree_model: A #GtkTreeModel.
785 * @iter: The #GtkTreeIter.
787 * Returns a newly-created #GtkTreePath referenced by @iter. This path should
788 * be freed with gtk_tree_path_free().
790 * Return value: a newly-created #GtkTreePath.
793 gtk_tree_model_get_path (GtkTreeModel *tree_model,
796 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
797 g_return_val_if_fail (iter != NULL, NULL);
798 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path != NULL, NULL);
800 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path) (tree_model, iter);
804 * gtk_tree_model_get_value:
805 * @tree_model: A #GtkTreeModel.
806 * @iter: The #GtkTreeIter.
807 * @column: The column to lookup the value at.
808 * @value: An empty #GValue to set.
810 * Sets initializes and sets @value to that at @column. When done with @value,
811 * g_value_unset() needs to be called to free any allocated memory.
814 gtk_tree_model_get_value (GtkTreeModel *tree_model,
819 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
820 g_return_if_fail (iter != NULL);
821 g_return_if_fail (value != NULL);
822 g_return_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value != NULL);
824 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value) (tree_model, iter, column, value);
828 * gtk_tree_model_iter_next:
829 * @tree_model: A #GtkTreeModel.
830 * @iter: The #GtkTreeIter.
832 * Sets @iter to point to the node following it at the current level. If there
833 * is no next @iter, %FALSE is returned and @iter is set to be invalid.
835 * Return value: %TRUE if @iter has been changed to the next node.
838 gtk_tree_model_iter_next (GtkTreeModel *tree_model,
841 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
842 g_return_val_if_fail (iter != NULL, FALSE);
843 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next != NULL, FALSE);
845 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next) (tree_model, iter);
849 * gtk_tree_model_iter_children:
850 * @tree_model: A #GtkTreeModel.
851 * @iter: The new #GtkTreeIter to be set to the child.
852 * @parent: The #GtkTreeIter.
854 * Sets @iter to point to the first child of @parent. If @parent has no children,
855 * %FALSE is returned and @iter is set to be invalid. @parent will remain a valid
856 * node after this function has been called.
858 * Return value: %TRUE, if @child has been set to the first child.
861 gtk_tree_model_iter_children (GtkTreeModel *tree_model,
865 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
866 g_return_val_if_fail (iter != NULL, FALSE);
867 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children != NULL, FALSE);
869 INITIALIZE_TREE_ITER (iter);
871 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children) (tree_model, iter, parent);
875 * gtk_tree_model_iter_has_child:
876 * @tree_model: A #GtkTreeModel.
877 * @iter: The #GtkTreeIter to test for children.
879 * Returns %TRUE if @iter has children, %FALSE otherwise.
881 * Return value: %TRUE if @iter has children.
884 gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
887 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
888 g_return_val_if_fail (iter != NULL, FALSE);
889 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child != NULL, FALSE);
891 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child) (tree_model, iter);
895 * gtk_tree_model_iter_n_children:
896 * @tree_model: A #GtkTreeModel.
897 * @iter: The #GtkTreeIter, or %NULL.
899 * Returns the number of children that @iter has. As a special case, if @iter
900 * is %NULL, then the number of toplevel nodes is returned.
902 * Return value: The number of children of @iter.
905 gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
908 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
909 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children != NULL, 0);
911 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children) (tree_model, iter);
915 * gtk_tree_model_iter_nth_child:
916 * @tree_model: A #GtkTreeModel.
917 * @iter: The #GtkTreeIter to set to the nth child.
918 * @parent: The #GtkTreeIter to get the child from, or %NULL.
919 * @n: Then index of the desired child.
921 * Sets @iter to be the child of @parent, using the given index. The first
922 * index is 0. If @index is too big, or @parent has no children, @iter is set
923 * to an invalid iterator and %FALSE is returned. @parent will remain a valid
924 * node after this function has been called. As a special case, if @parent is
925 * %NULL, then the @n<!-- -->th root node is set.
927 * Return value: %TRUE, if @parent has an @n<!-- -->th child.
930 gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
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 (n >= 0, FALSE);
938 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child != NULL, FALSE);
940 INITIALIZE_TREE_ITER (iter);
942 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child) (tree_model, iter, parent, n);
946 * gtk_tree_model_iter_parent:
947 * @tree_model: A #GtkTreeModel
948 * @iter: The new #GtkTreeIter to set to the parent.
949 * @child: The #GtkTreeIter.
951 * Sets @iter to be the parent of @child. If @child is at the toplevel, and
952 * doesn't have a parent, then @iter is set to an invalid iterator and %FALSE
953 * is returned. @child will remain a valid node after this function has been
956 * Return value: %TRUE, if @iter is set to the parent of @child.
959 gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
963 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
964 g_return_val_if_fail (iter != NULL, FALSE);
965 g_return_val_if_fail (child != NULL, FALSE);
966 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent != NULL, FALSE);
968 INITIALIZE_TREE_ITER (iter);
970 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent) (tree_model, iter, child);
974 * gtk_tree_model_ref_node:
975 * @tree_model: A #GtkTreeModel.
976 * @iter: The #GtkTreeIter.
978 * Lets the tree ref the node. This is an optional method for models to
979 * implement. To be more specific, models may ignore this call as it exists
980 * primarily for performance reasons.
982 * This function is primarily meant as a way for views to let caching model know
983 * when nodes are being displayed (and hence, whether or not to cache that
984 * node.) For example, a file-system based model would not want to keep the
985 * entire file-hierarchy in memory, just the sections that are currently being
986 * displayed by every current view.
988 * A model should be expected to be able to get an iter independent of it's
992 gtk_tree_model_ref_node (GtkTreeModel *tree_model,
995 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
997 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node)
998 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node) (tree_model, iter);
1002 * gtk_tree_model_unref_node:
1003 * @tree_model: A #GtkTreeModel.
1004 * @iter: The #GtkTreeIter.
1006 * Lets the tree unref the node. This is an optional method for models to
1007 * implement. To be more specific, models may ignore this call as it exists
1008 * primarily for performance reasons.
1010 * For more information on what this means, see gtk_tree_model_ref_node().
1011 * Please note that nodes that are deleted are not unreffed.
1014 gtk_tree_model_unref_node (GtkTreeModel *tree_model,
1017 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1018 g_return_if_fail (iter != NULL);
1020 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node)
1021 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node) (tree_model, iter);
1025 * gtk_tree_model_get:
1026 * @tree_model: a #GtkTreeModel
1027 * @iter: a row in @tree_model
1028 * @Varargs: pairs of column number and value return locations, terminated by -1
1030 * Gets the value of one or more cells in the row referenced by @iter.
1031 * The variable argument list should contain integer column numbers,
1032 * each column number followed by a place to store the value being
1033 * retrieved. The list is terminated by a -1. For example, to get a
1034 * value from column 0 with type %G_TYPE_STRING, you would
1035 * write: <literal>gtk_tree_model_get (model, iter, 0, &place_string_here, -1)</literal>,
1036 * where <literal>place_string_here</literal> is a <type>gchar*</type> to be
1037 * filled with the string.
1038 * If appropriate, the returned values have to be freed or unreferenced.
1042 gtk_tree_model_get (GtkTreeModel *tree_model,
1048 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1049 g_return_if_fail (iter != NULL);
1051 va_start (var_args, iter);
1052 gtk_tree_model_get_valist (tree_model, iter, var_args);
1057 * gtk_tree_model_get_valist:
1058 * @tree_model: a #GtkTreeModel
1059 * @iter: a row in @tree_model
1060 * @var_args: <type>va_list</type> of column/return location pairs
1062 * See gtk_tree_model_get(), this version takes a <type>va_list</type>
1063 * for language bindings to use.
1066 gtk_tree_model_get_valist (GtkTreeModel *tree_model,
1072 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1073 g_return_if_fail (iter != NULL);
1075 column = va_arg (var_args, gint);
1077 while (column != -1)
1079 GValue value = { 0, };
1080 gchar *error = NULL;
1082 if (column >= gtk_tree_model_get_n_columns (tree_model))
1084 g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
1088 gtk_tree_model_get_value (GTK_TREE_MODEL (tree_model), iter, column, &value);
1090 G_VALUE_LCOPY (&value, var_args, 0, &error);
1093 g_warning ("%s: %s", G_STRLOC, error);
1096 /* we purposely leak the value here, it might not be
1097 * in a sane state if an error condition occoured
1102 g_value_unset (&value);
1104 column = va_arg (var_args, gint);
1109 * gtk_tree_model_row_changed:
1110 * @tree_model: A #GtkTreeModel
1111 * @path: A #GtkTreePath pointing to the changed row
1112 * @iter: A valid #GtkTreeIter pointing to the changed row
1114 * Emits the "row_changed" signal on @tree_model.
1117 gtk_tree_model_row_changed (GtkTreeModel *tree_model,
1121 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1122 g_return_if_fail (path != NULL);
1123 g_return_if_fail (iter != NULL);
1125 g_signal_emit_by_name (tree_model, "row_changed", path, iter);
1129 * gtk_tree_model_row_inserted:
1130 * @tree_model: A #GtkTreeModel
1131 * @path: A #GtkTreePath pointing to the inserted row
1132 * @iter: A valid #GtkTreeIter pointing to the inserted row
1134 * Emits the "row_inserted" signal on @tree_model
1137 gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
1141 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1142 g_return_if_fail (path != NULL);
1143 g_return_if_fail (iter != NULL);
1145 g_signal_emit_by_name (tree_model, "row_inserted", path, iter);
1149 * gtk_tree_model_row_has_child_toggled:
1150 * @tree_model: A #GtkTreeModel
1151 * @path: A #GtkTreePath pointing to the changed row
1152 * @iter: A valid #GtkTreeIter pointing to the changed row
1154 * Emits the "row_has_child_toggled" signal on @tree_model. This should be
1155 * called by models after the child state of a node changes.
1158 gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
1162 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1163 g_return_if_fail (path != NULL);
1164 g_return_if_fail (iter != NULL);
1166 g_signal_emit_by_name (tree_model, "row_has_child_toggled", path, iter);
1170 * gtk_tree_model_row_deleted:
1171 * @tree_model: A #GtkTreeModel
1172 * @path: A #GtkTreePath pointing to the previous location of the deleted row.
1174 * Emits the "row_deleted" signal on @tree_model. This should be called by
1175 * models after a row has been removed. The location pointed to by @path should
1176 * be the location that the row previously was at. It may not be a valid
1180 gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
1183 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1184 g_return_if_fail (path != NULL);
1186 g_signal_emit_by_name (tree_model, "row_deleted", path);
1190 * gtk_tree_model_rows_reordered:
1191 * @tree_model: A #GtkTreeModel
1192 * @path: A #GtkTreePath pointing to the tree node whose children have been reordered
1193 * @iter: A valid #GtkTreeIter pointing to the node whose children have been reordered
1194 * @new_order: an array of integers containing the new indices of the children,
1195 * i.e. the former child <literal>n</literal> is now at position
1196 * @new_order<literal>[n]</literal>.
1198 * Emits the "rows_reordered" signal on @tree_model. This should be called by
1199 * models when their rows have been reordered.
1202 gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
1207 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1208 g_return_if_fail (new_order != NULL);
1210 g_signal_emit_by_name (tree_model, "rows_reordered", path, iter, new_order);
1215 gtk_tree_model_foreach_helper (GtkTreeModel *model,
1218 GtkTreeModelForeachFunc func,
1225 if ((* func) (model, path, iter, user_data))
1228 if (gtk_tree_model_iter_children (model, &child, iter))
1230 gtk_tree_path_down (path);
1231 if (gtk_tree_model_foreach_helper (model, &child, path, func, user_data))
1233 gtk_tree_path_up (path);
1236 gtk_tree_path_next (path);
1238 while (gtk_tree_model_iter_next (model, iter));
1244 * gtk_tree_model_foreach:
1245 * @model: A #GtkTreeModel
1246 * @func: A function to be called on each row
1247 * @user_data: User data to passed to func.
1249 * Calls func on each node in model in a depth-first fashion. If func returns
1250 * %TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach() returns.
1254 gtk_tree_model_foreach (GtkTreeModel *model,
1255 GtkTreeModelForeachFunc func,
1261 g_return_if_fail (GTK_IS_TREE_MODEL (model));
1262 g_return_if_fail (func != NULL);
1264 path = gtk_tree_path_new_first ();
1265 if (gtk_tree_model_get_iter (model, &iter, path) == FALSE)
1267 gtk_tree_path_free (path);
1271 gtk_tree_model_foreach_helper (model, &iter, path, func, user_data);
1272 gtk_tree_path_free (path);
1277 * GtkTreeRowReference
1280 static void gtk_tree_row_reference_unref_path (GtkTreePath *path,
1281 GtkTreeModel *model,
1285 #define ROW_REF_DATA_STRING "gtk-tree-row-refs"
1287 struct _GtkTreeRowReference
1290 GtkTreeModel *model;
1301 release_row_references (gpointer data)
1303 RowRefList *refs = data;
1304 GSList *tmp_list = NULL;
1306 tmp_list = refs->list;
1307 while (tmp_list != NULL)
1309 GtkTreeRowReference *reference = tmp_list->data;
1311 if (reference->proxy == (GObject *)reference->model)
1312 reference->model = NULL;
1313 reference->proxy = NULL;
1315 /* we don't free the reference, users are responsible for that. */
1317 tmp_list = g_slist_next (tmp_list);
1320 g_slist_free (refs->list);
1325 gtk_tree_row_ref_inserted_callback (GObject *object,
1330 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1337 /* This function corrects the path stored in the reference to
1338 * account for an insertion. Note that it's called _after_ the insertion
1339 * with the path to the newly-inserted row. Which means that
1340 * the inserted path is in a different "coordinate system" than
1341 * the old path (e.g. if the inserted path was just before the old path,
1342 * then inserted path and old path will be the same, and old path must be
1346 tmp_list = refs->list;
1348 while (tmp_list != NULL)
1350 GtkTreeRowReference *reference = tmp_list->data;
1352 if (reference->path == NULL)
1355 if (reference->path->depth >= path->depth)
1358 gboolean ancestor = TRUE;
1360 for (i = 0; i < path->depth - 1; i ++)
1362 if (path->indices[i] != reference->path->indices[i])
1368 if (ancestor == FALSE)
1371 if (path->indices[path->depth-1] <= reference->path->indices[path->depth-1])
1372 reference->path->indices[path->depth-1] += 1;
1375 tmp_list = g_slist_next (tmp_list);
1380 gtk_tree_row_ref_deleted_callback (GObject *object,
1384 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1390 /* This function corrects the path stored in the reference to
1391 * account for an deletion. Note that it's called _after_ the
1392 * deletion with the old path of the just-deleted row. Which means
1393 * that the deleted path is the same now-defunct "coordinate system"
1394 * as the path saved in the reference, which is what we want to fix.
1397 tmp_list = refs->list;
1399 while (tmp_list != NULL)
1401 GtkTreeRowReference *reference = tmp_list->data;
1403 if (reference->path)
1407 if (path->depth > reference->path->depth)
1409 for (i = 0; i < path->depth - 1; i++)
1411 if (path->indices[i] != reference->path->indices[i])
1415 /* We know it affects us. */
1416 if (path->indices[i] == reference->path->indices[i])
1418 if (reference->path->depth > path->depth)
1419 /* some parent was deleted, trying to unref any node
1420 * between the deleted parent and the node the reference
1421 * is pointing to is bad, as those nodes are already gone.
1423 gtk_tree_row_reference_unref_path (reference->path, reference->model, path->depth - 1);
1425 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth - 1);
1426 gtk_tree_path_free (reference->path);
1427 reference->path = NULL;
1429 else if (path->indices[i] < reference->path->indices[i])
1431 reference->path->indices[path->depth-1]-=1;
1436 tmp_list = g_slist_next (tmp_list);
1441 gtk_tree_row_ref_reordered_callback (GObject *object,
1447 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1454 tmp_list = refs->list;
1456 while (tmp_list != NULL)
1458 GtkTreeRowReference *reference = tmp_list->data;
1460 length = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (reference->model), iter);
1465 if ((reference->path) &&
1466 (gtk_tree_path_is_ancestor (path, reference->path)))
1468 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1469 gint depth = gtk_tree_path_get_depth (path);
1471 if (ref_depth > depth)
1474 gint *indices = gtk_tree_path_get_indices (reference->path);
1476 for (i = 0; i < length; i++)
1478 if (new_order[i] == indices[depth])
1487 tmp_list = g_slist_next (tmp_list);
1493 connect_ref_callbacks (GtkTreeModel *model)
1495 g_signal_connect (G_OBJECT (model),
1497 (GCallback) gtk_tree_row_ref_inserted_callback,
1499 g_signal_connect (G_OBJECT (model),
1501 (GCallback) gtk_tree_row_ref_deleted_callback,
1503 g_signal_connect (G_OBJECT (model),
1505 (GCallback) gtk_tree_row_ref_reordered_callback,
1510 /* We do this recursively so that we can unref children nodes before their parent */
1512 gtk_tree_row_reference_unref_path_helper (GtkTreePath *path,
1513 GtkTreeModel *model,
1514 GtkTreeIter *parent_iter,
1520 if (depth == current_depth)
1523 gtk_tree_model_iter_nth_child (model, &iter, parent_iter, path->indices[current_depth]);
1524 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, current_depth + 1);
1525 gtk_tree_model_unref_node (model, &iter);
1529 gtk_tree_row_reference_unref_path (GtkTreePath *path,
1530 GtkTreeModel *model,
1538 gtk_tree_model_iter_nth_child (model, &iter, NULL, path->indices[0]);
1539 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth, 1);
1540 gtk_tree_model_unref_node (model, &iter);
1544 disconnect_ref_callbacks (GtkTreeModel *model)
1546 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1547 G_SIGNAL_MATCH_FUNC,
1549 (gpointer) gtk_tree_row_ref_inserted_callback,
1551 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1552 G_SIGNAL_MATCH_FUNC,
1554 (gpointer) gtk_tree_row_ref_deleted_callback,
1556 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1557 G_SIGNAL_MATCH_FUNC,
1559 (gpointer) gtk_tree_row_ref_reordered_callback,
1564 * gtk_tree_row_reference_new:
1565 * @model: A #GtkTreeModel
1566 * @path: A valid #GtkTreePath to monitor
1568 * Creates a row reference based on @path. This reference will keep pointing to
1569 * the node pointed to by @path, so long as it exists. It listens to all
1570 * signals emitted by @model, and updates it's path appropriately. If @path
1571 * isn't a valid path in @model, then %NULL is returned.
1573 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1575 GtkTreeRowReference *
1576 gtk_tree_row_reference_new (GtkTreeModel *model,
1579 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1580 g_return_val_if_fail (path != NULL, NULL);
1582 return gtk_tree_row_reference_new_proxy (G_OBJECT (model), model, path);
1586 * gtk_tree_row_reference_new_proxy:
1587 * @proxy: A proxy #GObject
1588 * @model: A #GtkTreeModel
1589 * @path: A valid #GtkTreePath to monitor
1591 * You do not need to use this function. Creates a row reference based on
1592 * @path. This reference will keep pointing to the node pointed to by @path, so
1593 * long as it exists. If @path isn't a valid path in @model, then %NULL is
1594 * returned. However, unlike references created with
1595 * gtk_tree_row_reference_new(), it does not listen to the model for changes.
1596 * The creator of the row reference must do this explicitly using
1597 * gtk_tree_row_reference_inserted(), gtk_tree_row_reference_deleted(),
1598 * gtk_tree_row_reference_reordered(). This must be called once per signal per
1601 * This type of row reference is primarily meant by structures that need to
1602 * carefully monitor exactly when a row_reference updates itself, and is not
1603 * generally needed by most applications.
1605 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1607 GtkTreeRowReference *
1608 gtk_tree_row_reference_new_proxy (GObject *proxy,
1609 GtkTreeModel *model,
1612 GtkTreeRowReference *reference;
1614 GtkTreeIter parent_iter;
1617 g_return_val_if_fail (G_IS_OBJECT (proxy), NULL);
1618 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1619 g_return_val_if_fail (path != NULL, NULL);
1620 g_return_val_if_fail (path->depth > 0, NULL);
1622 /* check that the path is valid */
1623 if (gtk_tree_model_get_iter (model, &parent_iter, path) == FALSE)
1626 /* Now we want to ref every node */
1627 gtk_tree_model_iter_nth_child (model, &parent_iter, NULL, path->indices[0]);
1628 gtk_tree_model_ref_node (model, &parent_iter);
1630 for (i = 1; i < path->depth; i++)
1633 gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, path->indices[i]);
1634 gtk_tree_model_ref_node (model, &iter);
1638 /* Make ther row reference */
1639 reference = g_new (GtkTreeRowReference, 1);
1641 g_object_ref (proxy);
1642 g_object_ref (model);
1643 reference->proxy = proxy;
1644 reference->model = model;
1645 reference->path = gtk_tree_path_copy (path);
1647 refs = g_object_get_data (G_OBJECT (proxy), ROW_REF_DATA_STRING);
1651 refs = g_new (RowRefList, 1);
1654 if (G_OBJECT (model) == proxy)
1655 connect_ref_callbacks (model);
1657 g_object_set_data_full (G_OBJECT (proxy),
1658 ROW_REF_DATA_STRING,
1659 refs, release_row_references);
1662 refs->list = g_slist_prepend (refs->list, reference);
1668 * gtk_tree_row_reference_get_path:
1669 * @reference: A #GtkTreeRowReference
1671 * Returns a path that the row reference currently points to, or %NULL if the
1672 * path pointed to is no longer valid.
1674 * Return value: A current path, or %NULL.
1677 gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
1679 g_return_val_if_fail (reference != NULL, NULL);
1681 if (reference->proxy == NULL)
1684 if (reference->path == NULL)
1687 return gtk_tree_path_copy (reference->path);
1691 * gtk_tree_row_reference_valid:
1692 * @reference: A #GtkTreeRowReference, or NULL
1694 * Returns TRUE if the %reference is non-NULL and refers to a current valid
1697 * Return value: TRUE if %reference points to a valid path.
1700 gtk_tree_row_reference_valid (GtkTreeRowReference *reference)
1702 if (reference == NULL || reference->path == NULL)
1709 * gtk_tree_row_reference_free:
1710 * @reference: A #GtkTreeRowReference, or NULL
1712 * Free's %reference. %reference may be NULL.
1715 gtk_tree_row_reference_free (GtkTreeRowReference *reference)
1719 if (reference == NULL)
1722 refs = g_object_get_data (G_OBJECT (reference->proxy), ROW_REF_DATA_STRING);
1726 g_warning (G_STRLOC": bad row reference, proxy has no outstanding row references");
1730 refs->list = g_slist_remove (refs->list, reference);
1732 if (refs->list == NULL)
1734 if (G_OBJECT (reference->model) == reference->proxy)
1735 disconnect_ref_callbacks (reference->model);
1737 g_object_set_data (G_OBJECT (reference->proxy),
1738 ROW_REF_DATA_STRING,
1742 if (reference->path)
1744 gtk_tree_row_reference_unref_path (reference->path, reference->model, reference->path->depth);
1745 gtk_tree_path_free (reference->path);
1748 g_object_unref (reference->proxy);
1749 g_object_unref (reference->model);
1754 * gtk_tree_row_reference_inserted:
1755 * @proxy: A #GObject
1756 * @path: The row position that was inserted
1758 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
1759 * know that the model emitted the "row_inserted" signal.
1762 gtk_tree_row_reference_inserted (GObject *proxy,
1765 g_return_if_fail (G_IS_OBJECT (proxy));
1767 gtk_tree_row_ref_inserted_callback (NULL, path, NULL, proxy);
1772 * gtk_tree_row_reference_deleted:
1773 * @proxy: A #GObject
1774 * @path: The path position that was deleted
1776 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
1777 * know that the model emitted the "row_deleted" signal.
1780 gtk_tree_row_reference_deleted (GObject *proxy,
1783 g_return_if_fail (G_IS_OBJECT (proxy));
1785 gtk_tree_row_ref_deleted_callback (NULL, path, proxy);
1789 * gtk_tree_row_reference_reordered:
1790 * @proxy: A #GObject
1791 * @path: The parent path of the reordered signal
1792 * @iter: The iter pointing to the parent of the reordered
1793 * @new_order: The new order of rows
1795 * Lets a set of row reference created by gtk_tree_row_reference_new_proxy()
1796 * know that the model emitted the "rows_reordered" signal.
1799 gtk_tree_row_reference_reordered (GObject *proxy,
1804 g_return_if_fail (G_IS_OBJECT (proxy));
1806 gtk_tree_row_ref_reordered_callback (NULL, path, iter, new_order, proxy);