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 "gtksignal.h"
37 static void gtk_tree_model_base_init (gpointer g_class);
41 gtk_tree_model_get_type (void)
43 static GtkType tree_model_type = 0;
45 if (! tree_model_type)
47 static const GTypeInfo tree_model_info =
49 sizeof (GtkTreeModelIface), /* class_size */
50 gtk_tree_model_base_init, /* base_init */
51 NULL, /* base_finalize */
53 NULL, /* class_finalize */
54 NULL, /* class_data */
60 tree_model_type = g_type_register_static (G_TYPE_INTERFACE, "GtkTreeModel", &tree_model_info, 0);
61 g_type_interface_add_prerequisite (tree_model_type, G_TYPE_OBJECT);
64 return tree_model_type;
68 gtk_tree_model_base_init (gpointer g_class)
70 static gboolean initialized = FALSE;
74 g_signal_new ("row_changed",
77 G_STRUCT_OFFSET (GtkTreeModelIface, row_changed),
79 gtk_marshal_VOID__BOXED_BOXED,
83 g_signal_new ("row_inserted",
86 G_STRUCT_OFFSET (GtkTreeModelIface, row_inserted),
88 gtk_marshal_VOID__BOXED_BOXED,
92 g_signal_new ("row_has_child_toggled",
95 G_STRUCT_OFFSET (GtkTreeModelIface, row_has_child_toggled),
97 gtk_marshal_VOID__BOXED_BOXED,
101 g_signal_new ("row_deleted",
104 G_STRUCT_OFFSET (GtkTreeModelIface, row_deleted),
106 gtk_marshal_VOID__BOXED,
109 g_signal_new ("rows_reordered",
112 G_STRUCT_OFFSET (GtkTreeModelIface, rows_reordered),
114 gtk_marshal_VOID__BOXED_BOXED_POINTER,
126 * Creates a new #GtkTreePath.
128 * Return value: A newly created #GtkTreePath.
130 /* GtkTreePath Operations */
132 gtk_tree_path_new (void)
135 retval = (GtkTreePath *) g_new (GtkTreePath, 1);
137 retval->indices = NULL;
143 * gtk_tree_path_new_from_string:
144 * @path: The string representation of a path.
146 * Creates a new #GtkTreePath initialized to @path. @path is expected to be a
147 * colon separated list of numbers. For example, the string "10:4:0" would
148 * create a path of depth 3 pointing to the 11th child of the root node, the 5th
149 * child of that 11th child, and the 1st child of that 5th child. If an invalid
150 * path is past in, NULL is returned.
152 * Return value: A newly created #GtkTreePath, or NULL
155 gtk_tree_path_new_from_string (const gchar *path)
158 const gchar *orig_path = path;
162 g_return_val_if_fail (path != NULL, NULL);
163 g_return_val_if_fail (*path != '\000', NULL);
165 retval = gtk_tree_path_new ();
169 i = strtol (path, &ptr, 10);
170 gtk_tree_path_append_index (retval, i);
174 g_warning (G_STRLOC ": Negative numbers in path %s passed to gtk_tree_path_new_from_string", orig_path);
175 gtk_tree_path_free (retval);
180 if (ptr == path || *ptr != ':')
182 g_warning (G_STRLOC ": Invalid path %s passed to gtk_tree_path_new_from_string", orig_path);
183 gtk_tree_path_free (retval);
193 * gtk_tree_path_to_string:
194 * @path: A #GtkTreePath
196 * Generates a string representation of the path. This string is a ':'
197 * separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
199 * Return value: A newly allocated string. Must be freed with #g_free.
202 gtk_tree_path_to_string (GtkTreePath *path)
207 g_return_val_if_fail (path != NULL, NULL);
209 if (path->depth == 0)
212 ptr = retval = (gchar *) g_new0 (char *, path->depth*8);
213 sprintf (retval, "%d", path->indices[0]);
214 while (*ptr != '\000')
217 for (i = 1; i < path->depth; i++)
219 sprintf (ptr, ":%d", path->indices[i]);
220 while (*ptr != '\000')
228 * gtk_tree_path_new_root:
230 * Creates a new root #GtkTreePath. The string representation of this path is
233 * Return value: A new #GtkTreePath.
236 gtk_tree_path_new_root (void)
240 retval = gtk_tree_path_new ();
241 gtk_tree_path_append_index (retval, 0);
247 * gtk_tree_path_append_index:
248 * @path: A #GtkTreePath.
251 * Appends a new index to a path. As a result, the depth of the path is
255 gtk_tree_path_append_index (GtkTreePath *path,
258 g_return_if_fail (path != NULL);
259 g_return_if_fail (index >= 0);
262 path->indices = g_realloc (path->indices, path->depth * sizeof(gint));
263 path->indices[path->depth - 1] = index;
267 * gtk_tree_path_prepend_index:
268 * @path: A #GtkTreePath.
271 * Prepends a new index to a path. As a result, the depth of the path is
275 gtk_tree_path_prepend_index (GtkTreePath *path,
278 gint *new_indices = g_new (gint, ++path->depth);
279 if (path->indices == NULL)
281 path->indices = new_indices;
282 path->indices[0] = index;
285 memcpy (new_indices + 1, path->indices, (path->depth - 1)*sizeof (gint));
286 g_free (path->indices);
287 path->indices = new_indices;
288 path->indices[0] = index;
292 * gtk_tree_path_get_depth:
293 * @path: A #GtkTreePath.
295 * Returns the current depth of @path.
297 * Return value: The depth of @path
300 gtk_tree_path_get_depth (GtkTreePath *path)
302 g_return_val_if_fail (path != NULL, 0);
308 * gtk_tree_path_get_indices:
309 * @path: A #GtkTreePath.
311 * Returns the current indices of @path. This is an array of integers, each
312 * representing a node in a tree.
314 * Return value: The current indices, or NULL.
317 gtk_tree_path_get_indices (GtkTreePath *path)
319 g_return_val_if_fail (path != NULL, NULL);
321 return path->indices;
325 * gtk_tree_path_free:
326 * @path: A #GtkTreePath.
331 gtk_tree_path_free (GtkTreePath *path)
333 g_return_if_fail (path != NULL);
335 g_free (path->indices);
340 * gtk_tree_path_copy:
341 * @path: A #GtkTreePath.
343 * Creates a new #GtkTreePath as a copy of @path.
345 * Return value: A new #GtkTreePath.
348 gtk_tree_path_copy (GtkTreePath *path)
352 g_return_val_if_fail (path != NULL, NULL);
354 retval = g_new (GtkTreePath, 1);
355 retval->depth = path->depth;
356 retval->indices = g_new (gint, path->depth);
357 memcpy (retval->indices, path->indices, path->depth * sizeof (gint));
362 * gtk_tree_path_compare:
363 * @a: A #GtkTreePath.
364 * @b: A #GtkTreePath to compare with.
366 * Compares two paths. If @a appears before @b in a tree, then -1, is returned.
367 * If @b appears before @a, then 1 is returned. If the two nodes are equal,
368 * then 0 is returned.
370 * Return value: The relative positions of @a and @b
373 gtk_tree_path_compare (const GtkTreePath *a,
374 const GtkTreePath *b)
378 g_return_val_if_fail (a != NULL, 0);
379 g_return_val_if_fail (b != NULL, 0);
380 g_return_val_if_fail (a->depth > 0, 0);
381 g_return_val_if_fail (b->depth > 0, 0);
385 if (a->indices[p] == b->indices[q])
387 return (a->indices[p] < b->indices[q]?-1:1);
389 while (++p < a->depth && ++q < b->depth);
390 if (a->depth == b->depth)
392 return (a->depth < b->depth?-1:1);
396 * gtk_tree_path_is_ancestor:
397 * @path: a #GtkTreePath
398 * @descendant: another #GtkTreePath
400 * Returns %TRUE if @descendant is a descendant of @path.
402 * Return value: %TRUE if @descendant is contained inside @path
405 gtk_tree_path_is_ancestor (GtkTreePath *path,
406 GtkTreePath *descendant)
410 g_return_val_if_fail (path != NULL, FALSE);
411 g_return_val_if_fail (descendant != NULL, FALSE);
413 /* can't be an ancestor if we're deeper */
414 if (path->depth >= descendant->depth)
418 while (i < path->depth)
420 if (path->indices[i] != descendant->indices[i])
429 * gtk_tree_path_is_descendant:
430 * @path: a #GtkTreePath
431 * @ancestor: another #GtkTreePath
435 * Return value: %TRUE if @ancestor contains @path somewhere below it
438 gtk_tree_path_is_descendant (GtkTreePath *path,
439 GtkTreePath *ancestor)
443 g_return_val_if_fail (path != NULL, FALSE);
444 g_return_val_if_fail (ancestor != NULL, FALSE);
446 /* can't be a descendant if we're shallower in the tree */
447 if (path->depth <= ancestor->depth)
451 while (i < ancestor->depth)
453 if (path->indices[i] != ancestor->indices[i])
463 * gtk_tree_path_next:
464 * @path: A #GtkTreePath.
466 * Moves the @path to point to the next node at the current depth.
469 gtk_tree_path_next (GtkTreePath *path)
471 g_return_if_fail (path != NULL);
472 g_return_if_fail (path->depth > 0);
474 path->indices[path->depth - 1] ++;
478 * gtk_tree_path_prev:
479 * @path: A #GtkTreePath.
481 * Moves the @path to point to the previous node at the current depth, if it exists.
483 * Return value: TRUE if @path has a previous node, and the move was made.
486 gtk_tree_path_prev (GtkTreePath *path)
488 g_return_val_if_fail (path != NULL, FALSE);
490 if (path->indices[path->depth - 1] == 0)
493 path->indices[path->depth - 1] -= 1;
500 * @path: A #GtkTreePath.
502 * Moves the @path to point to it's parent node, if it has a parent.
504 * Return value: TRUE if @path has a parent, and the move was made.
507 gtk_tree_path_up (GtkTreePath *path)
509 g_return_val_if_fail (path != NULL, FALSE);
511 if (path->depth == 0)
520 * gtk_tree_path_down:
521 * @path: A #GtkTreePath.
523 * Moves @path to point to the first child of the current path.
526 gtk_tree_path_down (GtkTreePath *path)
528 g_return_if_fail (path != NULL);
530 gtk_tree_path_append_index (path, 0);
534 * gtk_tree_iter_copy:
535 * @iter: A #GtkTreeIter.
537 * Creates a dynamically allocated tree iterator as a copy of @iter. This
538 * function is not intended for use in applications, because you can just copy
539 * the structs by value (GtkTreeIter new_iter = iter;). You
540 * must free this iter with gtk_tree_iter_free ().
542 * Return value: a newly allocated copy of @iter.
545 gtk_tree_iter_copy (GtkTreeIter *iter)
549 g_return_val_if_fail (iter != NULL, NULL);
551 retval = g_new (GtkTreeIter, 1);
558 * gtk_tree_iter_free:
559 * @iter: A dynamically allocated tree iterator.
561 * Free an iterator that has been allocated on the heap. This function is
562 * mainly used for language bindings.
565 gtk_tree_iter_free (GtkTreeIter *iter)
567 g_return_if_fail (iter != NULL);
573 * gtk_tree_model_get_flags:
574 * @tree_model: A #GtkTreeModel.
576 * Returns a set of flags supported by this interface. The flags are a bitwise
577 * combination of #GtkTreeModelFlags. The flags supported should not change
578 * during the lifecycle of the tree_model.
580 * Return value: The flags supported by this interface.
583 gtk_tree_model_get_flags (GtkTreeModel *tree_model)
585 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
587 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags)
588 return (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags) (tree_model);
594 * gtk_tree_model_get_n_columns:
595 * @tree_model: A #GtkTreeModel.
597 * Returns the number of columns supported by the #tree_model
599 * Return value: The number of columns.
602 gtk_tree_model_get_n_columns (GtkTreeModel *tree_model)
604 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
605 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns != NULL, 0);
607 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns) (tree_model);
611 * gtk_tree_model_get_column_type:
612 * @tree_model: A #GtkTreeModel.
613 * @index: The column index.
615 * Returns the type of the column.
617 * Return value: The type of the column.
620 gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
623 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), G_TYPE_INVALID);
624 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type != NULL, G_TYPE_INVALID);
625 g_return_val_if_fail (index >= 0, G_TYPE_INVALID);
627 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type) (tree_model, index);
631 * gtk_tree_model_get_iter:
632 * @tree_model: A #GtkTreeModel.
633 * @iter: The uninitialized #GtkTreeIter.
634 * @path: The #GtkTreePath.
636 * Sets @iter to a valid iterator pointing to @path.
638 * Return value: TRUE, if @iter was set.
641 gtk_tree_model_get_iter (GtkTreeModel *tree_model,
645 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
646 g_return_val_if_fail (iter != NULL, FALSE);
647 g_return_val_if_fail (path != NULL, FALSE);
648 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter != NULL, FALSE);
649 g_return_val_if_fail (path->depth > 0, FALSE);
651 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter) (tree_model, iter, path);
655 * gtk_tree_model_get_iter_from_string:
656 * @tree_model: A #GtkTreeModel.
657 * @iter: An uninitialized #GtkTreeIter.
658 * @path_string: A string representation of a #GtkTreePath.
660 * Sets @iter to a valid iterator pointing to @path_string, if it
661 * exists. Otherwise, @iter is left invalid and %FALSE is returned.
663 * Return value: TRUE, if @iter was set.
666 gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
668 const gchar *path_string)
673 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
674 g_return_val_if_fail (iter != NULL, FALSE);
675 g_return_val_if_fail (path_string != NULL, FALSE);
677 path = gtk_tree_path_new_from_string (path_string);
679 g_return_val_if_fail (path != NULL, FALSE);
681 retval = gtk_tree_model_get_iter (tree_model, iter, path);
682 gtk_tree_path_free (path);
689 * gtk_tree_model_get_iter_root:
690 * @tree_model: A #GtkTreeModel.
691 * @iter: The uninitialized #GtkTreeIter.
693 * Initialized @iter with the root iterator in the tree (the one at the root
694 * path) and returns %TRUE. Returns %FALSE if the tree is empty.
696 * Return value: TRUE, if @iter was set.
699 gtk_tree_model_get_iter_root (GtkTreeModel *tree_model,
705 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
706 g_return_val_if_fail (iter != NULL, FALSE);
708 path = gtk_tree_path_new_root ();
709 retval = gtk_tree_model_get_iter (tree_model, iter, path);
710 gtk_tree_path_free (path);
716 * gtk_tree_model_get_path:
717 * @tree_model: A #GtkTreeModel.
718 * @iter: The #GtkTreeIter.
720 * Returns a newly created #GtkTreePath referenced by @iter. This path should
721 * be freed with #gtk_tree_path_free.
723 * Return value: a newly created #GtkTreePath.
726 gtk_tree_model_get_path (GtkTreeModel *tree_model,
729 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
730 g_return_val_if_fail (iter != NULL, NULL);
731 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path != NULL, NULL);
733 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path) (tree_model, iter);
737 * gtk_tree_model_get_value:
738 * @tree_model: A #GtkTreeModel.
739 * @iter: The #GtkTreeIter.
740 * @column: The column to lookup the value at.
741 * @value: An empty #GValue to set.
743 * Sets initializes and sets @value to that at @column. When done with @value,
744 * #g_value_unset needs to be called to free any allocated memory.
747 gtk_tree_model_get_value (GtkTreeModel *tree_model,
752 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
753 g_return_if_fail (iter != NULL);
754 g_return_if_fail (value != NULL);
755 g_return_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value != NULL);
757 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value) (tree_model, iter, column, value);
761 * gtk_tree_model_iter_next:
762 * @tree_model: A #GtkTreeModel.
763 * @iter: The #GtkTreeIter.
765 * Sets @iter to point to the node following it at the current level. If there
766 * is no next @iter, FALSE is returned and @iter is set to be invalid.
768 * Return value: TRUE if @iter has been changed to the next node.
771 gtk_tree_model_iter_next (GtkTreeModel *tree_model,
774 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
775 g_return_val_if_fail (iter != NULL, FALSE);
776 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next != NULL, FALSE);
778 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next) (tree_model, iter);
782 * gtk_tree_model_iter_children:
783 * @tree_model: A #GtkTreeModel.
784 * @iter: The new #GtkTreeIter to be set to the child.
785 * @parent: The #GtkTreeIter.
787 * Sets @iter to point to the first child of @parent. If @parent has no children,
788 * FALSE is returned and @iter is set to be invalid. @parent will remain a valid
789 * node after this function has been called.
791 * Return value: TRUE, if @child has been set to the first child.
794 gtk_tree_model_iter_children (GtkTreeModel *tree_model,
798 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
799 g_return_val_if_fail (iter != NULL, FALSE);
800 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children != NULL, FALSE);
802 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children) (tree_model, iter, parent);
806 * gtk_tree_model_iter_has_child:
807 * @tree_model: A #GtkTreeModel.
808 * @iter: The #GtkTreeIter to test for children.
810 * Returns TRUE if @iter has children, FALSE otherwise.
812 * Return value: TRUE if @iter has children.
815 gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
818 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
819 g_return_val_if_fail (iter != NULL, FALSE);
820 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child != NULL, FALSE);
822 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child) (tree_model, iter);
826 * gtk_tree_model_iter_n_children:
827 * @tree_model: A #GtkTreeModel.
828 * @iter: The #GtkTreeIter, or NULL.
830 * Returns the number of children that @iter has. As a special case, if @iter
831 * is NULL, then the number of toplevel nodes is returned.
833 * Return value: The number of children of @iter.
836 gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
839 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
840 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children != NULL, 0);
842 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children) (tree_model, iter);
846 * gtk_tree_model_iter_nth_child:
847 * @tree_model: A #GtkTreeModel.
848 * @iter: The #GtkTreeIter to set to the nth child.
849 * @parent: The #GtkTreeIter to get the child from, or NULL.
850 * @n: Then index of the desired child.
852 * Sets @iter to be the child of @parent, using the given index. The first
853 * index is 0. If @index is too big, or @parent has no children, @iter is set
854 * to an invalid iterator and FALSE is returned. @parent will remain a valid
855 * node after this function has been called. As a special case, if @parent is
856 * NULL, then the nth root node is set.
858 * Return value: TRUE, if @parent has an nth child.
861 gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
866 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
867 g_return_val_if_fail (iter != NULL, FALSE);
868 g_return_val_if_fail (n >= 0, FALSE);
869 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child != NULL, FALSE);
871 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child) (tree_model, iter, parent, n);
875 * gtk_tree_model_iter_parent:
876 * @tree_model: A #GtkTreeModel
877 * @iter: The new #GtkTreeIter to set to the parent.
878 * @child: The #GtkTreeIter.
880 * Sets @iter to be the parent of @child. If @child is at the toplevel, and
881 * doesn't have a parent, then @iter is set to an invalid iterator and FALSE
882 * is returned. @child will remain a valid node after this function has been
885 * Return value: TRUE, if @iter is set to the parent of @child.
888 gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
892 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
893 g_return_val_if_fail (iter != NULL, FALSE);
894 g_return_val_if_fail (child != NULL, FALSE);
895 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent != NULL, FALSE);
897 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent) (tree_model, iter, child);
901 * gtk_tree_model_ref_node:
902 * @tree_model: A #GtkTreeModel.
903 * @iter: The #GtkTreeIter.
905 * Lets the tree ref the node. This is an optional method for models to
906 * implement. To be more specific, models may ignore this call as it exists
907 * primarily for performance reasons.
909 * This function is primarily meant as a way for views to let caching model know
910 * when nodes are being displayed (and hence, whether or not to cache that
911 * node.) For example, a file-system based model would not want to keep the
912 * entire file-heirarchy in memory, just the sections that are currently being
913 * displayed by every current view.
915 * A model should be expected to be able to get an iter independent of it's
919 gtk_tree_model_ref_node (GtkTreeModel *tree_model,
922 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
924 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node)
925 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node) (tree_model, iter);
929 * gtk_tree_model_unref_node:
930 * @tree_model: A #GtkTreeModel.
931 * @iter: The #GtkTreeIter.
933 * Lets the tree unref the node. This is an optional method for models to
934 * implement. To be more specific, models may ignore this call as it exists
935 * primarily for performance reasons.
937 * For more information on what this means, please see #gtk_tree_model_ref_node.
938 * Please note that nodes that are deleted are not unreffed.
941 gtk_tree_model_unref_node (GtkTreeModel *tree_model,
944 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
945 g_return_if_fail (iter != NULL);
947 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node)
948 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node) (tree_model, iter);
952 * gtk_tree_model_get:
953 * @tree_model: a #GtkTreeModel
954 * @iter: a row in @tree_model
955 * @Varargs: pairs of column number and value return locations, terminated by -1
957 * Gets the value of one or more cells in the row referenced by @iter.
958 * The variable argument list should contain integer column numbers,
959 * each column number followed by a place to store the value being
960 * retrieved. The list is terminated by a -1. For example, to get a
961 * value from column 0 with type %G_TYPE_STRING, you would
962 * write: gtk_tree_model_get (model, iter, 0, &place_string_here, -1),
963 * where place_string_here is a gchar* to be filled with the string.
964 * If appropriate, the returned values have to be freed or unreferenced.
968 gtk_tree_model_get (GtkTreeModel *tree_model,
974 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
975 g_return_if_fail (iter != NULL);
977 va_start (var_args, iter);
978 gtk_tree_model_get_valist (tree_model, iter, var_args);
983 * gtk_tree_model_get_valist:
984 * @tree_model: a #GtkTreeModel
985 * @iter: a row in @tree_model
986 * @var_args: va_list of column/return location pairs
988 * See gtk_tree_model_get(), this version takes a va_list for language bindings
992 gtk_tree_model_get_valist (GtkTreeModel *tree_model,
998 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
999 g_return_if_fail (iter != NULL);
1001 column = va_arg (var_args, gint);
1003 while (column != -1)
1005 GValue value = { 0, };
1006 gchar *error = NULL;
1008 if (column >= gtk_tree_model_get_n_columns (tree_model))
1010 g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
1014 gtk_tree_model_get_value (GTK_TREE_MODEL (tree_model), iter, column, &value);
1016 G_VALUE_LCOPY (&value, var_args, 0, &error);
1019 g_warning ("%s: %s", G_STRLOC, error);
1022 /* we purposely leak the value here, it might not be
1023 * in a sane state if an error condition occoured
1028 g_value_unset (&value);
1030 column = va_arg (var_args, gint);
1035 * gtk_tree_model_row_changed:
1036 * @tree_model: A #GtkTreeModel
1037 * @path: A #GtkTreePath pointing to the changed row
1038 * @iter: A valid #GtkTreeIter pointing to the changed row
1040 * Emits the "row_changed" signal on @tree_model.
1043 gtk_tree_model_row_changed (GtkTreeModel *tree_model,
1047 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1048 g_return_if_fail (path != NULL);
1049 g_return_if_fail (iter != NULL);
1051 g_signal_emit_by_name (tree_model, "row_changed", path, iter);
1055 * gtk_tree_model_row_inserted:
1056 * @tree_model: A #GtkTreeModel
1057 * @path: A #GtkTreePath pointing to the inserted row
1058 * @iter: A valid #GtkTreeIter pointing to the inserted row
1060 * Emits the "row_inserted" signal on @tree_model
1063 gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
1067 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1068 g_return_if_fail (path != NULL);
1069 g_return_if_fail (iter != NULL);
1071 g_signal_emit_by_name (tree_model, "row_inserted", path, iter);
1075 * gtk_tree_model_row_has_child_toggled:
1076 * @tree_model: A #GtkTreeModel
1077 * @path: A #GtkTreePath pointing to the changed row
1078 * @iter: A valid #GtkTreeIter pointing to the changed row
1080 * Emits the "row_has_child_toggled" signal on @tree_model. This should be
1081 * called by models after the child state of a node changes.
1084 gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
1088 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1089 g_return_if_fail (path != NULL);
1090 g_return_if_fail (iter != NULL);
1092 g_signal_emit_by_name (tree_model, "row_has_child_toggled", path, iter);
1096 gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
1099 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1100 g_return_if_fail (path != NULL);
1102 g_signal_emit_by_name (tree_model, "row_deleted", path);
1106 gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
1111 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1112 g_return_if_fail (new_order != NULL);
1114 g_signal_emit_by_name (tree_model, "rows_reordered", path, iter, new_order);
1119 gtk_tree_model_foreach_helper (GtkTreeModel *model,
1122 GtkTreeModelForeachFunc func,
1125 gtk_tree_path_append_index (path, 0);
1131 if (gtk_tree_model_iter_children (model, &child, iter))
1133 if (gtk_tree_model_foreach_helper (model, &child, path, func, user_data))
1137 if ((* func) (model, path, iter, user_data))
1140 gtk_tree_path_next (path);
1142 while (gtk_tree_model_iter_next (model, iter));
1144 gtk_tree_path_up (path);
1149 * gtk_tree_model_foreach:
1150 * @model: A #GtkTreeModel
1151 * @func: A function to be called on each row
1152 * @user_data: User data to passed to func.
1154 * Calls func on each node in model in a depth-first fashion. If func returns
1155 * %TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach returns.
1159 gtk_tree_model_foreach (GtkTreeModel *model,
1160 GtkTreeModelForeachFunc func,
1166 g_return_if_fail (GTK_IS_TREE_MODEL (model));
1167 g_return_if_fail (func != NULL);
1169 path = gtk_tree_path_new_root ();
1170 if (gtk_tree_model_get_iter (model, &iter, path) == FALSE)
1173 gtk_tree_model_foreach_helper (model, &iter, path, func, user_data);
1174 gtk_tree_path_free (path);
1179 * GtkTreeRowReference
1182 static void gtk_tree_row_reference_unref_path (GtkTreePath *path,
1183 GtkTreeModel *model,
1184 gboolean free_last);
1186 #define ROW_REF_DATA_STRING "gtk-tree-row-refs"
1188 struct _GtkTreeRowReference
1191 GtkTreeModel *model;
1202 release_row_references (gpointer data)
1204 RowRefList *refs = data;
1205 GSList *tmp_list = NULL;
1207 tmp_list = refs->list;
1208 while (tmp_list != NULL)
1210 GtkTreeRowReference *reference = tmp_list->data;
1212 if (reference->proxy == (GObject *)reference->model)
1213 reference->model = NULL;
1214 reference->proxy = NULL;
1216 /* we don't free the reference, users are responsible for that. */
1218 tmp_list = g_slist_next (tmp_list);
1221 g_slist_free (refs->list);
1226 gtk_tree_row_ref_inserted_callback (GObject *object,
1231 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1238 /* This function corrects the path stored in the reference to
1239 * account for an insertion. Note that it's called _after_ the insertion
1240 * with the path to the newly-inserted row. Which means that
1241 * the inserted path is in a different "coordinate system" than
1242 * the old path (e.g. if the inserted path was just before the old path,
1243 * then inserted path and old path will be the same, and old path must be
1247 tmp_list = refs->list;
1249 while (tmp_list != NULL)
1251 GtkTreeRowReference *reference = tmp_list->data;
1253 if (reference->path == NULL)
1256 if (reference->path->depth >= path->depth)
1259 gboolean ancestor = TRUE;
1261 for (i = 0; i < path->depth - 1; i ++)
1263 if (path->indices[i] != reference->path->indices[i])
1269 if (ancestor == FALSE)
1272 if (path->indices[path->depth-1] <= reference->path->indices[path->depth-1])
1273 reference->path->indices[path->depth-1] += 1;
1276 tmp_list = g_slist_next (tmp_list);
1281 gtk_tree_row_ref_deleted_callback (GObject *object,
1285 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1291 /* This function corrects the path stored in the reference to
1292 * account for an deletion. Note that it's called _after_ the
1293 * deletion with the old path of the just-deleted row. Which means
1294 * that the deleted path is the same now-defunct "coordinate system"
1295 * as the path saved in the reference, which is what we want to fix.
1298 tmp_list = refs->list;
1300 while (tmp_list != NULL)
1302 GtkTreeRowReference *reference = tmp_list->data;
1304 if (reference->path)
1308 if (path->depth > reference->path->depth)
1310 tmp_list = g_slist_next (tmp_list);
1313 for (i = 0; i < path->depth - 1; i++)
1315 if (path->indices[i] != reference->path->indices[i])
1317 tmp_list = g_slist_next (tmp_list);
1322 /* We know it affects us. */
1323 if (path->indices[i] == reference->path->indices[i])
1325 gtk_tree_row_reference_unref_path (reference->path, reference->model, FALSE);
1326 gtk_tree_path_free (reference->path);
1327 reference->path = NULL;
1329 else if (path->indices[i] < reference->path->indices[i])
1331 reference->path->indices[path->depth-1]-=1;
1334 tmp_list = g_slist_next (tmp_list);
1339 gtk_tree_row_ref_reordered_callback (GObject *object,
1345 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1352 tmp_list = refs->list;
1354 while (tmp_list != NULL)
1356 GtkTreeRowReference *reference = tmp_list->data;
1358 length = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (reference->model), iter);
1363 if ((reference->path) &&
1364 (gtk_tree_path_is_ancestor (path, reference->path)))
1366 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1367 gint depth = gtk_tree_path_get_depth (path);
1369 if (ref_depth > depth)
1372 gint *indices = gtk_tree_path_get_indices (reference->path);
1374 for (i = 0; i < length; i++)
1376 if (new_order[i] == indices[depth])
1385 tmp_list = g_slist_next (tmp_list);
1391 connect_ref_callbacks (GtkTreeModel *model)
1393 g_signal_connect (G_OBJECT (model),
1395 (GCallback) gtk_tree_row_ref_inserted_callback,
1397 g_signal_connect (G_OBJECT (model),
1399 (GCallback) gtk_tree_row_ref_deleted_callback,
1401 g_signal_connect (G_OBJECT (model),
1403 (GCallback) gtk_tree_row_ref_reordered_callback,
1408 /* We do this recursively so that we can unref children nodes before their parent */
1410 gtk_tree_row_reference_unref_path_helper (GtkTreePath *path,
1411 GtkTreeModel *model,
1412 GtkTreeIter *parent_iter,
1418 if (free_last == FALSE && path->depth - 1 == depth)
1420 if (path->depth == depth)
1423 gtk_tree_model_iter_nth_child (model, &iter, parent_iter, path->indices[depth]);
1424 gtk_tree_row_reference_unref_path_helper (path, model, &iter, depth + 1, free_last);
1425 gtk_tree_model_unref_node (model, &iter);
1429 gtk_tree_row_reference_unref_path (GtkTreePath *path,
1430 GtkTreeModel *model,
1435 if (free_last == FALSE && path->depth == 1)
1438 gtk_tree_model_iter_nth_child (model, &iter, NULL, path->indices[0]);
1439 gtk_tree_row_reference_unref_path_helper (path, model, &iter, 1, free_last);
1440 gtk_tree_model_unref_node (model, &iter);
1444 disconnect_ref_callbacks (GtkTreeModel *model)
1446 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1447 G_SIGNAL_MATCH_FUNC,
1449 gtk_tree_row_ref_inserted_callback,
1451 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1452 G_SIGNAL_MATCH_FUNC,
1454 gtk_tree_row_ref_deleted_callback,
1456 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1457 G_SIGNAL_MATCH_FUNC,
1459 gtk_tree_row_ref_reordered_callback,
1464 * gtk_tree_row_reference_new:
1465 * @model: A #GtkTreeModel
1466 * @path: A valid #GtkTreePath
1468 * Creates a row reference based on @path. This reference will keep pointing to
1469 * the node pointed to by @path, so long as it exists. It listens to all
1470 * signals on model, and updates it's path appropriately. If @path isn't a
1471 * valid path in @model, then %NULL is returned.
1473 * Return value: A newly allocated #GtkTreeRowReference, or %NULL
1475 GtkTreeRowReference *
1476 gtk_tree_row_reference_new (GtkTreeModel *model,
1479 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1480 g_return_val_if_fail (path != NULL, NULL);
1482 return gtk_tree_row_reference_new_proxy (G_OBJECT (model), model, path);
1485 GtkTreeRowReference *
1486 gtk_tree_row_reference_new_proxy (GObject *proxy,
1487 GtkTreeModel *model,
1490 GtkTreeRowReference *reference;
1492 GtkTreeIter parent_iter;
1495 g_return_val_if_fail (G_IS_OBJECT (proxy), NULL);
1496 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1497 g_return_val_if_fail (path != NULL, NULL);
1498 g_return_val_if_fail (path->depth > 0, NULL);
1500 /* check that the path is valid */
1501 if (gtk_tree_model_get_iter (model, &parent_iter, path) == FALSE)
1504 /* Now we want to ref every node */
1505 gtk_tree_model_iter_nth_child (model, &parent_iter, NULL, path->indices[0]);
1506 gtk_tree_model_ref_node (model, &parent_iter);
1508 for (i = 1; i < path->depth; i++)
1511 gtk_tree_model_iter_nth_child (model, &iter, &parent_iter, path->indices[i]);
1512 gtk_tree_model_ref_node (model, &iter);
1516 /* Make ther row reference */
1517 reference = g_new (GtkTreeRowReference, 1);
1519 g_object_ref (proxy);
1520 g_object_ref (model);
1521 reference->proxy = proxy;
1522 reference->model = model;
1523 reference->path = gtk_tree_path_copy (path);
1525 refs = g_object_get_data (G_OBJECT (proxy), ROW_REF_DATA_STRING);
1529 refs = g_new (RowRefList, 1);
1532 if (G_OBJECT (model) == proxy)
1533 connect_ref_callbacks (model);
1535 g_object_set_data_full (G_OBJECT (proxy),
1536 ROW_REF_DATA_STRING,
1537 refs, release_row_references);
1540 refs->list = g_slist_prepend (refs->list, reference);
1546 * gtk_tree_row_reference_get_path:
1547 * @reference: A #GtkTreeRowReference
1549 * Returns a path that the row reference currently points to, or NULL if the
1550 * path pointed to is no longer valid.
1552 * Return value: A current path, or NULL.
1555 gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
1557 g_return_val_if_fail (reference != NULL, NULL);
1559 if (reference->proxy == NULL)
1562 if (reference->path == NULL)
1565 return gtk_tree_path_copy (reference->path);
1569 * gtk_tree_row_reference_valid:
1570 * @reference: A #GtkTreeRowReference, or NULL
1572 * Returns TRUE if the %reference is non-NULL and refers to a current valid
1575 * Return value: TRUE if %reference points to a valid path.
1578 gtk_tree_row_reference_valid (GtkTreeRowReference *reference)
1580 if (reference == NULL || reference->path == NULL)
1587 * gtk_tree_row_reference_free:
1588 * @reference: A #GtkTreeRowReference, or NULL
1590 * Free's %reference. %reference may be NULL.
1593 gtk_tree_row_reference_free (GtkTreeRowReference *reference)
1597 if (reference == NULL)
1600 refs = g_object_get_data (G_OBJECT (reference->proxy), ROW_REF_DATA_STRING);
1604 g_warning (G_STRLOC": bad row reference, proxy has no outstanding row references");
1608 refs->list = g_slist_remove (refs->list, reference);
1610 if (refs->list == NULL)
1612 disconnect_ref_callbacks (reference->model);
1613 g_object_set_data (G_OBJECT (reference->proxy),
1614 ROW_REF_DATA_STRING,
1617 g_object_unref (reference->proxy);
1618 g_object_unref (reference->model);
1620 if (reference->path)
1622 gtk_tree_row_reference_unref_path (reference->path, reference->model, TRUE);
1623 gtk_tree_path_free (reference->path);
1630 gtk_tree_row_reference_inserted (GObject *proxy,
1633 g_return_if_fail (G_IS_OBJECT (proxy));
1635 gtk_tree_row_ref_inserted_callback (NULL, path, NULL, proxy);
1640 gtk_tree_row_reference_deleted (GObject *proxy,
1643 g_return_if_fail (G_IS_OBJECT (proxy));
1645 gtk_tree_row_ref_deleted_callback (NULL, path, proxy);
1649 gtk_tree_row_reference_reordered (GObject *proxy,
1654 g_return_if_fail (G_IS_OBJECT (proxy));
1656 gtk_tree_row_ref_reordered_callback (NULL, path, iter, new_order, proxy);