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.
20 #include "gtktreemodel.h"
21 #include "gtktreestore.h"
22 #include "gtktreedatalist.h"
23 #include "gtktreednd.h"
25 #include <gobject/gvaluecollector.h>
27 #define G_NODE(node) ((GNode *)node)
28 #define GTK_TREE_STORE_IS_SORTED(tree) (GTK_TREE_STORE (tree)->sort_column_id != -2)
29 #define VALID_ITER(iter, tree_store) (iter!= NULL && iter->user_data != NULL && tree_store->stamp == iter->stamp)
31 static void gtk_tree_store_init (GtkTreeStore *tree_store);
32 static void gtk_tree_store_class_init (GtkTreeStoreClass *tree_store_class);
33 static void gtk_tree_store_tree_model_init (GtkTreeModelIface *iface);
34 static void gtk_tree_store_drag_source_init(GtkTreeDragSourceIface *iface);
35 static void gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface);
36 static void gtk_tree_store_sortable_init (GtkTreeSortableIface *iface);
37 static void gtk_tree_store_finalize (GObject *object);
38 static GtkTreeModelFlags gtk_tree_store_get_flags (GtkTreeModel *tree_model);
39 static gint gtk_tree_store_get_n_columns (GtkTreeModel *tree_model);
40 static GType gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
42 static gboolean gtk_tree_store_get_iter (GtkTreeModel *tree_model,
45 static GtkTreePath *gtk_tree_store_get_path (GtkTreeModel *tree_model,
47 static void gtk_tree_store_get_value (GtkTreeModel *tree_model,
51 static gboolean gtk_tree_store_iter_next (GtkTreeModel *tree_model,
53 static gboolean gtk_tree_store_iter_children (GtkTreeModel *tree_model,
56 static gboolean gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
58 static gint gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
60 static gboolean gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
64 static gboolean gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
69 static void gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
71 static void gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
77 static gboolean gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
79 static gboolean gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
81 GtkSelectionData *selection_data);
82 static gboolean gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
84 GtkSelectionData *selection_data);
85 static gboolean gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
86 GtkTreePath *dest_path,
87 GtkSelectionData *selection_data);
89 /* Sortable Interfaces */
91 static void gtk_tree_store_sort (GtkTreeStore *tree_store);
92 static void gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
95 static gboolean gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
98 static void gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
101 static void gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
103 GtkTreeIterCompareFunc func,
105 GtkDestroyNotify destroy);
106 static void gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
107 GtkTreeIterCompareFunc func,
109 GtkDestroyNotify destroy);
110 static gboolean gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable);
112 static void validate_gnode (GNode *node);
115 static GObjectClass *parent_class = NULL;
119 validate_tree (GtkTreeStore *tree_store)
121 if (gtk_debug_flags & GTK_DEBUG_TREE)
123 g_assert (G_NODE (tree_store->root)->parent == NULL);
125 validate_gnode (G_NODE (tree_store->root));
130 gtk_tree_store_get_type (void)
132 static GType tree_store_type = 0;
134 if (!tree_store_type)
136 static const GTypeInfo tree_store_info =
138 sizeof (GtkTreeStoreClass),
139 NULL, /* base_init */
140 NULL, /* base_finalize */
141 (GClassInitFunc) gtk_tree_store_class_init,
142 NULL, /* class_finalize */
143 NULL, /* class_data */
144 sizeof (GtkTreeStore),
146 (GInstanceInitFunc) gtk_tree_store_init
149 static const GInterfaceInfo tree_model_info =
151 (GInterfaceInitFunc) gtk_tree_store_tree_model_init,
156 static const GInterfaceInfo drag_source_info =
158 (GInterfaceInitFunc) gtk_tree_store_drag_source_init,
163 static const GInterfaceInfo drag_dest_info =
165 (GInterfaceInitFunc) gtk_tree_store_drag_dest_init,
170 static const GInterfaceInfo sortable_info =
172 (GInterfaceInitFunc) gtk_tree_store_sortable_init,
177 tree_store_type = g_type_register_static (G_TYPE_OBJECT, "GtkTreeStore", &tree_store_info, 0);
179 g_type_add_interface_static (tree_store_type,
182 g_type_add_interface_static (tree_store_type,
183 GTK_TYPE_TREE_DRAG_SOURCE,
185 g_type_add_interface_static (tree_store_type,
186 GTK_TYPE_TREE_DRAG_DEST,
188 g_type_add_interface_static (tree_store_type,
189 GTK_TYPE_TREE_SORTABLE,
194 return tree_store_type;
198 gtk_tree_store_class_init (GtkTreeStoreClass *class)
200 GObjectClass *object_class;
202 parent_class = g_type_class_peek_parent (class);
203 object_class = (GObjectClass *) class;
205 object_class->finalize = gtk_tree_store_finalize;
209 gtk_tree_store_tree_model_init (GtkTreeModelIface *iface)
211 iface->get_flags = gtk_tree_store_get_flags;
212 iface->get_n_columns = gtk_tree_store_get_n_columns;
213 iface->get_column_type = gtk_tree_store_get_column_type;
214 iface->get_iter = gtk_tree_store_get_iter;
215 iface->get_path = gtk_tree_store_get_path;
216 iface->get_value = gtk_tree_store_get_value;
217 iface->iter_next = gtk_tree_store_iter_next;
218 iface->iter_children = gtk_tree_store_iter_children;
219 iface->iter_has_child = gtk_tree_store_iter_has_child;
220 iface->iter_n_children = gtk_tree_store_iter_n_children;
221 iface->iter_nth_child = gtk_tree_store_iter_nth_child;
222 iface->iter_parent = gtk_tree_store_iter_parent;
226 gtk_tree_store_drag_source_init (GtkTreeDragSourceIface *iface)
228 iface->drag_data_delete = gtk_tree_store_drag_data_delete;
229 iface->drag_data_get = gtk_tree_store_drag_data_get;
233 gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface)
235 iface->drag_data_received = gtk_tree_store_drag_data_received;
236 iface->row_drop_possible = gtk_tree_store_row_drop_possible;
240 gtk_tree_store_sortable_init (GtkTreeSortableIface *iface)
242 iface->get_sort_column_id = gtk_tree_store_get_sort_column_id;
243 iface->set_sort_column_id = gtk_tree_store_set_sort_column_id;
244 iface->set_sort_func = gtk_tree_store_set_sort_func;
245 iface->set_default_sort_func = gtk_tree_store_set_default_sort_func;
246 iface->has_default_sort_func = gtk_tree_store_has_default_sort_func;
250 gtk_tree_store_init (GtkTreeStore *tree_store)
252 tree_store->root = g_node_new (NULL);
253 /* While the odds are against us getting 0...
257 tree_store->stamp = g_random_int ();
259 while (tree_store->stamp == 0);
261 tree_store->sort_list = NULL;
262 tree_store->sort_column_id = -2;
263 tree_store->columns_dirty = FALSE;
267 * gtk_tree_store_new:
268 * @n_columns: number of columns in the tree store
269 * @Varargs: all #GType types for the columns, from first to last
271 * Creates a new tree store as with @n_columns columns each of the types passed
272 * in. As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
273 * GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
274 * <type>int</type>, <type>string</type> and #GdkPixbuf respectively.
276 * Return value: a new #GtkTreeStore
279 gtk_tree_store_new (gint n_columns,
282 GtkTreeStore *retval;
286 g_return_val_if_fail (n_columns > 0, NULL);
288 retval = GTK_TREE_STORE (g_object_new (GTK_TYPE_TREE_STORE, NULL));
289 gtk_tree_store_set_n_columns (retval, n_columns);
291 va_start (args, n_columns);
293 for (i = 0; i < n_columns; i++)
295 GType type = va_arg (args, GType);
296 if (! _gtk_tree_data_list_check_type (type))
298 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (type));
299 g_object_unref (G_OBJECT (retval));
302 gtk_tree_store_set_column_type (retval, i, type);
309 * gtk_tree_store_newv:
310 * @n_columns: number of columns in the tree store
311 * @types: an array of #GType types for the columns, from first to last
313 * Non vararg creation function. Used primarily by language bindings.
315 * Return value: a new #GtkTreeStore
318 gtk_tree_store_newv (gint n_columns,
321 GtkTreeStore *retval;
324 g_return_val_if_fail (n_columns > 0, NULL);
326 retval = GTK_TREE_STORE (g_object_new (GTK_TYPE_TREE_STORE, NULL));
327 gtk_tree_store_set_n_columns (retval, n_columns);
329 for (i = 0; i < n_columns; i++)
331 if (! _gtk_tree_data_list_check_type (types[i]))
333 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (types[i]));
334 g_object_unref (G_OBJECT (retval));
337 gtk_tree_store_set_column_type (retval, i, types[i]);
345 * gtk_tree_store_set_column_types:
346 * @tree_store: A #GtkTreeStore
347 * @n_columns: Number of columns for the tree store
348 * @types: An array of #GType types, one for each column
350 * This function is meant primarily for #GObjects that inherit from
351 * #GtkTreeStore, and should only be used when constructing a new
352 * #GtkTreeStore. It will not function after a row has been added,
353 * or a method on the #GtkTreeModel interface is called.
356 gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
362 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
363 g_return_if_fail (tree_store->columns_dirty == 0);
365 gtk_tree_store_set_n_columns (tree_store, n_columns);
366 for (i = 0; i < n_columns; i++)
368 if (! _gtk_tree_data_list_check_type (types[i]))
370 g_warning ("%s: Invalid type %s passed to gtk_tree_store_set_column_types\n", G_STRLOC, g_type_name (types[i]));
373 gtk_tree_store_set_column_type (tree_store, i, types[i]);
378 gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
383 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
385 if (tree_store->n_columns == n_columns)
388 new_columns = g_new0 (GType, n_columns);
389 if (tree_store->column_headers)
391 /* copy the old header orders over */
392 if (n_columns >= tree_store->n_columns)
393 memcpy (new_columns, tree_store->column_headers, tree_store->n_columns * sizeof (gchar *));
395 memcpy (new_columns, tree_store->column_headers, n_columns * sizeof (GType));
397 g_free (tree_store->column_headers);
400 if (tree_store->sort_list)
401 _gtk_tree_data_list_header_free (tree_store->sort_list);
403 tree_store->sort_list = _gtk_tree_data_list_header_new (n_columns, tree_store->column_headers);
405 tree_store->column_headers = new_columns;
406 tree_store->n_columns = n_columns;
410 * gtk_tree_store_set_column_type:
411 * @tree_store: a #GtkTreeStore
412 * @column: column number
413 * @type: type of the data to be stored in @column
415 * Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
416 * %G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
417 * %G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
418 * subclasses of those types such as %GDK_TYPE_PIXBUF.
422 gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
426 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
427 g_return_if_fail (column >=0 && column < tree_store->n_columns);
428 if (!_gtk_tree_data_list_check_type (type))
430 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (type));
433 tree_store->column_headers[column] = type;
437 node_free (GNode *node, gpointer data)
439 _gtk_tree_data_list_free (node->data, (GType*)data);
443 gtk_tree_store_finalize (GObject *object)
445 GtkTreeStore *tree_store = GTK_TREE_STORE (object);
447 g_node_children_foreach (tree_store->root, G_TRAVERSE_ALL, node_free, tree_store->column_headers);
448 _gtk_tree_data_list_header_free (tree_store->sort_list);
449 g_free (tree_store->column_headers);
451 if (tree_store->default_sort_destroy)
453 GtkDestroyNotify d = tree_store->default_sort_destroy;
455 tree_store->default_sort_destroy = NULL;
456 d (tree_store->default_sort_data);
457 tree_store->default_sort_data = NULL;
460 (* parent_class->finalize) (object);
463 /* fulfill the GtkTreeModel requirements */
464 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node. However,
465 * it is not visible to the tree or to the user., and the path "0" refers to the
466 * first child of GtkTreeStore::root.
470 static GtkTreeModelFlags
471 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
473 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
475 return GTK_TREE_MODEL_ITERS_PERSIST;
479 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
481 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
483 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
485 tree_store->columns_dirty = TRUE;
487 return tree_store->n_columns;
491 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
494 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
496 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), G_TYPE_INVALID);
497 g_return_val_if_fail (index < GTK_TREE_STORE (tree_model)->n_columns &&
498 index >= 0, G_TYPE_INVALID);
500 tree_store->columns_dirty = TRUE;
502 return tree_store->column_headers[index];
506 gtk_tree_store_get_iter (GtkTreeModel *tree_model,
510 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
515 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
517 tree_store->columns_dirty = TRUE;
519 indices = gtk_tree_path_get_indices (path);
520 depth = gtk_tree_path_get_depth (path);
522 g_return_val_if_fail (depth > 0, FALSE);
524 parent.stamp = tree_store->stamp;
525 parent.user_data = tree_store->root;
527 if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[0]))
530 for (i = 1; i < depth; i++)
533 if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[i]))
541 gtk_tree_store_get_path (GtkTreeModel *tree_model,
548 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), NULL);
549 g_return_val_if_fail (iter != NULL, NULL);
550 g_return_val_if_fail (iter->user_data != NULL, NULL);
551 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, NULL);
553 validate_tree ((GtkTreeStore*)tree_model);
555 if (G_NODE (iter->user_data)->parent == NULL &&
556 G_NODE (iter->user_data) == GTK_TREE_STORE (tree_model)->root)
557 return gtk_tree_path_new ();
558 g_assert (G_NODE (iter->user_data)->parent != NULL);
560 if (G_NODE (iter->user_data)->parent == G_NODE (GTK_TREE_STORE (tree_model)->root))
562 retval = gtk_tree_path_new ();
563 tmp_node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
567 GtkTreeIter tmp_iter = *iter;
569 tmp_iter.user_data = G_NODE (iter->user_data)->parent;
571 retval = gtk_tree_store_get_path (tree_model,
573 tmp_node = G_NODE (iter->user_data)->parent->children;
579 if (tmp_node == NULL)
581 gtk_tree_path_free (retval);
585 for (; tmp_node; tmp_node = tmp_node->next)
587 if (tmp_node == G_NODE (iter->user_data))
592 if (tmp_node == NULL)
594 /* We couldn't find node, meaning it's prolly not ours */
595 /* Perhaps I should do a g_return_if_fail here. */
596 gtk_tree_path_free (retval);
600 gtk_tree_path_append_index (retval, i);
607 gtk_tree_store_get_value (GtkTreeModel *tree_model,
612 GtkTreeDataList *list;
613 gint tmp_column = column;
615 g_return_if_fail (GTK_IS_TREE_STORE (tree_model));
616 g_return_if_fail (iter != NULL);
617 g_return_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp);
618 g_return_if_fail (column < GTK_TREE_STORE (tree_model)->n_columns);
620 list = G_NODE (iter->user_data)->data;
622 while (tmp_column-- > 0 && list)
627 _gtk_tree_data_list_node_to_value (list,
628 GTK_TREE_STORE (tree_model)->column_headers[column],
633 /* We want to return an initialized but empty (default) value */
634 g_value_init (value, GTK_TREE_STORE (tree_model)->column_headers[column]);
639 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
642 g_return_val_if_fail (iter != NULL, FALSE);
643 g_return_val_if_fail (iter->user_data != NULL, FALSE);
644 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
646 if (G_NODE (iter->user_data)->next)
648 iter->user_data = G_NODE (iter->user_data)->next;
656 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
662 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
663 g_return_val_if_fail (parent == NULL || parent->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
666 children = G_NODE (parent->user_data)->children;
668 children = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
672 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
673 iter->user_data = children;
681 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
684 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
685 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
686 g_return_val_if_fail (iter->user_data != NULL, FALSE);
688 return G_NODE (iter->user_data)->children != NULL;
692 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
698 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
699 g_return_val_if_fail (iter == NULL || iter->user_data != NULL, FALSE);
702 node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
704 node = G_NODE (iter->user_data)->children;
716 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
724 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
725 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
728 parent_node = GTK_TREE_STORE (tree_model)->root;
730 parent_node = parent->user_data;
732 child = g_node_nth_child (parent_node, n);
736 iter->user_data = child;
737 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
745 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
751 g_return_val_if_fail (iter != NULL, FALSE);
752 g_return_val_if_fail (child != NULL, FALSE);
753 g_return_val_if_fail (child->user_data != NULL, FALSE);
754 g_return_val_if_fail (child->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
756 parent = G_NODE (child->user_data)->parent;
758 g_assert (parent != NULL);
760 if (parent != GTK_TREE_STORE (tree_model)->root)
762 iter->user_data = parent;
763 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
771 /* Does not emit a signal */
773 gtk_tree_store_real_set_value (GtkTreeStore *tree_store,
779 GtkTreeDataList *list;
780 GtkTreeDataList *prev;
781 gint old_column = column;
782 GValue real_value = {0, };
783 gboolean converted = FALSE;
784 gboolean retval = FALSE;
786 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
787 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
788 g_return_val_if_fail (column >= 0 && column < tree_store->n_columns, FALSE);
789 g_return_val_if_fail (G_IS_VALUE (value), FALSE);
791 if (! g_type_is_a (G_VALUE_TYPE (value), tree_store->column_headers[column]))
793 if (! (g_value_type_compatible (G_VALUE_TYPE (value), tree_store->column_headers[column]) &&
794 g_value_type_compatible (tree_store->column_headers[column], G_VALUE_TYPE (value))))
796 g_warning ("%s: Unable to convert from %s to %s\n",
798 g_type_name (G_VALUE_TYPE (value)),
799 g_type_name (tree_store->column_headers[column]));
802 if (!g_value_transform (value, &real_value))
804 g_warning ("%s: Unable to make conversion from %s to %s\n",
806 g_type_name (G_VALUE_TYPE (value)),
807 g_type_name (tree_store->column_headers[column]));
808 g_value_unset (&real_value);
814 prev = list = G_NODE (iter->user_data)->data;
821 _gtk_tree_data_list_value_to_node (list, &real_value);
823 _gtk_tree_data_list_value_to_node (list, value);
826 g_value_unset (&real_value);
835 if (G_NODE (iter->user_data)->data == NULL)
837 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
842 list = prev->next = _gtk_tree_data_list_alloc ();
848 list->next = _gtk_tree_data_list_alloc ();
855 _gtk_tree_data_list_value_to_node (list, &real_value);
857 _gtk_tree_data_list_value_to_node (list, value);
861 g_value_unset (&real_value);
863 if (sort && GTK_TREE_STORE_IS_SORTED (tree_store))
864 gtk_tree_store_sort_iter_changed (tree_store, iter, old_column);
870 * gtk_tree_store_set_value:
871 * @tree_store: a #GtkTreeStore
872 * @iter: A valid #GtkTreeIter for the row being modified
873 * @column: column number to modify
874 * @value: new value for the cell
876 * Sets the data in the cell specified by @iter and @column.
877 * The type of @value must be convertible to the type of the
882 gtk_tree_store_set_value (GtkTreeStore *tree_store,
887 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
888 g_return_if_fail (VALID_ITER (iter, tree_store));
889 g_return_if_fail (column >= 0 && column < tree_store->n_columns);
890 g_return_if_fail (G_IS_VALUE (value));
892 if (gtk_tree_store_real_set_value (tree_store, iter, column, value, TRUE))
896 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
897 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
898 gtk_tree_path_free (path);
903 * gtk_tree_store_set_valist:
904 * @tree_store: A #GtkTreeStore
905 * @iter: A valid #GtkTreeIter for the row being modified
906 * @var_args: <type>va_list</type> of column/value pairs
908 * See gtk_tree_store_set(); this version takes a <type>va_list</type> for
909 * use by language bindings.
913 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
918 gboolean emit_signal = FALSE;
919 gboolean maybe_need_sort = FALSE;
920 GtkTreeIterCompareFunc func = NULL;
922 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
923 g_return_if_fail (VALID_ITER (iter, tree_store));
925 column = va_arg (var_args, gint);
927 if (GTK_TREE_STORE_IS_SORTED (tree_store))
929 if (tree_store->sort_column_id != -1)
931 GtkTreeDataSortHeader *header;
932 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
933 tree_store->sort_column_id);
934 g_return_if_fail (header != NULL);
935 g_return_if_fail (header->func != NULL);
940 func = tree_store->default_sort_func;
944 if (func != gtk_tree_data_list_compare_func)
945 maybe_need_sort = TRUE;
949 GValue value = { 0, };
952 if (column >= tree_store->n_columns)
954 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
957 g_value_init (&value, tree_store->column_headers[column]);
959 G_VALUE_COLLECT (&value, var_args, 0, &error);
962 g_warning ("%s: %s", G_STRLOC, error);
965 /* we purposely leak the value here, it might not be
966 * in a sane state if an error condition occoured
971 emit_signal = gtk_tree_store_real_set_value (tree_store,
975 FALSE) || emit_signal;
977 if (func == gtk_tree_data_list_compare_func &&
978 column == tree_store->sort_column_id)
979 maybe_need_sort = TRUE;
981 g_value_unset (&value);
983 column = va_arg (var_args, gint);
986 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
987 gtk_tree_store_sort_iter_changed (tree_store, iter, tree_store->sort_column_id);
993 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
994 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
995 gtk_tree_path_free (path);
1000 * gtk_tree_store_set:
1001 * @tree_store: A #GtkTreeStore
1002 * @iter: A valid #GtkTreeIter for the row being modified
1003 * @Varargs: pairs of column number and value, terminated with -1
1005 * Sets the value of one or more cells in the row referenced by @iter.
1006 * The variable argument list should contain integer column numbers,
1007 * each column number followed by the value to be set.
1008 * The list is terminated by a -1. For example, to set column 0 with type
1009 * %G_TYPE_STRING to "Foo", you would write
1010 * <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
1013 gtk_tree_store_set (GtkTreeStore *tree_store,
1019 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1020 g_return_if_fail (VALID_ITER (iter, tree_store));
1022 va_start (var_args, iter);
1023 gtk_tree_store_set_valist (tree_store, iter, var_args);
1028 * gtk_tree_store_remove:
1029 * @tree_store: A #GtkTreeStore
1030 * @iter: A valid #GtkTreeIter
1032 * Removes @iter from @tree_store. After being removed, @iter is set to the
1033 * next valid row at that level, or invalidated if it previously pointed to the
1036 * Return value: %TRUE if @iter is still valid, %FALSE if not.
1039 gtk_tree_store_remove (GtkTreeStore *tree_store,
1043 GtkTreeIter new_iter = {0,};
1047 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1048 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1050 parent = G_NODE (iter->user_data)->parent;
1052 g_assert (parent != NULL);
1053 next_node = G_NODE (iter->user_data)->next;
1055 if (G_NODE (iter->user_data)->data)
1056 _gtk_tree_data_list_free ((GtkTreeDataList *) G_NODE (iter->user_data)->data,
1057 tree_store->column_headers);
1059 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1060 g_node_destroy (G_NODE (iter->user_data));
1062 gtk_tree_model_row_deleted (GTK_TREE_MODEL (tree_store), path);
1064 if (parent != G_NODE (tree_store->root))
1067 if (parent->children == NULL)
1069 gtk_tree_path_up (path);
1071 new_iter.stamp = tree_store->stamp;
1072 new_iter.user_data = parent;
1073 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &new_iter);
1076 gtk_tree_path_free (path);
1078 /* revalidate iter */
1079 if (next_node != NULL)
1081 iter->stamp = tree_store->stamp;
1082 iter->user_data = next_node;
1088 iter->user_data = NULL;
1095 * gtk_tree_store_insert:
1096 * @tree_store: A #GtkTreeStore
1097 * @iter: An unset #GtkTreeIter to set to the new row
1098 * @parent: A valid #GtkTreeIter, or %NULL
1099 * @position: position to insert the new row
1101 * Creates a new row at @position. If parent is non-%NULL, then the row will be
1102 * made a child of @parent. Otherwise, the row will be created at the toplevel.
1103 * If @position is larger than the number of rows at that level, then the new
1104 * row will be inserted to the end of the list. @iter will be changed to point
1105 * to this new row. The row will be empty after this function is called. To
1106 * fill in values, you need to call gtk_tree_store_set() or
1107 * gtk_tree_store_set_value().
1111 gtk_tree_store_insert (GtkTreeStore *tree_store,
1113 GtkTreeIter *parent,
1119 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1121 g_return_if_fail (VALID_ITER (parent, tree_store));
1124 parent_node = parent->user_data;
1126 parent_node = tree_store->root;
1128 tree_store->columns_dirty = TRUE;
1130 iter->stamp = tree_store->stamp;
1131 iter->user_data = g_node_new (NULL);
1132 g_node_insert (parent_node, position, G_NODE (iter->user_data));
1134 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1135 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1137 gtk_tree_path_free (path);
1139 validate_tree ((GtkTreeStore*)tree_store);
1143 * gtk_tree_store_insert_before:
1144 * @tree_store: A #GtkTreeStore
1145 * @iter: An unset #GtkTreeIter to set to the new row
1146 * @parent: A valid #GtkTreeIter, or %NULL
1147 * @sibling: A valid #GtkTreeIter, or %NULL
1149 * Inserts a new row before @sibling. If @sibling is %NULL, then the row will
1150 * be appended to @parent 's children. If @parent and @sibling are %NULL, then
1151 * the row will be appended to the toplevel. If both @sibling and @parent are
1152 * set, then @parent must be the parent of @sibling. When @sibling is set,
1153 * @parent is optional.
1155 * @iter will be changed to point to this new row. The row will be empty after
1156 * this function is called. To fill in values, you need to call
1157 * gtk_tree_store_set() or gtk_tree_store_set_value().
1161 gtk_tree_store_insert_before (GtkTreeStore *tree_store,
1163 GtkTreeIter *parent,
1164 GtkTreeIter *sibling)
1167 GNode *parent_node = NULL;
1170 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1171 g_return_if_fail (iter != NULL);
1173 g_return_if_fail (VALID_ITER (parent, tree_store));
1174 if (sibling != NULL)
1175 g_return_if_fail (VALID_ITER (sibling, tree_store));
1177 tree_store->columns_dirty = TRUE;
1179 new_node = g_node_new (NULL);
1181 if (parent == NULL && sibling == NULL)
1182 parent_node = tree_store->root;
1183 else if (parent == NULL)
1184 parent_node = G_NODE (sibling->user_data)->parent;
1185 else if (sibling == NULL)
1186 parent_node = G_NODE (parent->user_data);
1189 g_return_if_fail (G_NODE (sibling->user_data)->parent == G_NODE (parent->user_data));
1190 parent_node = G_NODE (parent->user_data);
1193 g_node_insert_before (parent_node,
1194 sibling ? G_NODE (sibling->user_data) : NULL,
1197 iter->stamp = tree_store->stamp;
1198 iter->user_data = new_node;
1200 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1201 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1203 gtk_tree_path_free (path);
1205 validate_tree ((GtkTreeStore*)tree_store);
1209 * gtk_tree_store_insert_after:
1210 * @tree_store: A #GtkTreeStore
1211 * @iter: An unset #GtkTreeIter to set to the new row
1212 * @parent: A valid #GtkTreeIter, or %NULL
1213 * @sibling: A valid #GtkTreeIter, or %NULL
1215 * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
1216 * prepended to the beginning of the @parent 's children. If @parent and
1217 * @sibling are %NULL, then the row will be prepended to the toplevel. If both
1218 * @sibling and @parent are set, then @parent must be the parent of @sibling.
1219 * When @sibling is set, @parent is optional.
1221 * @iter will be changed to point to this new row. The row will be empty after
1222 * this function is called. To fill in values, you need to call
1223 * gtk_tree_store_set() or gtk_tree_store_set_value().
1227 gtk_tree_store_insert_after (GtkTreeStore *tree_store,
1229 GtkTreeIter *parent,
1230 GtkTreeIter *sibling)
1236 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1237 g_return_if_fail (iter != NULL);
1239 g_return_if_fail (VALID_ITER (parent, tree_store));
1240 if (sibling != NULL)
1241 g_return_if_fail (VALID_ITER (sibling, tree_store));
1243 tree_store->columns_dirty = TRUE;
1245 new_node = g_node_new (NULL);
1247 if (parent == NULL && sibling == NULL)
1248 parent_node = tree_store->root;
1249 else if (parent == NULL)
1250 parent_node = G_NODE (sibling->user_data)->parent;
1251 else if (sibling == NULL)
1252 parent_node = G_NODE (parent->user_data);
1255 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
1256 G_NODE (parent->user_data));
1257 parent_node = G_NODE (parent->user_data);
1261 g_node_insert_after (parent_node,
1262 sibling ? G_NODE (sibling->user_data) : NULL,
1265 iter->stamp = tree_store->stamp;
1266 iter->user_data = new_node;
1268 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1269 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1271 gtk_tree_path_free (path);
1273 validate_tree ((GtkTreeStore*)tree_store);
1277 * gtk_tree_store_prepend:
1278 * @tree_store: A #GtkTreeStore
1279 * @iter: An unset #GtkTreeIter to set to the prepended row
1280 * @parent: A valid #GtkTreeIter, or %NULL
1282 * Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
1283 * the new row before the first child of @parent, otherwise it will prepend a row
1284 * to the top level. @iter will be changed to point to this new row. The row
1285 * will be empty after this function is called. To fill in values, you need to
1286 * call gtk_tree_store_set() or gtk_tree_store_set_value().
1289 gtk_tree_store_prepend (GtkTreeStore *tree_store,
1291 GtkTreeIter *parent)
1295 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1296 g_return_if_fail (iter != NULL);
1298 g_return_if_fail (VALID_ITER (parent, tree_store));
1300 tree_store->columns_dirty = TRUE;
1303 parent_node = tree_store->root;
1305 parent_node = parent->user_data;
1307 if (parent_node->children == NULL)
1311 iter->stamp = tree_store->stamp;
1312 iter->user_data = g_node_new (NULL);
1314 g_node_prepend (parent_node, G_NODE (iter->user_data));
1316 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1317 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1319 if (parent_node != tree_store->root)
1321 gtk_tree_path_up (path);
1322 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1324 gtk_tree_path_free (path);
1328 gtk_tree_store_insert_after (tree_store, iter, parent, NULL);
1331 validate_tree ((GtkTreeStore*)tree_store);
1335 * gtk_tree_store_append:
1336 * @tree_store: A #GtkTreeStore
1337 * @iter: An unset #GtkTreeIter to set to the appended row
1338 * @parent: A valid #GtkTreeIter, or %NULL
1340 * Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
1341 * new row after the last child of @parent, otherwise it will append a row to
1342 * the top level. @iter will be changed to point to this new row. The row will
1343 * be empty after this function is called. To fill in values, you need to call
1344 * gtk_tree_store_set() or gtk_tree_store_set_value().
1347 gtk_tree_store_append (GtkTreeStore *tree_store,
1349 GtkTreeIter *parent)
1353 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1354 g_return_if_fail (iter != NULL);
1357 g_return_if_fail (VALID_ITER (parent, tree_store));
1360 parent_node = tree_store->root;
1362 parent_node = parent->user_data;
1364 tree_store->columns_dirty = TRUE;
1366 if (parent_node->children == NULL)
1370 iter->stamp = tree_store->stamp;
1371 iter->user_data = g_node_new (NULL);
1373 g_node_append (parent_node, G_NODE (iter->user_data));
1375 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1376 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1378 if (parent_node != tree_store->root)
1380 gtk_tree_path_up (path);
1381 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1383 gtk_tree_path_free (path);
1387 gtk_tree_store_insert_before (tree_store, iter, parent, NULL);
1390 validate_tree ((GtkTreeStore*)tree_store);
1394 * gtk_tree_store_is_ancestor:
1395 * @tree_store: A #GtkTreeStore
1396 * @iter: A valid #GtkTreeIter
1397 * @descendant: A valid #GtkTreeIter
1399 * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
1400 * parent (or grandparent or great-grandparent) of @descendant.
1402 * Return value: %TRUE, if @iter is an ancestor of @descendant
1405 gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
1407 GtkTreeIter *descendant)
1409 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1410 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1411 g_return_val_if_fail (VALID_ITER (descendant, tree_store), FALSE);
1413 return g_node_is_ancestor (G_NODE (iter->user_data),
1414 G_NODE (descendant->user_data));
1419 * gtk_tree_store_iter_depth:
1420 * @tree_store: A #GtkTreeStore
1421 * @iter: A valid #GtkTreeIter
1423 * Returns the depth of @iter. This will be 0 for anything on the root level, 1
1424 * for anything down a level, etc.
1426 * Return value: The depth of @iter
1429 gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
1432 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), 0);
1433 g_return_val_if_fail (VALID_ITER (iter, tree_store), 0);
1435 return g_node_depth (G_NODE (iter->user_data)) - 2;
1438 /* simple ripoff from g_node_traverse_post_order */
1440 gtk_tree_store_clear_traverse (GNode *node,
1441 GtkTreeStore *store)
1449 child = node->children;
1452 register GNode *current;
1455 child = current->next;
1456 if (gtk_tree_store_clear_traverse (current, store))
1462 iter.stamp = store->stamp;
1463 iter.user_data = node;
1465 gtk_tree_store_remove (store, &iter);
1468 else if (node->parent)
1470 iter.stamp = store->stamp;
1471 iter.user_data = node;
1473 gtk_tree_store_remove (store, &iter);
1480 * gtk_tree_store_clear:
1481 * @tree_store: a #GtkTreeStore
1483 * Removes all rows from @tree_store
1486 gtk_tree_store_clear (GtkTreeStore *tree_store)
1488 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1490 gtk_tree_store_clear_traverse (tree_store->root, tree_store);
1494 gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter,
1503 if (node == iter->user_data)
1507 if (gtk_tree_store_iter_is_valid_helper (iter, node->children))
1518 * gtk_tree_store_iter_is_valid:
1519 * @tree_store: A #GtkTreeStore.
1520 * @iter: A #GtkTreeIter.
1522 * WARNING: This function is slow. Only use it for debugging and/or testing
1525 * Checks if the given iter is a valid iter for this #GtkTreeStore.
1527 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
1530 gtk_tree_store_iter_is_valid (GtkTreeStore *tree_store,
1533 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1534 g_return_val_if_fail (iter != NULL, FALSE);
1536 if (!VALID_ITER (iter, tree_store))
1539 return gtk_tree_store_iter_is_valid_helper (iter, tree_store->root);
1546 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1551 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1553 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_source),
1557 gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1568 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1570 GtkSelectionData *selection_data)
1572 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1574 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1575 * target, because the default handler does it for us, but
1576 * we do anyway for the convenience of someone maybe overriding the
1580 if (gtk_tree_set_row_drag_data (selection_data,
1581 GTK_TREE_MODEL (drag_source),
1588 /* FIXME handle text targets at least. */
1595 copy_node_data (GtkTreeStore *tree_store,
1596 GtkTreeIter *src_iter,
1597 GtkTreeIter *dest_iter)
1599 GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
1600 GtkTreeDataList *copy_head = NULL;
1601 GtkTreeDataList *copy_prev = NULL;
1602 GtkTreeDataList *copy_iter = NULL;
1609 copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->column_headers[col]);
1611 if (copy_head == NULL)
1612 copy_head = copy_iter;
1615 copy_prev->next = copy_iter;
1617 copy_prev = copy_iter;
1623 G_NODE (dest_iter->user_data)->data = copy_head;
1625 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
1626 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, dest_iter);
1627 gtk_tree_path_free (path);
1631 recursive_node_copy (GtkTreeStore *tree_store,
1632 GtkTreeIter *src_iter,
1633 GtkTreeIter *dest_iter)
1636 GtkTreeModel *model;
1638 model = GTK_TREE_MODEL (tree_store);
1640 copy_node_data (tree_store, src_iter, dest_iter);
1642 if (gtk_tree_model_iter_children (model,
1646 /* Need to create children and recurse. Note our
1647 * dependence on persistent iterators here.
1653 /* Gee, a really slow algorithm... ;-) FIXME */
1654 gtk_tree_store_append (tree_store,
1658 recursive_node_copy (tree_store, &child, ©);
1660 while (gtk_tree_model_iter_next (model, &child));
1665 gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
1667 GtkSelectionData *selection_data)
1669 GtkTreeModel *tree_model;
1670 GtkTreeStore *tree_store;
1671 GtkTreeModel *src_model = NULL;
1672 GtkTreePath *src_path = NULL;
1673 gboolean retval = FALSE;
1675 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
1677 tree_model = GTK_TREE_MODEL (drag_dest);
1678 tree_store = GTK_TREE_STORE (drag_dest);
1680 validate_tree (tree_store);
1682 if (gtk_tree_get_row_drag_data (selection_data,
1685 src_model == tree_model)
1687 /* Copy the given row to a new position */
1688 GtkTreeIter src_iter;
1689 GtkTreeIter dest_iter;
1692 if (!gtk_tree_model_get_iter (src_model,
1699 /* Get the path to insert _after_ (dest is the path to insert _before_) */
1700 prev = gtk_tree_path_copy (dest);
1702 if (!gtk_tree_path_prev (prev))
1704 GtkTreeIter dest_parent;
1705 GtkTreePath *parent;
1706 GtkTreeIter *dest_parent_p;
1708 /* dest was the first spot at the current depth; which means
1709 * we are supposed to prepend.
1712 /* Get the parent, NULL if parent is the root */
1713 dest_parent_p = NULL;
1714 parent = gtk_tree_path_copy (dest);
1715 if (gtk_tree_path_up (parent) &&
1716 gtk_tree_path_get_depth (parent) > 0)
1718 gtk_tree_model_get_iter (tree_model,
1721 dest_parent_p = &dest_parent;
1723 gtk_tree_path_free (parent);
1726 gtk_tree_store_prepend (GTK_TREE_STORE (tree_model),
1734 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model),
1738 GtkTreeIter tmp_iter = dest_iter;
1740 if (GPOINTER_TO_INT (g_object_get_data (G_OBJECT (tree_model), "gtk-tree-model-drop-append")))
1744 if (gtk_tree_model_iter_parent (GTK_TREE_MODEL (tree_model), &parent, &tmp_iter))
1745 gtk_tree_store_append (GTK_TREE_STORE (tree_model),
1746 &dest_iter, &parent);
1748 gtk_tree_store_append (GTK_TREE_STORE (tree_model),
1752 gtk_tree_store_insert_after (GTK_TREE_STORE (tree_model),
1761 g_object_set_data (G_OBJECT (tree_model), "gtk-tree-model-drop-append",
1764 gtk_tree_path_free (prev);
1766 /* If we succeeded in creating dest_iter, walk src_iter tree branch,
1767 * duplicating it below dest_iter.
1772 recursive_node_copy (tree_store,
1779 /* FIXME maybe add some data targets eventually, or handle text
1780 * targets in the simple case.
1788 gtk_tree_path_free (src_path);
1794 gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
1795 GtkTreePath *dest_path,
1796 GtkSelectionData *selection_data)
1798 GtkTreeModel *src_model = NULL;
1799 GtkTreePath *src_path = NULL;
1800 GtkTreePath *tmp = NULL;
1801 gboolean retval = FALSE;
1803 if (!gtk_tree_get_row_drag_data (selection_data,
1808 /* can only drag to ourselves */
1809 if (src_model != GTK_TREE_MODEL (drag_dest))
1812 /* Can't drop into ourself. */
1813 if (gtk_tree_path_is_ancestor (src_path,
1817 /* Can't drop if dest_path's parent doesn't exist */
1821 if (gtk_tree_path_get_depth (dest_path) > 1)
1823 tmp = gtk_tree_path_copy (dest_path);
1824 gtk_tree_path_up (tmp);
1826 if (!gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_dest),
1832 /* Can otherwise drop anywhere. */
1838 gtk_tree_path_free (src_path);
1840 gtk_tree_path_free (tmp);
1846 typedef struct _SortTuple
1853 gtk_tree_store_compare_func (gconstpointer a,
1857 GtkTreeStore *tree_store = user_data;
1860 GtkTreeIterCompareFunc func;
1867 if (tree_store->sort_column_id != -1)
1869 GtkTreeDataSortHeader *header;
1871 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1872 tree_store->sort_column_id);
1873 g_return_val_if_fail (header != NULL, 0);
1874 g_return_val_if_fail (header->func != NULL, 0);
1876 func = header->func;
1877 data = header->data;
1881 g_return_val_if_fail (tree_store->default_sort_func != NULL, 0);
1882 func = tree_store->default_sort_func;
1883 data = tree_store->default_sort_data;
1886 node_a = ((SortTuple *) a)->node;
1887 node_b = ((SortTuple *) b)->node;
1889 iter_a.stamp = tree_store->stamp;
1890 iter_a.user_data = node_a;
1891 iter_b.stamp = tree_store->stamp;
1892 iter_b.user_data = node_b;
1894 retval = (* func) (GTK_TREE_MODEL (user_data), &iter_a, &iter_b, data);
1896 if (tree_store->order == GTK_SORT_DESCENDING)
1900 else if (retval < 0)
1907 gtk_tree_store_sort_helper (GtkTreeStore *tree_store,
1920 node = parent->children;
1921 if (node == NULL || node->next == NULL)
1924 g_assert (GTK_TREE_STORE_IS_SORTED (tree_store));
1927 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1930 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), list_length);
1933 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1938 tuple.node = tmp_node;
1939 g_array_append_val (sort_array, tuple);
1943 /* Sort the array */
1944 g_array_sort_with_data (sort_array, gtk_tree_store_compare_func, tree_store);
1946 for (i = 0; i < list_length - 1; i++)
1948 g_array_index (sort_array, SortTuple, i).node->next =
1949 g_array_index (sort_array, SortTuple, i + 1).node;
1950 g_array_index (sort_array, SortTuple, i + 1).node->prev =
1951 g_array_index (sort_array, SortTuple, i).node;
1953 g_array_index (sort_array, SortTuple, list_length - 1).node->next = NULL;
1954 g_array_index (sort_array, SortTuple, 0).node->prev = NULL;
1955 parent->children = g_array_index (sort_array, SortTuple, 0).node;
1957 /* Let the world know about our new order */
1958 new_order = g_new (gint, list_length);
1959 for (i = 0; i < list_length; i++)
1960 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1962 iter.stamp = tree_store->stamp;
1963 iter.user_data = parent;
1964 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &iter);
1965 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
1966 path, &iter, new_order);
1967 gtk_tree_path_free (path);
1969 g_array_free (sort_array, TRUE);
1973 for (tmp_node = parent->children; tmp_node; tmp_node = tmp_node->next)
1975 if (tmp_node->children)
1976 gtk_tree_store_sort_helper (tree_store, tmp_node, TRUE);
1982 gtk_tree_store_sort (GtkTreeStore *tree_store)
1984 if (tree_store->sort_column_id != -1)
1986 GtkTreeDataSortHeader *header = NULL;
1988 header = _gtk_tree_data_list_get_header (tree_store->sort_list, tree_store->sort_column_id);
1990 /* We want to make sure that we have a function */
1991 g_return_if_fail (header != NULL);
1992 g_return_if_fail (header->func != NULL);
1996 g_return_if_fail (tree_store->default_sort_func != NULL);
1999 gtk_tree_store_sort_helper (tree_store, G_NODE (tree_store->root), TRUE);
2003 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
2010 GtkTreePath *tmp_path;
2011 GtkTreeIter tmp_iter;
2019 GtkTreeIterCompareFunc func;
2022 g_return_if_fail (G_NODE (iter->user_data)->parent != NULL);
2024 tmp_iter.stamp = tree_store->stamp;
2025 if (tree_store->sort_column_id != -1)
2027 GtkTreeDataSortHeader *header;
2028 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
2029 tree_store->sort_column_id);
2030 g_return_if_fail (header != NULL);
2031 g_return_if_fail (header->func != NULL);
2032 func = header->func;
2033 data = header->data;
2037 g_return_if_fail (tree_store->default_sort_func != NULL);
2038 func = tree_store->default_sort_func;
2039 data = tree_store->default_sort_data;
2042 /* If it's the built in function, we don't sort. */
2043 if (func == gtk_tree_data_list_compare_func &&
2044 tree_store->sort_column_id != column)
2048 node = G_NODE (iter->user_data)->parent->children;
2049 /* First we find the iter, its prev, and its next */
2052 if (node == G_NODE (iter->user_data))
2057 g_assert (node != NULL);
2062 /* Check the common case, where we don't need to sort it moved. */
2065 tmp_iter.user_data = prev;
2066 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
2071 tmp_iter.user_data = next;
2072 cmp_b = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
2075 if (tree_store->order == GTK_SORT_DESCENDING)
2088 if (prev == NULL && cmp_b <= 0)
2090 else if (next == NULL && cmp_a <= 0)
2092 else if (prev != NULL && next != NULL &&
2093 cmp_a <= 0 && cmp_b <= 0)
2096 /* We actually need to sort it */
2097 /* First, remove the old link. */
2102 node->parent->children = next;
2110 /* FIXME: as an optimization, we can potentially start at next */
2112 node = node->parent->children;
2114 tmp_iter.user_data = node;
2115 if (tree_store->order == GTK_SORT_DESCENDING)
2116 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
2118 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
2120 while ((node->next) && (cmp_a > 0))
2125 tmp_iter.user_data = node;
2126 if (tree_store->order == GTK_SORT_DESCENDING)
2127 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
2129 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
2132 if ((!node->next) && (cmp_a > 0))
2135 node->next = G_NODE (iter->user_data);
2136 node->next->prev = node;
2140 prev->next = G_NODE (iter->user_data);
2141 prev->next->prev = prev;
2142 G_NODE (iter->user_data)->next = node;
2143 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
2147 G_NODE (iter->user_data)->next = G_NODE (iter->user_data)->parent->children;
2148 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
2149 G_NODE (iter->user_data)->parent->children = G_NODE (iter->user_data);
2152 /* Emit the reordered signal. */
2153 length = g_node_n_children (node->parent);
2154 new_order = g_new (int, length);
2155 if (old_location < new_location)
2156 for (i = 0; i < length; i++)
2158 if (i < old_location ||
2161 else if (i >= old_location &&
2163 new_order[i] = i + 1;
2164 else if (i == new_location)
2165 new_order[i] = old_location;
2168 for (i = 0; i < length; i++)
2170 if (i < new_location ||
2173 else if (i > new_location &&
2175 new_order[i] = i - 1;
2176 else if (i == new_location)
2177 new_order[i] = old_location;
2180 tmp_iter.user_data = node->parent;
2181 tmp_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &tmp_iter);
2183 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2184 tmp_path, &tmp_iter,
2187 gtk_tree_path_free (tmp_path);
2193 gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
2194 gint *sort_column_id,
2197 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2199 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2201 if (tree_store->sort_column_id == -1)
2205 * sort_column_id = tree_store->sort_column_id;
2207 * order = tree_store->order;
2213 gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
2214 gint sort_column_id,
2217 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2219 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2222 if ((tree_store->sort_column_id == sort_column_id) &&
2223 (tree_store->order == order))
2226 if (sort_column_id != -1)
2228 GtkTreeDataSortHeader *header = NULL;
2230 header = _gtk_tree_data_list_get_header (tree_store->sort_list, sort_column_id);
2232 /* We want to make sure that we have a function */
2233 g_return_if_fail (header != NULL);
2234 g_return_if_fail (header->func != NULL);
2238 g_return_if_fail (tree_store->default_sort_func != NULL);
2241 tree_store->sort_column_id = sort_column_id;
2242 tree_store->order = order;
2244 gtk_tree_store_sort (tree_store);
2246 gtk_tree_sortable_sort_column_changed (sortable);
2250 gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
2251 gint sort_column_id,
2252 GtkTreeIterCompareFunc func,
2254 GtkDestroyNotify destroy)
2256 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2257 GtkTreeDataSortHeader *header = NULL;
2260 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2261 g_return_if_fail (func != NULL);
2263 for (list = tree_store->sort_list; list; list = list->next)
2265 GtkTreeDataSortHeader *list_header;
2267 list_header = (GtkTreeDataSortHeader*) list->data;
2268 if (list_header->sort_column_id == sort_column_id)
2270 header = list_header;
2277 header = g_new0 (GtkTreeDataSortHeader, 1);
2278 header->sort_column_id = sort_column_id;
2279 tree_store->sort_list = g_list_append (tree_store->sort_list, header);
2282 if (header->destroy)
2284 GtkDestroyNotify d = header->destroy;
2286 header->destroy = NULL;
2290 header->func = func;
2291 header->data = data;
2292 header->destroy = destroy;
2296 gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
2297 GtkTreeIterCompareFunc func,
2299 GtkDestroyNotify destroy)
2301 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2303 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2305 if (tree_store->default_sort_destroy)
2307 GtkDestroyNotify d = tree_store->default_sort_destroy;
2309 tree_store->default_sort_destroy = NULL;
2310 d (tree_store->default_sort_data);
2313 tree_store->default_sort_func = func;
2314 tree_store->default_sort_data = data;
2315 tree_store->default_sort_destroy = destroy;
2319 gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable)
2321 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2323 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2325 return (tree_store->default_sort_func != NULL);
2329 validate_gnode (GNode* node)
2333 iter = node->children;
2334 while (iter != NULL)
2336 g_assert (iter->parent == node);
2338 g_assert (iter->prev->next == iter);
2339 validate_gnode (iter);