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 ("range_changed",
77 G_STRUCT_OFFSET (GtkTreeModelIface, range_changed),
79 gtk_marshal_VOID__BOXED_BOXED_BOXED_BOXED,
85 g_signal_new ("inserted",
88 G_STRUCT_OFFSET (GtkTreeModelIface, inserted),
90 gtk_marshal_VOID__BOXED_BOXED,
94 g_signal_new ("has_child_toggled",
97 G_STRUCT_OFFSET (GtkTreeModelIface, has_child_toggled),
99 gtk_marshal_VOID__BOXED_BOXED,
103 g_signal_new ("deleted",
106 G_STRUCT_OFFSET (GtkTreeModelIface, deleted),
108 gtk_marshal_VOID__BOXED,
111 g_signal_new ("reordered",
114 G_STRUCT_OFFSET (GtkTreeModelIface, reordered),
116 gtk_marshal_VOID__BOXED_BOXED_POINTER,
128 * Creates a new #GtkTreePath.
130 * Return value: A newly created #GtkTreePath.
132 /* GtkTreePath Operations */
134 gtk_tree_path_new (void)
137 retval = (GtkTreePath *) g_new (GtkTreePath, 1);
139 retval->indices = NULL;
145 * gtk_tree_path_new_from_string:
146 * @path: The string representation of a path.
148 * Creates a new #GtkTreePath initialized to @path. @path is expected to be a
149 * colon separated list of numbers. For example, the string "10:4:0" would
150 * create a path of depth 3 pointing to the 11th child of the root node, the 5th
151 * child of that 11th child, and the 1st child of that 5th child. If an invalid
152 * path is past in, NULL is returned.
154 * Return value: A newly created #GtkTreePath, or NULL
157 gtk_tree_path_new_from_string (gchar *path)
160 gchar *orig_path = path;
164 g_return_val_if_fail (path != NULL, NULL);
165 g_return_val_if_fail (*path != '\000', NULL);
167 retval = gtk_tree_path_new ();
171 i = strtol (path, &ptr, 10);
172 gtk_tree_path_append_index (retval, i);
176 g_warning (G_STRLOC"Negative numbers in path %s passed to gtk_tree_path_new_from_string", orig_path);
177 gtk_tree_path_free (retval);
182 if (ptr == path || *ptr != ':')
184 g_warning (G_STRLOC"Invalid path %s passed to gtk_tree_path_new_from_string", orig_path);
185 gtk_tree_path_free (retval);
195 * gtk_tree_path_to_string:
196 * @path: A #GtkTreePath
198 * Generates a string representation of the path. This string is a ':'
199 * separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string.
201 * Return value: A newly allocated string. Must be freed with #g_free.
204 gtk_tree_path_to_string (GtkTreePath *path)
209 g_return_val_if_fail (path != NULL, NULL);
211 if (path->depth == 0)
214 ptr = retval = (gchar *) g_new0 (char *, path->depth*8);
215 sprintf (retval, "%d", path->indices[0]);
216 while (*ptr != '\000')
219 for (i = 1; i < path->depth; i++)
221 sprintf (ptr, ":%d", path->indices[i]);
222 while (*ptr != '\000')
230 * gtk_tree_path_new_root:
232 * Creates a new root #GtkTreePath. The string representation of this path is
235 * Return value: A new #GtkTreePath.
238 gtk_tree_path_new_root (void)
242 retval = gtk_tree_path_new ();
243 gtk_tree_path_append_index (retval, 0);
249 * gtk_tree_path_append_index:
250 * @path: A #GtkTreePath.
253 * Appends a new index to a path. As a result, the depth of the path is
257 gtk_tree_path_append_index (GtkTreePath *path,
260 g_return_if_fail (path != NULL);
261 g_return_if_fail (index >= 0);
264 path->indices = g_realloc (path->indices, path->depth * sizeof(gint));
265 path->indices[path->depth - 1] = index;
269 * gtk_tree_path_prepend_index:
270 * @path: A #GtkTreePath.
273 * Prepends a new index to a path. As a result, the depth of the path is
277 gtk_tree_path_prepend_index (GtkTreePath *path,
280 gint *new_indices = g_new (gint, ++path->depth);
281 if (path->indices == NULL)
283 path->indices = new_indices;
284 path->indices[0] = index;
287 memcpy (new_indices + 1, path->indices, (path->depth - 1)*sizeof (gint));
288 g_free (path->indices);
289 path->indices = new_indices;
290 path->indices[0] = index;
294 * gtk_tree_path_get_depth:
295 * @path: A #GtkTreePath.
297 * Returns the current depth of @path.
299 * Return value: The depth of @path
302 gtk_tree_path_get_depth (GtkTreePath *path)
304 g_return_val_if_fail (path != NULL, 0);
310 * gtk_tree_path_get_indices:
311 * @path: A #GtkTreePath.
313 * Returns the current indices of @path. This is an array of integers, each
314 * representing a node in a tree.
316 * Return value: The current indices, or NULL.
319 gtk_tree_path_get_indices (GtkTreePath *path)
321 g_return_val_if_fail (path != NULL, NULL);
323 return path->indices;
327 * gtk_tree_path_free:
328 * @path: A #GtkTreePath.
333 gtk_tree_path_free (GtkTreePath *path)
335 g_return_if_fail (path != NULL);
337 g_free (path->indices);
342 * gtk_tree_path_copy:
343 * @path: A #GtkTreePath.
345 * Creates a new #GtkTreePath as a copy of @path.
347 * Return value: A new #GtkTreePath.
350 gtk_tree_path_copy (GtkTreePath *path)
354 g_return_val_if_fail (path != NULL, NULL);
356 retval = g_new (GtkTreePath, 1);
357 retval->depth = path->depth;
358 retval->indices = g_new (gint, path->depth);
359 memcpy (retval->indices, path->indices, path->depth * sizeof (gint));
364 * gtk_tree_path_compare:
365 * @a: A #GtkTreePath.
366 * @b: A #GtkTreePath to compare with.
368 * Compares two paths. If @a appears before @b in a tree, then -1, is returned.
369 * If @b appears before @a, then 1 is returned. If the two nodes are equal,
370 * then 0 is returned.
372 * Return value: The relative positions of @a and @b
375 gtk_tree_path_compare (const GtkTreePath *a,
376 const GtkTreePath *b)
380 g_return_val_if_fail (a != NULL, 0);
381 g_return_val_if_fail (b != NULL, 0);
382 g_return_val_if_fail (a->depth > 0, 0);
383 g_return_val_if_fail (b->depth > 0, 0);
387 if (a->indices[p] == b->indices[q])
389 return (a->indices[p] < b->indices[q]?-1:1);
391 while (++p < a->depth && ++q < b->depth);
392 if (a->depth == b->depth)
394 return (a->depth < b->depth?-1:1);
398 * gtk_tree_path_is_ancestor:
399 * @path: a #GtkTreePath
400 * @descendant: another #GtkTreePath
404 * Return value: %TRUE if @descendant is contained inside @path
407 gtk_tree_path_is_ancestor (GtkTreePath *path,
408 GtkTreePath *descendant)
412 g_return_val_if_fail (path != NULL, FALSE);
413 g_return_val_if_fail (descendant != NULL, FALSE);
415 /* can't be an ancestor if we're deeper */
416 if (path->depth >= descendant->depth)
420 while (i < path->depth)
422 if (path->indices[i] != descendant->indices[i])
431 * gtk_tree_path_is_descendant:
432 * @path: a #GtkTreePath
433 * @ancestor: another #GtkTreePath
437 * Return value: %TRUE if @ancestor contains @path somewhere below it
440 gtk_tree_path_is_descendant (GtkTreePath *path,
441 GtkTreePath *ancestor)
445 g_return_val_if_fail (path != NULL, FALSE);
446 g_return_val_if_fail (ancestor != NULL, FALSE);
448 /* can't be a descendant if we're shallower in the tree */
449 if (path->depth <= ancestor->depth)
453 while (i < ancestor->depth)
455 if (path->indices[i] != ancestor->indices[i])
465 * gtk_tree_path_next:
466 * @path: A #GtkTreePath.
468 * Moves the @path to point to the next node at the current depth.
471 gtk_tree_path_next (GtkTreePath *path)
473 g_return_if_fail (path != NULL);
474 g_return_if_fail (path->depth > 0);
476 path->indices[path->depth - 1] ++;
480 * gtk_tree_path_prev:
481 * @path: A #GtkTreePath.
483 * Moves the @path to point to the previous node at the current depth, if it exists.
485 * Return value: TRUE if @path has a previous node, and the move was made.
488 gtk_tree_path_prev (GtkTreePath *path)
490 g_return_val_if_fail (path != NULL, FALSE);
492 if (path->indices[path->depth - 1] == 0)
495 path->indices[path->depth - 1] -= 1;
502 * @path: A #GtkTreePath.
504 * Moves the @path to point to it's parent node, if it has a parent.
506 * Return value: TRUE if @path has a parent, and the move was made.
509 gtk_tree_path_up (GtkTreePath *path)
511 g_return_val_if_fail (path != NULL, FALSE);
513 if (path->depth == 1)
522 * gtk_tree_path_down:
523 * @path: A #GtkTreePath.
525 * Moves @path to point to the first child of the current path.
528 gtk_tree_path_down (GtkTreePath *path)
530 g_return_if_fail (path != NULL);
532 gtk_tree_path_append_index (path, 0);
536 * gtk_tree_iter_copy:
537 * @iter: A #GtkTreeIter.
539 * Creates a dynamically allocated tree iterator as a copy of @iter. This
540 * function is not intended for use in applications, because you can just copy
541 * the structs by value (GtkTreeIter new_iter = iter;). You
542 * must free this iter with gtk_tree_iter_free ().
544 * Return value: a newly allocated copy of @iter.
547 gtk_tree_iter_copy (GtkTreeIter *iter)
551 g_return_val_if_fail (iter != NULL, NULL);
553 retval = g_new (GtkTreeIter, 1);
560 * gtk_tree_iter_free:
561 * @iter: A dynamically allocated tree iterator.
563 * Free an iterator that has been allocated on the heap. This function is
564 * mainly used for language bindings.
567 gtk_tree_iter_free (GtkTreeIter *iter)
569 g_return_if_fail (iter != NULL);
575 * gtk_tree_model_get_flags:
576 * @tree_model: A #GtkTreeModel.
578 * Returns a set of flags supported by this interface. The flags are a bitwise
579 * combination of #GtkTreeModelFlags. The flags supported should not change
580 * during the lifecycle of the tree_model.
582 * Return value: The flags supported by this interface.
585 gtk_tree_model_get_flags (GtkTreeModel *tree_model)
587 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
589 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags)
590 return (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_flags) (tree_model);
596 * gtk_tree_model_get_n_columns:
597 * @tree_model: A #GtkTreeModel.
599 * Returns the number of columns supported by the #tree_model
601 * Return value: The number of columns.
604 gtk_tree_model_get_n_columns (GtkTreeModel *tree_model)
606 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
607 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns != NULL, 0);
609 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_n_columns) (tree_model);
613 * gtk_tree_model_get_column_type:
614 * @tree_model: A #GtkTreeModel.
615 * @index: The column index.
617 * Returns the type of the column.
619 * Return value: The type of the column.
622 gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
625 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), G_TYPE_INVALID);
626 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type != NULL, G_TYPE_INVALID);
627 g_return_val_if_fail (index >= 0, G_TYPE_INVALID);
629 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_column_type) (tree_model, index);
633 * gtk_tree_model_get_iter:
634 * @tree_model: A #GtkTreeModel.
635 * @iter: The uninitialized #GtkTreeIter.
636 * @path: The #GtkTreePath.
638 * Sets @iter to a valid iterator pointing to @path.
640 * Return value: TRUE, if @iter was set.
643 gtk_tree_model_get_iter (GtkTreeModel *tree_model,
647 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
648 g_return_val_if_fail (iter != NULL, FALSE);
649 g_return_val_if_fail (path != NULL, FALSE);
650 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter != NULL, FALSE);
651 g_return_val_if_fail (path->depth > 0, FALSE);
653 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_iter) (tree_model, iter, path);
658 * gtk_tree_model_get_iter_root:
659 * @tree_model: A #GtkTreeModel.
660 * @iter: The uninitialized #GtkTreeIter.
662 * Initialized @iter with the root iterator in the tree (the one at the root
663 * path) and returns %TRUE. Returns %FALSE if the tree is empty.
665 * Return value: TRUE, if @iter was set.
668 gtk_tree_model_get_iter_root (GtkTreeModel *tree_model,
674 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
675 g_return_val_if_fail (iter != NULL, FALSE);
677 path = gtk_tree_path_new_root ();
678 retval = gtk_tree_model_get_iter (tree_model, iter, path);
679 gtk_tree_path_free (path);
685 * gtk_tree_model_get_path:
686 * @tree_model: A #GtkTreeModel.
687 * @iter: The #GtkTreeIter.
689 * Returns a newly created #GtkTreePath referenced by @iter. This path should
690 * be freed with #gtk_tree_path_free.
692 * Return value: a newly created #GtkTreePath.
695 gtk_tree_model_get_path (GtkTreeModel *tree_model,
698 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), NULL);
699 g_return_val_if_fail (iter != NULL, NULL);
700 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path != NULL, NULL);
702 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_path) (tree_model, iter);
706 * gtk_tree_model_get_value:
707 * @tree_model: A #GtkTreeModel.
708 * @iter: The #GtkTreeIter.
709 * @column: The column to lookup the value at.
710 * @value: An empty #GValue to set.
712 * Sets initializes and sets @value to that at @column. When done with @value,
713 * #g_value_unset needs to be called to free any allocated memory.
716 gtk_tree_model_get_value (GtkTreeModel *tree_model,
721 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
722 g_return_if_fail (iter != NULL);
723 g_return_if_fail (value != NULL);
724 g_return_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value != NULL);
726 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->get_value) (tree_model, iter, column, value);
730 * gtk_tree_model_iter_next:
731 * @tree_model: A #GtkTreeModel.
732 * @iter: The #GtkTreeIter.
734 * Sets @iter to point to the node following it at the current level. If there
735 * is no next @iter, FALSE is returned and @iter is set to be invalid.
737 * Return value: TRUE if @iter has been changed to the next node.
740 gtk_tree_model_iter_next (GtkTreeModel *tree_model,
743 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
744 g_return_val_if_fail (iter != NULL, FALSE);
745 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next != NULL, FALSE);
747 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_next) (tree_model, iter);
751 * gtk_tree_model_iter_children:
752 * @tree_model: A #GtkTreeModel.
753 * @iter: The new #GtkTreeIter to be set to the child.
754 * @parent: The #GtkTreeIter.
756 * Sets @iter to point to the first child of @parent. If @parent has no children,
757 * FALSE is returned and @iter is set to be invalid. @parent will remain a valid
758 * node after this function has been called.
760 * Return value: TRUE, if @child has been set to the first child.
763 gtk_tree_model_iter_children (GtkTreeModel *tree_model,
767 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
768 g_return_val_if_fail (iter != NULL, FALSE);
769 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children != NULL, FALSE);
771 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_children) (tree_model, iter, parent);
775 * gtk_tree_model_iter_has_child:
776 * @tree_model: A #GtkTreeModel.
777 * @iter: The #GtkTreeIter to test for children.
779 * Returns TRUE if @iter has children, FALSE otherwise.
781 * Return value: TRUE if @iter has children.
784 gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
787 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
788 g_return_val_if_fail (iter != NULL, FALSE);
789 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child != NULL, FALSE);
791 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_has_child) (tree_model, iter);
795 * gtk_tree_model_iter_n_children:
796 * @tree_model: A #GtkTreeModel.
797 * @iter: The #GtkTreeIter, or NULL.
799 * Returns the number of children that @iter has. As a special case, if @iter
800 * is NULL, then the number of toplevel nodes is returned.
802 * Return value: The number of children of @iter.
805 gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
808 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), 0);
809 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children != NULL, 0);
811 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_n_children) (tree_model, iter);
815 * gtk_tree_model_iter_nth_child:
816 * @tree_model: A #GtkTreeModel.
817 * @iter: The #GtkTreeIter to set to the nth child.
818 * @parent: The #GtkTreeIter to get the child from, or NULL.
819 * @n: Then index of the desired child.
821 * Sets @iter to be the child of @parent, using the given index. The first
822 * index is 0. If @index is too big, or @parent has no children, @iter is set
823 * to an invalid iterator and FALSE is returned. @parent will remain a valid
824 * node after this function has been called. As a special case, if @parent is
825 * NULL, then the nth root node is set.
827 * Return value: TRUE, if @parent has an nth child.
830 gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
835 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
836 g_return_val_if_fail (iter != NULL, FALSE);
837 g_return_val_if_fail (n >= 0, FALSE);
838 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child != NULL, FALSE);
840 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_nth_child) (tree_model, iter, parent, n);
844 * gtk_tree_model_iter_parent:
845 * @tree_model: A #GtkTreeModel
846 * @iter: The new #GtkTreeIter to set to the parent.
847 * @child: The #GtkTreeIter.
849 * Sets @iter to be the parent of @child. If @child is at the toplevel, and
850 * doesn't have a parent, then @iter is set to an invalid iterator and FALSE
851 * is returned. @child will remain a valid node after this function has been
854 * Return value: TRUE, if @iter is set to the parent of @child.
857 gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
861 g_return_val_if_fail (GTK_IS_TREE_MODEL (tree_model), FALSE);
862 g_return_val_if_fail (iter != NULL, FALSE);
863 g_return_val_if_fail (child != NULL, FALSE);
864 g_return_val_if_fail (GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent != NULL, FALSE);
866 return (* GTK_TREE_MODEL_GET_IFACE (tree_model)->iter_parent) (tree_model, iter, child);
870 * gtk_tree_model_ref_node:
871 * @tree_model: A #GtkTreeModel.
872 * @iter: The #GtkTreeIter.
874 * Lets the tree ref the node. This is an optional method for models to
875 * implement. To be more specific, models may ignore this call as it exists
876 * primarily for performance reasons.
878 * This function is primarily meant as a way for views to let caching model know
879 * when nodes are being displayed (and hence, whether or not to cache that
880 * node.) For example, a file-system based model would not want to keep the
881 * entire file-heirarchy in memory, just the sections that are currently being
882 * displayed by every current view.
884 * A model should be expected to be able to get an iter independent of it's
888 gtk_tree_model_ref_node (GtkTreeModel *tree_model,
891 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
893 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node)
894 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->ref_node) (tree_model, iter);
898 * gtk_tree_model_unref_node:
899 * @tree_model: A #GtkTreeModel.
900 * @iter: The #GtkTreeIter.
902 * Lets the tree unref the node. This is an optional method for models to
903 * implement. To be more specific, models may ignore this call as it exists
904 * primarily for performance reasons.
906 * For more information on what this means, please see #gtk_tree_model_ref_node.
907 * Please note that nodes that are deleted are not unreffed.
910 gtk_tree_model_unref_node (GtkTreeModel *tree_model,
913 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
914 g_return_if_fail (iter != NULL);
916 if (GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node)
917 (* GTK_TREE_MODEL_GET_IFACE (tree_model)->unref_node) (tree_model, iter);
921 * gtk_tree_model_get:
922 * @tree_model: a #GtkTreeModel
923 * @iter: a row in @tree_model
924 * @Varargs: pairs of column number and value return locations, terminated by -1
926 * Gets the value of one or more cells in the row referenced by @iter.
927 * The variable argument list should contain integer column numbers,
928 * each column number followed by a place to store the value being
929 * retrieved. The list is terminated by a -1. For example, to get a
930 * value from column 0 with type %G_TYPE_STRING, you would
931 * write: gtk_tree_model_set (model, iter, 0, &place_string_here, -1),
932 * where place_string_here is a gchar* to be filled with the string.
933 * If appropriate, the returned values have to be freed or unreferenced.
937 gtk_tree_model_get (GtkTreeModel *tree_model,
943 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
944 g_return_if_fail (iter != NULL);
946 va_start (var_args, iter);
947 gtk_tree_model_get_valist (tree_model, iter, var_args);
952 * gtk_tree_model_get_valist:
953 * @tree_model: a #GtkTreeModel
954 * @iter: a row in @tree_model
955 * @var_args: va_list of column/return location pairs
957 * See gtk_tree_model_get(), this version takes a va_list for language bindings
961 gtk_tree_model_get_valist (GtkTreeModel *tree_model,
967 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
968 g_return_if_fail (iter != NULL);
970 column = va_arg (var_args, gint);
974 GValue value = { 0, };
977 if (column >= gtk_tree_model_get_n_columns (tree_model))
979 g_warning ("%s: Invalid column number %d accessed (remember to end your list of columns with a -1)", G_STRLOC, column);
983 gtk_tree_model_get_value (GTK_TREE_MODEL (tree_model), iter, column, &value);
985 G_VALUE_LCOPY (&value, var_args, 0, &error);
988 g_warning ("%s: %s", G_STRLOC, error);
991 /* we purposely leak the value here, it might not be
992 * in a sane state if an error condition occoured
997 g_value_unset (&value);
999 column = va_arg (var_args, gint);
1004 gtk_tree_model_range_changed (GtkTreeModel *tree_model,
1005 GtkTreePath *start_path,
1006 GtkTreeIter *start_iter,
1007 GtkTreePath *end_path,
1008 GtkTreeIter *end_iter)
1011 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1012 g_return_if_fail (start_path != NULL);
1013 g_return_if_fail (start_iter != NULL);
1014 g_return_if_fail (end_path != NULL);
1015 g_return_if_fail (end_iter != NULL);
1017 #ifndef G_DISABLE_CHECKS
1018 g_return_if_fail (start_path->depth == end_path->depth);
1019 for (i = 0; i < start_path->depth - 1; i++)
1020 if (start_path->indices[i] != end_path->indices[i])
1022 g_warning ("Concurrent paths were not passed in to gtk_tree_model_range_changed.\n");
1026 g_signal_emit_by_name (tree_model, "range_changed",
1027 start_path, start_iter,
1028 end_path, end_iter);
1032 gtk_tree_model_inserted (GtkTreeModel *tree_model,
1036 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1037 g_return_if_fail (path != NULL);
1038 g_return_if_fail (iter != NULL);
1040 g_signal_emit_by_name (tree_model, "inserted", path, iter);
1044 gtk_tree_model_has_child_toggled (GtkTreeModel *tree_model,
1048 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1049 g_return_if_fail (path != NULL);
1050 g_return_if_fail (iter != NULL);
1052 g_signal_emit_by_name (tree_model, "has_child_toggled", path, iter);
1056 gtk_tree_model_deleted (GtkTreeModel *tree_model,
1059 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1060 g_return_if_fail (path != NULL);
1062 g_signal_emit_by_name (tree_model, "deleted", path);
1066 gtk_tree_model_reordered (GtkTreeModel *tree_model,
1071 g_return_if_fail (GTK_IS_TREE_MODEL (tree_model));
1072 g_return_if_fail (new_order != NULL);
1074 g_signal_emit_by_name (tree_model, "reordered", path, iter, new_order);
1079 gtk_tree_model_foreach_helper (GtkTreeModel *model,
1082 GtkTreeModelForeachFunc func,
1085 gtk_tree_path_append_index (path, 0);
1091 if (gtk_tree_model_iter_children (model, &child, iter))
1093 if (gtk_tree_model_foreach_helper (model, &child, path, func, user_data))
1097 if ((* func) (model, path, iter, user_data))
1100 gtk_tree_path_next (path);
1102 while (gtk_tree_model_iter_next (model, iter));
1104 gtk_tree_path_up (path);
1109 * gtk_tree_model_foreach:
1110 * @model: A #GtkTreeModel
1111 * @func: A function to be called on each row
1112 * @user_data: User data to passed to func.
1114 * Calls func on each node in model in a depth-first fashion. If func returns
1115 * %TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach returns.
1119 gtk_tree_model_foreach (GtkTreeModel *model,
1120 GtkTreeModelForeachFunc func,
1126 g_return_if_fail (GTK_IS_TREE_MODEL (model));
1127 g_return_if_fail (func != NULL);
1129 path = gtk_tree_path_new_root ();
1130 if (gtk_tree_model_get_iter (model, &iter, path) == FALSE)
1133 gtk_tree_model_foreach_helper (model, &iter, path, func, user_data);
1134 gtk_tree_path_free (path);
1139 * GtkTreeRowReference
1142 #define ROW_REF_DATA_STRING "gtk-tree-row-refs"
1144 struct _GtkTreeRowReference
1147 GtkTreeModel *model;
1158 release_row_references (gpointer data)
1160 RowRefList *refs = data;
1161 GSList *tmp_list = NULL;
1163 tmp_list = refs->list;
1164 while (tmp_list != NULL)
1166 GtkTreeRowReference *reference = tmp_list->data;
1168 if (reference->proxy == (GObject *)reference->model)
1169 reference->model = NULL;
1170 reference->proxy = NULL;
1172 /* we don't free the reference, users are responsible for that. */
1174 tmp_list = g_slist_next (tmp_list);
1177 g_slist_free (refs->list);
1182 gtk_tree_row_ref_inserted_callback (GObject *object,
1187 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1194 /* This function corrects the path stored in the reference to
1195 * account for an insertion. Note that it's called _after_ the insertion
1196 * with the path to the newly-inserted row. Which means that
1197 * the inserted path is in a different "coordinate system" than
1198 * the old path (e.g. if the inserted path was just before the old path,
1199 * then inserted path and old path will be the same, and old path must be
1203 tmp_list = refs->list;
1205 while (tmp_list != NULL)
1207 GtkTreeRowReference *reference = tmp_list->data;
1209 if (reference->path)
1211 gint depth = gtk_tree_path_get_depth (path);
1212 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1214 if (ref_depth >= depth)
1216 gint *indices = gtk_tree_path_get_indices (path);
1217 gint *ref_indices = gtk_tree_path_get_indices (reference->path);
1220 /* This is the depth that might affect us. */
1223 if (indices[i] <= ref_indices[i])
1224 ref_indices[i] += 1;
1228 tmp_list = g_slist_next (tmp_list);
1233 gtk_tree_row_ref_deleted_callback (GObject *object,
1237 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1243 /* This function corrects the path stored in the reference to
1244 * account for an deletion. Note that it's called _after_ the
1245 * deletion with the old path of the just-deleted row. Which means
1246 * that the deleted path is the same now-defunct "coordinate system"
1247 * as the path saved in the reference, which is what we want to fix.
1249 * Note that this is different from the situation in "inserted," so
1250 * while you might think you can cut-and-paste between these
1251 * functions, it's not going to work. ;-)
1254 tmp_list = refs->list;
1256 while (tmp_list != NULL)
1258 GtkTreeRowReference *reference = tmp_list->data;
1260 if (reference->path)
1262 gint depth = gtk_tree_path_get_depth (path);
1263 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1265 if (ref_depth >= depth)
1267 /* Need to adjust path upward */
1268 gint *indices = gtk_tree_path_get_indices (path);
1269 gint *ref_indices = gtk_tree_path_get_indices (reference->path);
1273 if (indices[i] < ref_indices[i])
1274 ref_indices[i] -= 1;
1275 else if (indices[i] == ref_indices[i])
1277 /* the referenced node itself, or its parent, was
1278 * deleted, mark invalid
1281 gtk_tree_path_free (reference->path);
1282 reference->path = NULL;
1287 tmp_list = g_slist_next (tmp_list);
1292 gtk_tree_row_ref_reordered_callback (GObject *object,
1298 RowRefList *refs = g_object_get_data (data, ROW_REF_DATA_STRING);
1305 tmp_list = refs->list;
1307 while (tmp_list != NULL)
1309 GtkTreeRowReference *reference = tmp_list->data;
1311 length = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (reference->model), iter);
1316 if ((reference->path) &&
1317 (gtk_tree_path_is_ancestor (path, reference->path)))
1319 gint ref_depth = gtk_tree_path_get_depth (reference->path);
1320 gint depth = gtk_tree_path_get_depth (path);
1322 if (ref_depth > depth)
1325 gint *indices = gtk_tree_path_get_indices (reference->path);
1327 for (i = 0; i < length; i++)
1329 if (new_order[i] == indices[depth])
1338 tmp_list = g_slist_next (tmp_list);
1344 connect_ref_callbacks (GtkTreeModel *model)
1346 g_signal_connect (G_OBJECT (model),
1348 (GCallback) gtk_tree_row_ref_inserted_callback,
1350 g_signal_connect (G_OBJECT (model),
1352 (GCallback) gtk_tree_row_ref_deleted_callback,
1354 g_signal_connect (G_OBJECT (model),
1356 (GCallback) gtk_tree_row_ref_reordered_callback,
1361 disconnect_ref_callbacks (GtkTreeModel *model)
1363 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1364 G_SIGNAL_MATCH_FUNC,
1366 gtk_tree_row_ref_inserted_callback,
1368 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1369 G_SIGNAL_MATCH_FUNC,
1371 gtk_tree_row_ref_deleted_callback,
1373 g_signal_handlers_disconnect_matched (G_OBJECT (model),
1374 G_SIGNAL_MATCH_FUNC,
1376 gtk_tree_row_ref_reordered_callback,
1380 GtkTreeRowReference *
1381 gtk_tree_row_reference_new (GtkTreeModel *model,
1384 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1385 g_return_val_if_fail (path != NULL, NULL);
1387 return gtk_tree_row_reference_new_proxy (G_OBJECT (model), model, path);
1390 GtkTreeRowReference *
1391 gtk_tree_row_reference_new_proxy (GObject *proxy,
1392 GtkTreeModel *model,
1395 GtkTreeRowReference *reference;
1398 g_return_val_if_fail (G_IS_OBJECT (proxy), NULL);
1399 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
1400 g_return_val_if_fail (path != NULL, NULL);
1402 reference = g_new (GtkTreeRowReference, 1);
1404 g_object_ref (proxy);
1405 g_object_ref (model);
1406 reference->proxy = proxy;
1407 reference->model = model;
1408 reference->path = gtk_tree_path_copy (path);
1410 refs = g_object_get_data (G_OBJECT (proxy), ROW_REF_DATA_STRING);
1414 refs = g_new (RowRefList, 1);
1417 if (G_OBJECT (model) == proxy)
1418 connect_ref_callbacks (model);
1420 g_object_set_data_full (G_OBJECT (proxy),
1421 ROW_REF_DATA_STRING,
1422 refs, release_row_references);
1425 refs->list = g_slist_prepend (refs->list, reference);
1431 * gtk_tree_row_reference_get_path:
1432 * @reference: A #GtkTreeRowReference
1434 * Returns a path that the row reference currently points to, or NULL if the
1435 * path pointed to is no longer valid.
1437 * Return value: A current path, or NULL.
1440 gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
1442 g_return_val_if_fail (reference != NULL, NULL);
1444 if (reference->proxy == NULL)
1447 if (reference->path == NULL)
1450 return gtk_tree_path_copy (reference->path);
1454 * gtk_tree_row_reference_valid:
1455 * @reference: A #GtkTreeRowReference, or NULL
1457 * Returns TRUE if the %reference is non-NULL and refers to a current valid
1460 * Return value: TRUE if %reference points to a valid path.
1463 gtk_tree_row_reference_valid (GtkTreeRowReference *reference)
1465 if (reference == NULL || reference->path == NULL)
1472 * gtk_tree_row_reference_free:
1473 * @reference: A #GtkTreeRowReference, or NULL
1475 * Free's %reference. %reference may be NULL.
1478 gtk_tree_row_reference_free (GtkTreeRowReference *reference)
1482 if (reference == NULL)
1485 refs = g_object_get_data (G_OBJECT (reference->proxy), ROW_REF_DATA_STRING);
1489 g_warning (G_STRLOC": bad row reference, proxy has no outstanding row references");
1493 refs->list = g_slist_remove (refs->list, reference);
1495 if (refs->list == NULL)
1497 disconnect_ref_callbacks (reference->model);
1498 g_object_set_data (G_OBJECT (reference->proxy),
1499 ROW_REF_DATA_STRING,
1502 g_object_unref (reference->proxy);
1503 g_object_unref (reference->model);
1505 if (reference->path)
1506 gtk_tree_path_free (reference->path);
1512 gtk_tree_row_reference_inserted (GObject *proxy,
1515 g_return_if_fail (G_IS_OBJECT (proxy));
1517 gtk_tree_row_ref_inserted_callback (NULL, path, NULL, proxy);
1522 gtk_tree_row_reference_deleted (GObject *proxy,
1525 g_return_if_fail (G_IS_OBJECT (proxy));
1527 gtk_tree_row_ref_deleted_callback (NULL, path, proxy);
1531 gtk_tree_row_reference_reordered (GObject *proxy,
1536 g_return_if_fail (G_IS_OBJECT (proxy));
1538 gtk_tree_row_ref_reordered_callback (NULL, path, iter, new_order, proxy);