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 != -1)
30 static void gtk_tree_store_init (GtkTreeStore *tree_store);
31 static void gtk_tree_store_class_init (GtkTreeStoreClass *tree_store_class);
32 static void gtk_tree_store_tree_model_init (GtkTreeModelIface *iface);
33 static void gtk_tree_store_drag_source_init(GtkTreeDragSourceIface *iface);
34 static void gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface);
35 static void gtk_tree_store_sortable_init (GtkTreeSortableIface *iface);
36 static guint gtk_tree_store_get_flags (GtkTreeModel *tree_model);
37 static gint gtk_tree_store_get_n_columns (GtkTreeModel *tree_model);
38 static GType gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
40 static GtkTreePath *gtk_tree_store_get_path (GtkTreeModel *tree_model,
42 static void gtk_tree_store_get_value (GtkTreeModel *tree_model,
46 static gboolean gtk_tree_store_iter_next (GtkTreeModel *tree_model,
48 static gboolean gtk_tree_store_iter_children (GtkTreeModel *tree_model,
51 static gboolean gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
53 static gint gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
55 static gboolean gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
59 static gboolean gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
65 static gboolean gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
67 static gboolean gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
69 GtkSelectionData *selection_data);
70 static gboolean gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
72 GtkSelectionData *selection_data);
73 static gboolean gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
74 GtkTreeModel *src_model,
75 GtkTreePath *src_path,
76 GtkTreePath *dest_path);
78 /* Sortable Interfaces */
80 static void gtk_tree_store_sort (GtkTreeStore *tree_store);
81 static void gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
84 static gboolean gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
86 GtkTreeSortOrder *order);
87 static void gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
89 GtkTreeSortOrder order);
90 static void gtk_tree_store_sort_column_id_set_func (GtkTreeSortable *sortable,
92 GtkTreeIterCompareFunc func,
94 GtkDestroyNotify destroy);
97 static void validate_gnode (GNode *node);
100 validate_tree (GtkTreeStore *tree_store)
102 if (gtk_debug_flags & GTK_DEBUG_TREE)
104 g_assert (G_NODE (tree_store->root)->parent == NULL);
106 validate_gnode (G_NODE (tree_store->root));
111 gtk_tree_store_get_type (void)
113 static GType tree_store_type = 0;
115 if (!tree_store_type)
117 static const GTypeInfo tree_store_info =
119 sizeof (GtkTreeStoreClass),
120 NULL, /* base_init */
121 NULL, /* base_finalize */
122 (GClassInitFunc) gtk_tree_store_class_init,
123 NULL, /* class_finalize */
124 NULL, /* class_data */
125 sizeof (GtkTreeStore),
127 (GInstanceInitFunc) gtk_tree_store_init
130 static const GInterfaceInfo tree_model_info =
132 (GInterfaceInitFunc) gtk_tree_store_tree_model_init,
137 static const GInterfaceInfo drag_source_info =
139 (GInterfaceInitFunc) gtk_tree_store_drag_source_init,
144 static const GInterfaceInfo drag_dest_info =
146 (GInterfaceInitFunc) gtk_tree_store_drag_dest_init,
151 static const GInterfaceInfo sortable_info =
153 (GInterfaceInitFunc) gtk_tree_store_sortable_init,
158 tree_store_type = g_type_register_static (G_TYPE_OBJECT, "GtkTreeStore", &tree_store_info, 0);
160 g_type_add_interface_static (tree_store_type,
163 g_type_add_interface_static (tree_store_type,
164 GTK_TYPE_TREE_DRAG_SOURCE,
166 g_type_add_interface_static (tree_store_type,
167 GTK_TYPE_TREE_DRAG_DEST,
169 g_type_add_interface_static (tree_store_type,
170 GTK_TYPE_TREE_SORTABLE,
175 return tree_store_type;
179 gtk_tree_store_class_init (GtkTreeStoreClass *tree_store_class)
181 GObjectClass *object_class;
183 object_class = (GObjectClass *) tree_store_class;
188 gtk_tree_store_tree_model_init (GtkTreeModelIface *iface)
190 iface->get_flags = gtk_tree_store_get_flags;
191 iface->get_n_columns = gtk_tree_store_get_n_columns;
192 iface->get_column_type = gtk_tree_store_get_column_type;
193 iface->get_path = gtk_tree_store_get_path;
194 iface->get_value = gtk_tree_store_get_value;
195 iface->iter_next = gtk_tree_store_iter_next;
196 iface->iter_children = gtk_tree_store_iter_children;
197 iface->iter_has_child = gtk_tree_store_iter_has_child;
198 iface->iter_n_children = gtk_tree_store_iter_n_children;
199 iface->iter_nth_child = gtk_tree_store_iter_nth_child;
200 iface->iter_parent = gtk_tree_store_iter_parent;
204 gtk_tree_store_drag_source_init (GtkTreeDragSourceIface *iface)
206 iface->drag_data_delete = gtk_tree_store_drag_data_delete;
207 iface->drag_data_get = gtk_tree_store_drag_data_get;
211 gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface)
213 iface->drag_data_received = gtk_tree_store_drag_data_received;
214 iface->row_drop_possible = gtk_tree_store_row_drop_possible;
218 gtk_tree_store_sortable_init (GtkTreeSortableIface *iface)
220 iface->get_sort_column_id = gtk_tree_store_get_sort_column_id;
221 iface->set_sort_column_id = gtk_tree_store_set_sort_column_id;
222 iface->sort_column_id_set_func = gtk_tree_store_sort_column_id_set_func;
226 gtk_tree_store_init (GtkTreeStore *tree_store)
228 tree_store->root = g_node_new (NULL);
229 tree_store->stamp = g_random_int ();
230 tree_store->sort_list = NULL;
234 gtk_tree_store_new (void)
236 return GTK_TREE_STORE (g_object_new (gtk_tree_store_get_type (), NULL));
240 gtk_tree_store_new_with_types (gint n_columns,
243 GtkTreeStore *retval;
247 g_return_val_if_fail (n_columns > 0, NULL);
249 retval = gtk_tree_store_new ();
250 gtk_tree_store_set_n_columns (retval, n_columns);
252 va_start (args, n_columns);
254 for (i = 0; i < n_columns; i++)
256 GType type = va_arg (args, GType);
257 if (! _gtk_tree_data_list_check_type (type))
259 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (type));
260 g_object_unref (G_OBJECT (retval));
263 gtk_tree_store_set_column_type (retval, i, type);
271 * gtk_tree_store_set_n_columns:
275 * As a side effect of calling this function, all sort columns that overlap with
276 * the current number of columns will be removed.
279 gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
284 g_return_if_fail (tree_store != NULL);
285 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
287 if (tree_store->n_columns == n_columns)
290 new_columns = g_new0 (GType, n_columns);
291 if (tree_store->column_headers)
293 /* copy the old header orders over */
294 if (n_columns >= tree_store->n_columns)
295 memcpy (new_columns, tree_store->column_headers, tree_store->n_columns * sizeof (gchar *));
297 memcpy (new_columns, tree_store->column_headers, n_columns * sizeof (GType));
299 g_free (tree_store->column_headers);
302 if (tree_store->sort_list)
303 _gtk_tree_data_list_header_free (tree_store->sort_list);
305 tree_store->sort_list = _gtk_tree_data_list_header_new (n_columns, tree_store->column_headers);
307 tree_store->column_headers = new_columns;
308 tree_store->n_columns = n_columns;
312 * gtk_tree_store_set_column_type:
313 * @tree_store: a #GtkTreeStore
314 * @column: column number
315 * @type: type of the data to be stored in @column
317 * Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
318 * %G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
319 * %G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
320 * subclasses of those types such as %GDK_TYPE_PIXBUF.
324 gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
328 g_return_if_fail (tree_store != NULL);
329 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
330 g_return_if_fail (column >=0 && column < tree_store->n_columns);
331 if (!_gtk_tree_data_list_check_type (type))
333 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (type));
336 tree_store->column_headers[column] = type;
339 /* fulfill the GtkTreeModel requirements */
340 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node. However,
341 * it is not visible to the tree or to the user., and the path "0" refers to the
342 * first child of GtkTreeStore::root.
347 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
349 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
351 return GTK_TREE_MODEL_ITERS_PERSIST;
355 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
357 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
359 return GTK_TREE_STORE (tree_model)->n_columns;
363 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
366 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), G_TYPE_INVALID);
367 g_return_val_if_fail (index < GTK_TREE_STORE (tree_model)->n_columns &&
368 index >= 0, G_TYPE_INVALID);
370 return GTK_TREE_STORE (tree_model)->column_headers[index];
374 gtk_tree_store_get_path (GtkTreeModel *tree_model,
381 g_return_val_if_fail (tree_model != NULL, NULL);
382 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), NULL);
383 g_return_val_if_fail (iter != NULL, NULL);
384 g_return_val_if_fail (iter->user_data != NULL, NULL);
386 validate_tree ((GtkTreeStore*)tree_model);
388 g_assert (G_NODE (iter->user_data)->parent != NULL);
390 if (G_NODE (iter->user_data)->parent == G_NODE (GTK_TREE_STORE (tree_model)->root))
392 retval = gtk_tree_path_new ();
393 tmp_node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
397 GtkTreeIter tmp_iter = *iter;
399 tmp_iter.user_data = G_NODE (iter->user_data)->parent;
401 retval = gtk_tree_store_get_path (tree_model,
403 tmp_node = G_NODE (iter->user_data)->parent->children;
409 if (tmp_node == NULL)
411 gtk_tree_path_free (retval);
415 for (; tmp_node; tmp_node = tmp_node->next)
417 if (tmp_node == G_NODE (iter->user_data))
422 if (tmp_node == NULL)
424 /* We couldn't find node, meaning it's prolly not ours */
425 /* Perhaps I should do a g_return_if_fail here. */
426 gtk_tree_path_free (retval);
430 gtk_tree_path_append_index (retval, i);
437 gtk_tree_store_get_value (GtkTreeModel *tree_model,
442 GtkTreeDataList *list;
443 gint tmp_column = column;
445 g_return_if_fail (tree_model != NULL);
446 g_return_if_fail (GTK_IS_TREE_STORE (tree_model));
447 g_return_if_fail (iter != NULL);
448 g_return_if_fail (column < GTK_TREE_STORE (tree_model)->n_columns);
450 list = G_NODE (iter->user_data)->data;
452 while (tmp_column-- > 0 && list)
457 _gtk_tree_data_list_node_to_value (list,
458 GTK_TREE_STORE (tree_model)->column_headers[column],
463 /* We want to return an initialized but empty (default) value */
464 g_value_init (value, GTK_TREE_STORE (tree_model)->column_headers[column]);
469 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
472 g_return_val_if_fail (iter->user_data != NULL, FALSE);
474 if (G_NODE (iter->user_data)->next)
476 iter->user_data = G_NODE (iter->user_data)->next;
484 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
490 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
493 children = G_NODE (parent->user_data)->children;
495 children = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
499 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
500 iter->user_data = children;
508 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
511 g_return_val_if_fail (tree_model != NULL, FALSE);
512 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
513 g_return_val_if_fail (iter != NULL, FALSE);
514 g_return_val_if_fail (iter->user_data != NULL, FALSE);
516 return G_NODE (iter->user_data)->children != NULL;
520 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
526 g_return_val_if_fail (tree_model != NULL, 0);
527 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
528 g_return_val_if_fail (iter != NULL, FALSE);
529 g_return_val_if_fail (iter->user_data != NULL, FALSE);
532 node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
534 node = G_NODE (iter->user_data)->children;
546 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
554 g_return_val_if_fail (tree_model != NULL, FALSE);
555 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
556 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
559 parent_node = GTK_TREE_STORE (tree_model)->root;
561 parent_node = parent->user_data;
563 child = g_node_nth_child (parent_node, n);
567 iter->user_data = child;
568 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
576 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
582 g_return_val_if_fail (iter != NULL, FALSE);
583 g_return_val_if_fail (iter->user_data != NULL, FALSE);
585 parent = G_NODE (child->user_data)->parent;
587 g_assert (parent != NULL);
589 if (parent != GTK_TREE_STORE (tree_model)->root)
591 iter->user_data = parent;
592 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
600 * This is a somewhat inelegant function that does a lot of list
601 * manipulations on it's own.
604 gtk_tree_store_set_value (GtkTreeStore *tree_store,
609 GtkTreeDataList *list;
610 GtkTreeDataList *prev;
611 GtkTreePath *path = NULL;
612 GValue real_value = {0, };
613 gboolean converted = FALSE;
615 g_return_if_fail (tree_store != NULL);
616 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
617 g_return_if_fail (column >= 0 && column < tree_store->n_columns);
618 g_return_if_fail (G_IS_VALUE (value));
620 if (! g_type_is_a (G_VALUE_TYPE (value), tree_store->column_headers[column]))
622 if (! (g_value_type_compatible (G_VALUE_TYPE (value), tree_store->column_headers[column]) &&
623 g_value_type_compatible (tree_store->column_headers[column], G_VALUE_TYPE (value))))
625 g_warning ("%s: Unable to convert from %s to %s\n",
627 g_type_name (G_VALUE_TYPE (value)),
628 g_type_name (tree_store->column_headers[column]));
631 if (!g_value_transform (value, &real_value))
633 g_warning ("%s: Unable to make conversion from %s to %s\n",
635 g_type_name (G_VALUE_TYPE (value)),
636 g_type_name (tree_store->column_headers[column]));
637 g_value_unset (&real_value);
643 prev = list = G_NODE (iter->user_data)->data;
645 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
652 _gtk_tree_data_list_value_to_node (list, &real_value);
654 _gtk_tree_data_list_value_to_node (list, value);
655 gtk_tree_model_range_changed (GTK_TREE_MODEL (tree_store), path, iter, path, iter);
656 gtk_tree_path_free (path);
658 g_value_unset (&real_value);
667 if (G_NODE (iter->user_data)->data == NULL)
669 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
674 list = prev->next = _gtk_tree_data_list_alloc ();
680 list->next = _gtk_tree_data_list_alloc ();
686 _gtk_tree_data_list_value_to_node (list, &real_value);
688 _gtk_tree_data_list_value_to_node (list, value);
689 gtk_tree_model_range_changed (GTK_TREE_MODEL (tree_store), path, iter, path, iter);
690 gtk_tree_path_free (path);
692 g_value_unset (&real_value);
694 if (GTK_TREE_STORE_IS_SORTED (tree_store))
695 gtk_tree_store_sort_iter_changed (tree_store, iter, column);
699 * gtk_tree_store_set_valist:
700 * @tree_store: a #GtkTreeStore
701 * @iter: row to set data for
702 * @var_args: va_list of column/value pairs
704 * See gtk_tree_store_set(); this version takes a va_list for
705 * use by language bindings.
709 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
715 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
717 column = va_arg (var_args, gint);
721 GValue value = { 0, };
724 if (column >= tree_store->n_columns)
726 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
729 g_value_init (&value, tree_store->column_headers[column]);
731 G_VALUE_COLLECT (&value, var_args, 0, &error);
734 g_warning ("%s: %s", G_STRLOC, error);
737 /* we purposely leak the value here, it might not be
738 * in a sane state if an error condition occoured
743 gtk_tree_store_set_value (tree_store,
748 g_value_unset (&value);
750 column = va_arg (var_args, gint);
755 * gtk_tree_store_set:
756 * @tree_store: a #GtkTreeStore
757 * @iter: row iterator
758 * @Varargs: pairs of column number and value, terminated with -1
760 * Sets the value of one or more cells in the row referenced by @iter.
761 * The variable argument list should contain integer column numbers,
762 * each column number followed by the value to be set. For example,
763 * The list is terminated by a -1. For example, to set column 0 with type
764 * %G_TYPE_STRING to "Foo", you would write gtk_tree_store_set (store, iter,
768 gtk_tree_store_set (GtkTreeStore *tree_store,
774 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
776 va_start (var_args, iter);
777 gtk_tree_store_set_valist (tree_store, iter, var_args);
782 gtk_tree_store_remove (GtkTreeStore *model,
786 GtkTreeIter new_iter = {0,};
789 g_return_if_fail (model != NULL);
790 g_return_if_fail (GTK_IS_TREE_STORE (model));
792 parent = G_NODE (iter->user_data)->parent;
794 g_assert (parent != NULL);
796 if (G_NODE (iter->user_data)->data)
797 _gtk_tree_data_list_free ((GtkTreeDataList *) G_NODE (iter->user_data)->data,
798 model->column_headers);
800 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
801 g_node_destroy (G_NODE (iter->user_data));
804 gtk_tree_model_deleted (GTK_TREE_MODEL (model), path);
806 if (parent != G_NODE (model->root) && parent->children == NULL)
808 gtk_tree_path_up (path);
810 new_iter.stamp = model->stamp;
811 new_iter.user_data = parent;
812 gtk_tree_model_has_child_toggled (GTK_TREE_MODEL (model), path, &new_iter);
814 gtk_tree_path_free (path);
818 gtk_tree_store_insert (GtkTreeStore *model,
826 g_return_if_fail (model != NULL);
827 g_return_if_fail (GTK_IS_TREE_STORE (model));
830 parent_node = parent->user_data;
832 parent_node = model->root;
834 iter->stamp = model->stamp;
835 iter->user_data = g_node_new (NULL);
836 g_node_insert (parent_node, position, G_NODE (iter->user_data));
838 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
839 gtk_tree_model_inserted (GTK_TREE_MODEL (model), path, iter);
841 gtk_tree_path_free (path);
843 validate_tree ((GtkTreeStore*)model);
847 gtk_tree_store_insert_before (GtkTreeStore *model,
850 GtkTreeIter *sibling)
853 GNode *parent_node = NULL;
856 g_return_if_fail (model != NULL);
857 g_return_if_fail (GTK_IS_TREE_STORE (model));
858 g_return_if_fail (iter != NULL);
860 new_node = g_node_new (NULL);
862 if (parent == NULL && sibling == NULL)
863 parent_node = model->root;
864 else if (parent == NULL)
865 parent_node = G_NODE (sibling->user_data)->parent;
866 else if (sibling == NULL)
867 parent_node = G_NODE (parent->user_data);
870 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
871 G_NODE (parent->user_data));
872 parent_node = G_NODE (parent->user_data);
875 g_node_insert_before (parent_node,
876 sibling ? G_NODE (sibling->user_data) : NULL,
879 iter->stamp = model->stamp;
880 iter->user_data = new_node;
882 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
883 gtk_tree_model_inserted (GTK_TREE_MODEL (model), path, iter);
885 gtk_tree_path_free (path);
887 validate_tree ((GtkTreeStore*)model);
891 gtk_tree_store_insert_after (GtkTreeStore *model,
894 GtkTreeIter *sibling)
900 g_return_if_fail (model != NULL);
901 g_return_if_fail (GTK_IS_TREE_STORE (model));
902 g_return_if_fail (iter != NULL);
904 new_node = g_node_new (NULL);
906 if (parent == NULL && sibling == NULL)
907 parent_node = model->root;
908 else if (parent == NULL)
909 parent_node = G_NODE (sibling->user_data)->parent;
910 else if (sibling == NULL)
911 parent_node = G_NODE (parent->user_data);
914 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
915 G_NODE (parent->user_data));
916 parent_node = G_NODE (parent->user_data);
920 g_node_insert_after (parent_node,
921 sibling ? G_NODE (sibling->user_data) : NULL,
924 iter->stamp = model->stamp;
925 iter->user_data = new_node;
927 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
928 gtk_tree_model_inserted (GTK_TREE_MODEL (model), path, iter);
930 gtk_tree_path_free (path);
932 validate_tree ((GtkTreeStore*)model);
936 gtk_tree_store_prepend (GtkTreeStore *model,
942 g_return_if_fail (model != NULL);
943 g_return_if_fail (GTK_IS_TREE_STORE (model));
944 g_return_if_fail (iter != NULL);
947 parent_node = model->root;
949 parent_node = parent->user_data;
951 if (parent_node->children == NULL)
955 iter->stamp = model->stamp;
956 iter->user_data = g_node_new (NULL);
958 g_node_prepend (parent_node, iter->user_data);
960 if (parent_node != model->root)
962 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), parent);
963 gtk_tree_model_has_child_toggled (GTK_TREE_MODEL (model), path, parent);
964 gtk_tree_path_append_index (path, 0);
968 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
970 gtk_tree_model_inserted (GTK_TREE_MODEL (model), path, iter);
971 gtk_tree_path_free (path);
975 gtk_tree_store_insert_after (model, iter, parent, NULL);
978 validate_tree ((GtkTreeStore*)model);
982 gtk_tree_store_append (GtkTreeStore *model,
988 g_return_if_fail (model != NULL);
989 g_return_if_fail (GTK_IS_TREE_STORE (model));
990 g_return_if_fail (iter != NULL);
993 parent_node = model->root;
995 parent_node = parent->user_data;
997 if (parent_node->children == NULL)
1001 iter->stamp = model->stamp;
1002 iter->user_data = g_node_new (NULL);
1004 g_node_append (parent_node, G_NODE (iter->user_data));
1006 if (parent_node != model->root)
1008 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), parent);
1009 gtk_tree_model_has_child_toggled (GTK_TREE_MODEL (model), path, parent);
1010 gtk_tree_path_append_index (path, 0);
1014 path = gtk_tree_store_get_path (GTK_TREE_MODEL (model), iter);
1017 gtk_tree_model_inserted (GTK_TREE_MODEL (model), path, iter);
1018 gtk_tree_path_free (path);
1022 gtk_tree_store_insert_before (model, iter, parent, NULL);
1025 validate_tree ((GtkTreeStore*)model);
1029 gtk_tree_store_is_ancestor (GtkTreeStore *model,
1031 GtkTreeIter *descendant)
1033 g_return_val_if_fail (model != NULL, FALSE);
1034 g_return_val_if_fail (GTK_IS_TREE_STORE (model), FALSE);
1035 g_return_val_if_fail (iter != NULL, FALSE);
1036 g_return_val_if_fail (descendant != NULL, FALSE);
1038 return g_node_is_ancestor (G_NODE (iter->user_data),
1039 G_NODE (descendant->user_data));
1044 gtk_tree_store_iter_depth (GtkTreeStore *model,
1047 g_return_val_if_fail (model != NULL, 0);
1048 g_return_val_if_fail (GTK_IS_TREE_STORE (model), 0);
1049 g_return_val_if_fail (iter != NULL, 0);
1051 return g_node_depth (G_NODE (iter->user_data)) - 1;
1059 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1064 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1066 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_source),
1070 gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1081 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1083 GtkSelectionData *selection_data)
1085 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1087 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1088 * target, because the default handler does it for us, but
1089 * we do anyway for the convenience of someone maybe overriding the
1093 if (gtk_selection_data_set_tree_row (selection_data,
1094 GTK_TREE_MODEL (drag_source),
1101 /* FIXME handle text targets at least. */
1108 copy_node_data (GtkTreeStore *tree_store,
1109 GtkTreeIter *src_iter,
1110 GtkTreeIter *dest_iter)
1112 GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
1113 GtkTreeDataList *copy_head = NULL;
1114 GtkTreeDataList *copy_prev = NULL;
1115 GtkTreeDataList *copy_iter = NULL;
1122 copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->column_headers[col]);
1124 if (copy_head == NULL)
1125 copy_head = copy_iter;
1128 copy_prev->next = copy_iter;
1130 copy_prev = copy_iter;
1136 G_NODE (dest_iter->user_data)->data = copy_head;
1138 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
1139 gtk_tree_model_range_changed (GTK_TREE_MODEL (tree_store), path, dest_iter, path, dest_iter);
1140 gtk_tree_path_free (path);
1144 recursive_node_copy (GtkTreeStore *tree_store,
1145 GtkTreeIter *src_iter,
1146 GtkTreeIter *dest_iter)
1149 GtkTreeModel *model;
1151 model = GTK_TREE_MODEL (tree_store);
1153 copy_node_data (tree_store, src_iter, dest_iter);
1155 if (gtk_tree_model_iter_children (model,
1159 /* Need to create children and recurse. Note our
1160 * dependence on persistent iterators here.
1166 /* Gee, a really slow algorithm... ;-) FIXME */
1167 gtk_tree_store_append (tree_store,
1171 recursive_node_copy (tree_store, &child, ©);
1173 while (gtk_tree_model_iter_next (model, &child));
1178 gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
1180 GtkSelectionData *selection_data)
1182 GtkTreeModel *tree_model;
1183 GtkTreeStore *tree_store;
1184 GtkTreeModel *src_model = NULL;
1185 GtkTreePath *src_path = NULL;
1186 gboolean retval = FALSE;
1188 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
1190 tree_model = GTK_TREE_MODEL (drag_dest);
1191 tree_store = GTK_TREE_STORE (drag_dest);
1193 validate_tree (tree_store);
1195 if (gtk_selection_data_get_tree_row (selection_data,
1198 src_model == tree_model)
1200 /* Copy the given row to a new position */
1201 GtkTreeIter src_iter;
1202 GtkTreeIter dest_iter;
1205 if (!gtk_tree_model_get_iter (src_model,
1212 /* Get the path to insert _after_ (dest is the path to insert _before_) */
1213 prev = gtk_tree_path_copy (dest);
1215 if (!gtk_tree_path_prev (prev))
1217 GtkTreeIter dest_parent;
1218 GtkTreePath *parent;
1219 GtkTreeIter *dest_parent_p;
1221 /* dest was the first spot at the current depth; which means
1222 * we are supposed to prepend.
1225 /* Get the parent, NULL if parent is the root */
1226 dest_parent_p = NULL;
1227 parent = gtk_tree_path_copy (dest);
1228 if (gtk_tree_path_up (parent))
1230 gtk_tree_model_get_iter (tree_model,
1233 dest_parent_p = &dest_parent;
1235 gtk_tree_path_free (parent);
1238 gtk_tree_store_prepend (GTK_TREE_STORE (tree_model),
1246 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model),
1250 GtkTreeIter tmp_iter = dest_iter;
1251 gtk_tree_store_insert_after (GTK_TREE_STORE (tree_model),
1260 gtk_tree_path_free (prev);
1262 /* If we succeeded in creating dest_iter, walk src_iter tree branch,
1263 * duplicating it below dest_iter.
1268 recursive_node_copy (tree_store,
1275 /* FIXME maybe add some data targets eventually, or handle text
1276 * targets in the simple case.
1284 gtk_tree_path_free (src_path);
1290 gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
1291 GtkTreeModel *src_model,
1292 GtkTreePath *src_path,
1293 GtkTreePath *dest_path)
1295 /* can only drag to ourselves */
1296 if (src_model != GTK_TREE_MODEL (drag_dest))
1299 /* Can't drop into ourself. */
1300 if (gtk_tree_path_is_ancestor (src_path,
1304 /* Can't drop if dest_path's parent doesn't exist */
1307 GtkTreePath *tmp = gtk_tree_path_copy (dest_path);
1309 /* if we can't go up, we know the parent exists, the root
1312 if (gtk_tree_path_up (tmp))
1314 if (!gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_dest),
1318 gtk_tree_path_free (tmp);
1324 gtk_tree_path_free (tmp);
1327 /* Can otherwise drop anywhere. */
1333 gtk_tree_store_sort (GtkTreeStore *tree_store)
1339 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
1343 GtkTreeDataSortHeader *header;
1347 GtkTreePath *tmp_path;
1348 GtkTreeIter tmp_iter;
1358 if (G_NODE (iter->user_data)->parent)
1359 node = G_NODE (iter->user_data)->parent->children;
1361 node = G_NODE (tree_store->root);
1363 tmp_iter.stamp = tree_store->stamp;
1364 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1365 tree_store->sort_column_id);
1366 g_return_if_fail (header != NULL);
1367 g_return_if_fail (header->func != NULL);
1369 /* If it's the built in function, we don't sort. */
1370 if (header->func == gtk_tree_data_list_compare_func &&
1371 tree_store->sort_column_id != column)
1375 /* First we find the iter, its prev, and its next */
1378 if (node == G_NODE (iter->user_data))
1384 g_assert (node != NULL);
1388 /* Check the common case, where we don't need to sort it moved. */
1391 tmp_iter.user_data = prev;
1392 cmp_a = (* header->func) (GTK_TREE_MODEL (tree_store),
1399 tmp_iter.user_data = next;
1400 cmp_b = (* header->func) (GTK_TREE_MODEL (tree_store),
1406 if (tree_store->order == GTK_TREE_SORT_DESCENDING)
1419 if (prev == NULL && cmp_b <= 0)
1421 else if (next == NULL && cmp_a <= 0)
1423 else if (prev != NULL && next != NULL &&
1424 cmp_a <= 0 && cmp_b <= 0)
1427 /* We actually need to sort it */
1428 /* First, remove the old link. */
1431 tree_store->root = next;
1436 /* FIXME: as an optimization, we can potentially start at next */
1438 node = G_NODE (tree_store->root);
1440 tmp_iter.user_data = node;
1441 if (tree_store->order == GTK_TREE_SORT_DESCENDING)
1442 cmp_a = (* header->func) (GTK_TREE_MODEL (tree_store),
1443 &tmp_iter, iter, header->data);
1445 cmp_a = (* header->func) (GTK_TREE_MODEL (tree_store),
1446 iter, &tmp_iter, header->data);
1448 while ((node->next) && (cmp_a > 0))
1453 tmp_iter.user_data = node;
1454 if (tree_store->order == GTK_TREE_SORT_DESCENDING)
1455 cmp_a = (* header->func) (GTK_TREE_MODEL (tree_store),
1456 &tmp_iter, iter, header->data);
1458 cmp_a = (* header->func) (GTK_TREE_MODEL (tree_store),
1459 iter, &tmp_iter, header->data);
1462 if ((!node->next) && (cmp_a > 0))
1464 node->next = G_NODE (iter->user_data);
1468 prev->next = G_NODE (iter->user_data);
1469 G_NODE (iter->user_data)->next = node;
1473 G_NODE (iter->user_data)->next = G_NODE (tree_store->root);
1474 tree_store->root = G_NODE (iter->user_data);
1477 /* Emit the reordered signal. */
1478 length = g_node_n_children (node->parent);
1479 new_order = g_new (int, length);
1480 if (old_location < new_location)
1481 for (i = 0; i < length; i++)
1483 if (i < old_location ||
1486 else if (i >= old_location &&
1488 new_order[i] = i + 1;
1489 else if (i == new_location)
1490 new_order[i] = old_location;
1493 for (i = 0; i < length; i++)
1495 if (i < new_location ||
1498 else if (i > new_location &&
1500 new_order[i] = i - 1;
1501 else if (i == new_location)
1502 new_order[i] = old_location;
1506 tmp_path = gtk_tree_path_new ();
1507 tmp_iter.user_data = NULL;
1509 gtk_tree_model_reordered (GTK_TREE_MODEL (tree_store),
1510 tmp_path, &tmp_iter,
1513 gtk_tree_path_free (tmp_path);
1519 gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
1520 gint *sort_column_id,
1521 GtkTreeSortOrder *order)
1523 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
1525 g_return_val_if_fail (sortable != NULL, FALSE);
1526 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
1528 if (tree_store->sort_column_id == -1)
1532 * sort_column_id = tree_store->sort_column_id;
1534 * order = tree_store->order;
1540 gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
1541 gint sort_column_id,
1542 GtkTreeSortOrder order)
1544 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
1547 g_return_if_fail (sortable != NULL);
1548 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
1550 for (list = tree_store->sort_list; list; list = list->next)
1552 GtkTreeDataSortHeader *header = (GtkTreeDataSortHeader*) list->data;
1553 if (header->sort_column_id == sort_column_id)
1556 g_return_if_fail (list != NULL);
1558 if ((tree_store->sort_column_id == sort_column_id) &&
1559 (tree_store->order == order))
1562 tree_store->sort_column_id = sort_column_id;
1563 tree_store->order = order;
1565 if (tree_store->sort_column_id >= 0)
1566 gtk_tree_store_sort (tree_store);
1568 gtk_tree_sortable_sort_column_changed (sortable);
1572 gtk_tree_store_sort_column_id_set_func (GtkTreeSortable *sortable,
1573 gint sort_column_id,
1574 GtkTreeIterCompareFunc func,
1576 GtkDestroyNotify destroy)
1578 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
1579 GtkTreeDataSortHeader *header = NULL;
1582 g_return_if_fail (sortable != NULL);
1583 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
1584 g_return_if_fail (func != NULL);
1586 for (list = tree_store->sort_list; list; list = list->next)
1588 header = (GtkTreeDataSortHeader*) list->data;
1589 if (header->sort_column_id == sort_column_id)
1595 header = g_new0 (GtkTreeDataSortHeader, 1);
1596 header->sort_column_id = sort_column_id;
1597 tree_store->sort_list = g_list_append (tree_store->sort_list, header);
1600 if (header->destroy)
1601 (* header->destroy) (header->data);
1603 header->func = func;
1604 header->data = data;
1605 header->destroy = destroy;
1610 validate_gnode (GNode* node)
1614 iter = node->children;
1615 while (iter != NULL)
1617 g_assert (iter->parent == node);
1619 g_assert (iter->prev->next == iter);
1620 validate_gnode (iter);