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 guint 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_LEAFS, 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 (* tree_store->default_sort_destroy) (tree_store->default_sort_data);
454 tree_store->default_sort_destroy = NULL;
455 tree_store->default_sort_data = NULL;
458 (* parent_class->finalize) (object);
461 /* fulfill the GtkTreeModel requirements */
462 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node. However,
463 * it is not visible to the tree or to the user., and the path "0" refers to the
464 * first child of GtkTreeStore::root.
469 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
471 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
473 return GTK_TREE_MODEL_ITERS_PERSIST;
477 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
479 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
481 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
483 tree_store->columns_dirty = TRUE;
485 return tree_store->n_columns;
489 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
492 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
494 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), G_TYPE_INVALID);
495 g_return_val_if_fail (index < GTK_TREE_STORE (tree_model)->n_columns &&
496 index >= 0, G_TYPE_INVALID);
498 tree_store->columns_dirty = TRUE;
500 return tree_store->column_headers[index];
504 gtk_tree_store_get_iter (GtkTreeModel *tree_model,
508 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
513 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
515 tree_store->columns_dirty = TRUE;
517 indices = gtk_tree_path_get_indices (path);
518 depth = gtk_tree_path_get_depth (path);
520 g_return_val_if_fail (depth > 0, FALSE);
522 parent.stamp = tree_store->stamp;
523 parent.user_data = tree_store->root;
525 if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[0]))
528 for (i = 1; i < depth; i++)
531 if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[i]))
539 gtk_tree_store_get_path (GtkTreeModel *tree_model,
546 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), NULL);
547 g_return_val_if_fail (iter != NULL, NULL);
548 g_return_val_if_fail (iter->user_data != NULL, NULL);
549 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, NULL);
551 validate_tree ((GtkTreeStore*)tree_model);
553 if (G_NODE (iter->user_data)->parent == NULL &&
554 G_NODE (iter->user_data) == GTK_TREE_STORE (tree_model)->root)
555 return gtk_tree_path_new ();
556 g_assert (G_NODE (iter->user_data)->parent != NULL);
558 if (G_NODE (iter->user_data)->parent == G_NODE (GTK_TREE_STORE (tree_model)->root))
560 retval = gtk_tree_path_new ();
561 tmp_node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
565 GtkTreeIter tmp_iter = *iter;
567 tmp_iter.user_data = G_NODE (iter->user_data)->parent;
569 retval = gtk_tree_store_get_path (tree_model,
571 tmp_node = G_NODE (iter->user_data)->parent->children;
577 if (tmp_node == NULL)
579 gtk_tree_path_free (retval);
583 for (; tmp_node; tmp_node = tmp_node->next)
585 if (tmp_node == G_NODE (iter->user_data))
590 if (tmp_node == NULL)
592 /* We couldn't find node, meaning it's prolly not ours */
593 /* Perhaps I should do a g_return_if_fail here. */
594 gtk_tree_path_free (retval);
598 gtk_tree_path_append_index (retval, i);
605 gtk_tree_store_get_value (GtkTreeModel *tree_model,
610 GtkTreeDataList *list;
611 gint tmp_column = column;
613 g_return_if_fail (GTK_IS_TREE_STORE (tree_model));
614 g_return_if_fail (iter != NULL);
615 g_return_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp);
616 g_return_if_fail (column < GTK_TREE_STORE (tree_model)->n_columns);
618 list = G_NODE (iter->user_data)->data;
620 while (tmp_column-- > 0 && list)
625 _gtk_tree_data_list_node_to_value (list,
626 GTK_TREE_STORE (tree_model)->column_headers[column],
631 /* We want to return an initialized but empty (default) value */
632 g_value_init (value, GTK_TREE_STORE (tree_model)->column_headers[column]);
637 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
640 g_return_val_if_fail (iter != NULL, FALSE);
641 g_return_val_if_fail (iter->user_data != NULL, FALSE);
642 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
644 if (G_NODE (iter->user_data)->next)
646 iter->user_data = G_NODE (iter->user_data)->next;
654 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
660 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
661 g_return_val_if_fail (parent == NULL || parent->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
664 children = G_NODE (parent->user_data)->children;
666 children = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
670 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
671 iter->user_data = children;
679 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
682 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
683 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
684 g_return_val_if_fail (iter->user_data != NULL, FALSE);
686 return G_NODE (iter->user_data)->children != NULL;
690 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
696 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
697 g_return_val_if_fail (iter == NULL || iter->user_data != NULL, FALSE);
700 node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
702 node = G_NODE (iter->user_data)->children;
714 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
722 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
723 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
726 parent_node = GTK_TREE_STORE (tree_model)->root;
728 parent_node = parent->user_data;
730 child = g_node_nth_child (parent_node, n);
734 iter->user_data = child;
735 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
743 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
749 g_return_val_if_fail (iter != NULL, FALSE);
750 g_return_val_if_fail (child != NULL, FALSE);
751 g_return_val_if_fail (child->user_data != NULL, FALSE);
752 g_return_val_if_fail (child->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
754 parent = G_NODE (child->user_data)->parent;
756 g_assert (parent != NULL);
758 if (parent != GTK_TREE_STORE (tree_model)->root)
760 iter->user_data = parent;
761 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
769 /* Does not emit a signal */
771 gtk_tree_store_real_set_value (GtkTreeStore *tree_store,
776 GtkTreeDataList *list;
777 GtkTreeDataList *prev;
778 GtkTreePath *path = NULL;
779 GValue real_value = {0, };
780 gboolean converted = FALSE;
781 gint orig_column = column;
782 gboolean retval = FALSE;
784 if (! g_type_is_a (G_VALUE_TYPE (value), tree_store->column_headers[column]))
786 if (! (g_value_type_compatible (G_VALUE_TYPE (value), tree_store->column_headers[column]) &&
787 g_value_type_compatible (tree_store->column_headers[column], G_VALUE_TYPE (value))))
789 g_warning ("%s: Unable to convert from %s to %s\n",
791 g_type_name (G_VALUE_TYPE (value)),
792 g_type_name (tree_store->column_headers[column]));
795 if (!g_value_transform (value, &real_value))
797 g_warning ("%s: Unable to make conversion from %s to %s\n",
799 g_type_name (G_VALUE_TYPE (value)),
800 g_type_name (tree_store->column_headers[column]));
801 g_value_unset (&real_value);
807 prev = list = G_NODE (iter->user_data)->data;
809 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
816 _gtk_tree_data_list_value_to_node (list, &real_value);
818 _gtk_tree_data_list_value_to_node (list, value);
820 gtk_tree_path_free (path);
822 g_value_unset (&real_value);
831 if (G_NODE (iter->user_data)->data == NULL)
833 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
838 list = prev->next = _gtk_tree_data_list_alloc ();
844 list->next = _gtk_tree_data_list_alloc ();
850 _gtk_tree_data_list_value_to_node (list, &real_value);
852 _gtk_tree_data_list_value_to_node (list, value);
855 gtk_tree_path_free (path);
857 g_value_unset (&real_value);
859 if (GTK_TREE_STORE_IS_SORTED (tree_store))
860 gtk_tree_store_sort_iter_changed (tree_store, iter, orig_column);
866 * gtk_tree_store_set_value:
867 * @tree_store: a #GtkTreeStore
868 * @iter: A valid #GtkTreeIter for the row being modified
869 * @column: column number to modify
870 * @value: new value for the cell
872 * Sets the data in the cell specified by @iter and @column.
873 * The type of @value must be convertible to the type of the
878 gtk_tree_store_set_value (GtkTreeStore *tree_store,
883 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
884 g_return_if_fail (VALID_ITER (iter, tree_store));
885 g_return_if_fail (column >= 0 && column < tree_store->n_columns);
886 g_return_if_fail (G_IS_VALUE (value));
888 if (gtk_tree_store_real_set_value (tree_store, iter, column, value))
892 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
893 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
894 gtk_tree_path_free (path);
899 * gtk_tree_store_set_valist:
900 * @tree_store: A #GtkTreeStore
901 * @iter: A valid #GtkTreeIter for the row being modified
902 * @var_args: <type>va_list</type> of column/value pairs
904 * See gtk_tree_store_set(); this version takes a <type>va_list</type> for
905 * use by language bindings.
909 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
914 gboolean emit_signal = FALSE;
916 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
917 g_return_if_fail (VALID_ITER (iter, tree_store));
919 column = va_arg (var_args, gint);
923 GValue value = { 0, };
926 if (column >= tree_store->n_columns)
928 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
931 g_value_init (&value, tree_store->column_headers[column]);
933 G_VALUE_COLLECT (&value, var_args, 0, &error);
936 g_warning ("%s: %s", G_STRLOC, error);
939 /* we purposely leak the value here, it might not be
940 * in a sane state if an error condition occoured
945 emit_signal = gtk_tree_store_real_set_value (tree_store,
948 &value) || emit_signal;
950 g_value_unset (&value);
952 column = va_arg (var_args, gint);
958 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
959 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
960 gtk_tree_path_free (path);
965 * gtk_tree_store_set:
966 * @tree_store: A #GtkTreeStore
967 * @iter: A valid #GtkTreeIter for the row being modified
968 * @Varargs: pairs of column number and value, terminated with -1
970 * Sets the value of one or more cells in the row referenced by @iter.
971 * The variable argument list should contain integer column numbers,
972 * each column number followed by the value to be set.
973 * The list is terminated by a -1. For example, to set column 0 with type
974 * %G_TYPE_STRING to "Foo", you would write
975 * <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
978 gtk_tree_store_set (GtkTreeStore *tree_store,
984 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
985 g_return_if_fail (VALID_ITER (iter, tree_store));
987 va_start (var_args, iter);
988 gtk_tree_store_set_valist (tree_store, iter, var_args);
993 * gtk_tree_store_remove:
994 * @tree_store: A #GtkTreeStore
995 * @iter: A valid #GtkTreeIter
997 * Removes @iter from @tree_store. After being removed, @iter is set to the
998 * next valid row at that level, or invalidated if it previously pointed to the
1002 gtk_tree_store_remove (GtkTreeStore *tree_store,
1006 GtkTreeIter new_iter = {0,};
1010 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1011 g_return_if_fail (VALID_ITER (iter, tree_store));
1013 parent = G_NODE (iter->user_data)->parent;
1015 g_assert (parent != NULL);
1016 next_node = G_NODE (iter->user_data)->next;
1018 if (G_NODE (iter->user_data)->data)
1019 _gtk_tree_data_list_free ((GtkTreeDataList *) G_NODE (iter->user_data)->data,
1020 tree_store->column_headers);
1022 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1023 g_node_destroy (G_NODE (iter->user_data));
1025 gtk_tree_model_row_deleted (GTK_TREE_MODEL (tree_store), path);
1027 if (parent != G_NODE (tree_store->root))
1030 if (parent->children == NULL)
1032 gtk_tree_path_up (path);
1034 new_iter.stamp = tree_store->stamp;
1035 new_iter.user_data = parent;
1036 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &new_iter);
1039 gtk_tree_path_free (path);
1041 /* revalidate iter */
1042 if (next_node != NULL)
1044 iter->stamp = tree_store->stamp;
1045 iter->user_data = next_node;
1050 iter->user_data = NULL;
1055 * gtk_tree_store_insert:
1056 * @tree_store: A #GtkTreeStore
1057 * @iter: An unset #GtkTreeIter to set to the new row
1058 * @parent: A valid #GtkTreeIter, or %NULL
1059 * @position: position to insert the new row
1061 * Creates a new row at @position. If parent is non-%NULL, then the row will be
1062 * made a child of @parent. Otherwise, the row will be created at the toplevel.
1063 * If @position is larger than the number of rows at that level, then the new
1064 * row will be inserted to the end of the list. @iter will be changed to point
1065 * to this new row. The row will be empty before this function is called. To
1066 * fill in values, you need to call gtk_tree_store_set() or
1067 * gtk_tree_store_set_value().
1071 gtk_tree_store_insert (GtkTreeStore *tree_store,
1073 GtkTreeIter *parent,
1079 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1081 g_return_if_fail (VALID_ITER (parent, tree_store));
1084 parent_node = parent->user_data;
1086 parent_node = tree_store->root;
1088 tree_store->columns_dirty = TRUE;
1090 iter->stamp = tree_store->stamp;
1091 iter->user_data = g_node_new (NULL);
1092 g_node_insert (parent_node, position, G_NODE (iter->user_data));
1094 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1095 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1097 gtk_tree_path_free (path);
1099 validate_tree ((GtkTreeStore*)tree_store);
1103 * gtk_tree_store_insert_before:
1104 * @tree_store: A #GtkTreeStore
1105 * @iter: An unset #GtkTreeIter to set to the new row
1106 * @parent: A valid #GtkTreeIter, or %NULL
1107 * @sibling: A valid #GtkTreeIter, or %NULL
1109 * Inserts a new row before @sibling. If @sibling is %NULL, then the row will
1110 * be appended to the beginning of the @parent 's children. If @parent and
1111 * @sibling are %NULL, then the row will be appended to the toplevel. If both
1112 * @sibling and @parent are set, then @parent must be the parent of @sibling.
1113 * When @sibling is set, @parent is optional.
1115 * @iter will be changed to point to this new row. The row will be empty after
1116 * this function is called. To fill in values, you need to call
1117 * gtk_tree_store_set() or gtk_tree_store_set_value().
1121 gtk_tree_store_insert_before (GtkTreeStore *tree_store,
1123 GtkTreeIter *parent,
1124 GtkTreeIter *sibling)
1127 GNode *parent_node = NULL;
1130 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1131 g_return_if_fail (iter != NULL);
1133 g_return_if_fail (VALID_ITER (parent, tree_store));
1134 if (sibling != NULL)
1135 g_return_if_fail (VALID_ITER (sibling, tree_store));
1137 tree_store->columns_dirty = TRUE;
1139 new_node = g_node_new (NULL);
1141 if (parent == NULL && sibling == NULL)
1142 parent_node = tree_store->root;
1143 else if (parent == NULL)
1144 parent_node = G_NODE (sibling->user_data)->parent;
1145 else if (sibling == NULL)
1146 parent_node = G_NODE (parent->user_data);
1149 g_return_if_fail (G_NODE (sibling->user_data)->parent == G_NODE (parent->user_data));
1150 parent_node = G_NODE (parent->user_data);
1153 g_node_insert_before (parent_node,
1154 sibling ? G_NODE (sibling->user_data) : NULL,
1157 iter->stamp = tree_store->stamp;
1158 iter->user_data = new_node;
1160 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1161 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1163 gtk_tree_path_free (path);
1165 validate_tree ((GtkTreeStore*)tree_store);
1169 * gtk_tree_store_insert_after:
1170 * @tree_store: A #GtkTreeStore
1171 * @iter: An unset #GtkTreeIter to set to the new row
1172 * @parent: A valid #GtkTreeIter, or %NULL
1173 * @sibling: A valid #GtkTreeIter, or %NULL
1175 * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
1176 * prepended to the beginning of the @parent 's children. If @parent and
1177 * @sibling are %NULL, then the row will be prepended to the toplevel. If both
1178 * @sibling and @parent are set, then @parent must be the parent of @sibling.
1179 * When @sibling is set, @parent is optional.
1181 * @iter will be changed to point to this new row. The row will be empty after
1182 * this function is called. To fill in values, you need to call
1183 * gtk_tree_store_set() or gtk_tree_store_set_value().
1187 gtk_tree_store_insert_after (GtkTreeStore *tree_store,
1189 GtkTreeIter *parent,
1190 GtkTreeIter *sibling)
1196 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1197 g_return_if_fail (iter != NULL);
1199 g_return_if_fail (VALID_ITER (parent, tree_store));
1200 if (sibling != NULL)
1201 g_return_if_fail (VALID_ITER (sibling, tree_store));
1203 tree_store->columns_dirty = TRUE;
1205 new_node = g_node_new (NULL);
1207 if (parent == NULL && sibling == NULL)
1208 parent_node = tree_store->root;
1209 else if (parent == NULL)
1210 parent_node = G_NODE (sibling->user_data)->parent;
1211 else if (sibling == NULL)
1212 parent_node = G_NODE (parent->user_data);
1215 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
1216 G_NODE (parent->user_data));
1217 parent_node = G_NODE (parent->user_data);
1221 g_node_insert_after (parent_node,
1222 sibling ? G_NODE (sibling->user_data) : NULL,
1225 iter->stamp = tree_store->stamp;
1226 iter->user_data = new_node;
1228 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1229 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1231 gtk_tree_path_free (path);
1233 validate_tree ((GtkTreeStore*)tree_store);
1237 * gtk_tree_store_prepend:
1238 * @tree_store: A #GtkTreeStore
1239 * @iter: An unset #GtkTreeIter to set to the prepended row
1240 * @parent: A valid #GtkTreeIter, or %NULL
1242 * Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
1243 * the new row before the first child of @parent, otherwise it will prepend a row
1244 * to the top level. @iter will be changed to point to this new row. The row
1245 * will be empty after this function is called. To fill in values, you need to
1246 * call gtk_tree_store_set() or gtk_tree_store_set_value().
1249 gtk_tree_store_prepend (GtkTreeStore *tree_store,
1251 GtkTreeIter *parent)
1255 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1256 g_return_if_fail (iter != NULL);
1258 g_return_if_fail (VALID_ITER (parent, tree_store));
1260 tree_store->columns_dirty = TRUE;
1263 parent_node = tree_store->root;
1265 parent_node = parent->user_data;
1267 if (parent_node->children == NULL)
1271 iter->stamp = tree_store->stamp;
1272 iter->user_data = g_node_new (NULL);
1274 g_node_prepend (parent_node, G_NODE (iter->user_data));
1276 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1277 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1279 if (parent_node != tree_store->root)
1281 gtk_tree_path_up (path);
1282 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1284 gtk_tree_path_free (path);
1288 gtk_tree_store_insert_after (tree_store, iter, parent, NULL);
1291 validate_tree ((GtkTreeStore*)tree_store);
1295 * gtk_tree_store_append:
1296 * @tree_store: A #GtkTreeStore
1297 * @iter: An unset #GtkTreeIter to set to the appended row
1298 * @parent: A valid #GtkTreeIter, or %NULL
1300 * Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
1301 * new row after the last child of @parent, otherwise it will append a row to
1302 * the top level. @iter will be changed to point to this new row. The row will
1303 * be empty after this function is called. To fill in values, you need to call
1304 * gtk_tree_store_set() or gtk_tree_store_set_value().
1307 gtk_tree_store_append (GtkTreeStore *tree_store,
1309 GtkTreeIter *parent)
1313 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1314 g_return_if_fail (iter != NULL);
1317 g_return_if_fail (VALID_ITER (parent, tree_store));
1320 parent_node = tree_store->root;
1322 parent_node = parent->user_data;
1324 tree_store->columns_dirty = TRUE;
1326 if (parent_node->children == NULL)
1330 iter->stamp = tree_store->stamp;
1331 iter->user_data = g_node_new (NULL);
1333 g_node_append (parent_node, G_NODE (iter->user_data));
1335 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1336 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1338 if (parent_node != tree_store->root)
1340 gtk_tree_path_up (path);
1341 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1343 gtk_tree_path_free (path);
1347 gtk_tree_store_insert_before (tree_store, iter, parent, NULL);
1350 validate_tree ((GtkTreeStore*)tree_store);
1354 * gtk_tree_store_is_ancestor:
1355 * @tree_store: A #GtkTreeStore
1356 * @iter: A valid #GtkTreeIter
1357 * @descendant: A valid #GtkTreeIter
1359 * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
1360 * parent (or grandparent or great-grandparent) of @descendant.
1362 * Return value: %TRUE, if @iter is an ancestor of @descendant
1365 gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
1367 GtkTreeIter *descendant)
1369 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1370 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1371 g_return_val_if_fail (VALID_ITER (descendant, tree_store), FALSE);
1373 return g_node_is_ancestor (G_NODE (iter->user_data),
1374 G_NODE (descendant->user_data));
1379 * gtk_tree_store_iter_depth:
1380 * @tree_store: A #GtkTreeStore
1381 * @iter: A valid #GtkTreeIter
1383 * Returns the depth of @iter. This will be 0 for anything on the root level, 1
1384 * for anything down a level, etc.
1386 * Return value: The depth of @iter
1389 gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
1392 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), 0);
1393 g_return_val_if_fail (VALID_ITER (iter, tree_store), 0);
1395 return g_node_depth (G_NODE (iter->user_data)) - 2;
1399 * gtk_tree_store_clear:
1400 * @tree_store: a #GtkTreeStore
1402 * Removes all rows from @tree_store
1405 gtk_tree_store_clear (GtkTreeStore *tree_store)
1409 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1411 while (G_NODE (tree_store->root)->children)
1413 iter.stamp = tree_store->stamp;
1414 iter.user_data = G_NODE (tree_store->root)->children;
1415 gtk_tree_store_remove (tree_store, &iter);
1423 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1428 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1430 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_source),
1434 gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1445 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1447 GtkSelectionData *selection_data)
1449 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1451 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1452 * target, because the default handler does it for us, but
1453 * we do anyway for the convenience of someone maybe overriding the
1457 if (gtk_tree_set_row_drag_data (selection_data,
1458 GTK_TREE_MODEL (drag_source),
1465 /* FIXME handle text targets at least. */
1472 copy_node_data (GtkTreeStore *tree_store,
1473 GtkTreeIter *src_iter,
1474 GtkTreeIter *dest_iter)
1476 GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
1477 GtkTreeDataList *copy_head = NULL;
1478 GtkTreeDataList *copy_prev = NULL;
1479 GtkTreeDataList *copy_iter = NULL;
1486 copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->column_headers[col]);
1488 if (copy_head == NULL)
1489 copy_head = copy_iter;
1492 copy_prev->next = copy_iter;
1494 copy_prev = copy_iter;
1500 G_NODE (dest_iter->user_data)->data = copy_head;
1502 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
1503 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, dest_iter);
1504 gtk_tree_path_free (path);
1508 recursive_node_copy (GtkTreeStore *tree_store,
1509 GtkTreeIter *src_iter,
1510 GtkTreeIter *dest_iter)
1513 GtkTreeModel *model;
1515 model = GTK_TREE_MODEL (tree_store);
1517 copy_node_data (tree_store, src_iter, dest_iter);
1519 if (gtk_tree_model_iter_children (model,
1523 /* Need to create children and recurse. Note our
1524 * dependence on persistent iterators here.
1530 /* Gee, a really slow algorithm... ;-) FIXME */
1531 gtk_tree_store_append (tree_store,
1535 recursive_node_copy (tree_store, &child, ©);
1537 while (gtk_tree_model_iter_next (model, &child));
1542 gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
1544 GtkSelectionData *selection_data)
1546 GtkTreeModel *tree_model;
1547 GtkTreeStore *tree_store;
1548 GtkTreeModel *src_model = NULL;
1549 GtkTreePath *src_path = NULL;
1550 gboolean retval = FALSE;
1552 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
1554 tree_model = GTK_TREE_MODEL (drag_dest);
1555 tree_store = GTK_TREE_STORE (drag_dest);
1557 validate_tree (tree_store);
1559 if (gtk_tree_get_row_drag_data (selection_data,
1562 src_model == tree_model)
1564 /* Copy the given row to a new position */
1565 GtkTreeIter src_iter;
1566 GtkTreeIter dest_iter;
1569 if (!gtk_tree_model_get_iter (src_model,
1576 /* Get the path to insert _after_ (dest is the path to insert _before_) */
1577 prev = gtk_tree_path_copy (dest);
1579 if (!gtk_tree_path_prev (prev))
1581 GtkTreeIter dest_parent;
1582 GtkTreePath *parent;
1583 GtkTreeIter *dest_parent_p;
1585 /* dest was the first spot at the current depth; which means
1586 * we are supposed to prepend.
1589 /* Get the parent, NULL if parent is the root */
1590 dest_parent_p = NULL;
1591 parent = gtk_tree_path_copy (dest);
1592 if (gtk_tree_path_up (parent))
1594 gtk_tree_model_get_iter (tree_model,
1597 dest_parent_p = &dest_parent;
1599 gtk_tree_path_free (parent);
1602 gtk_tree_store_prepend (GTK_TREE_STORE (tree_model),
1610 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model),
1614 GtkTreeIter tmp_iter = dest_iter;
1615 gtk_tree_store_insert_after (GTK_TREE_STORE (tree_model),
1624 gtk_tree_path_free (prev);
1626 /* If we succeeded in creating dest_iter, walk src_iter tree branch,
1627 * duplicating it below dest_iter.
1632 recursive_node_copy (tree_store,
1639 /* FIXME maybe add some data targets eventually, or handle text
1640 * targets in the simple case.
1648 gtk_tree_path_free (src_path);
1654 gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
1655 GtkTreePath *dest_path,
1656 GtkSelectionData *selection_data)
1658 GtkTreeModel *src_model = NULL;
1659 GtkTreePath *src_path = NULL;
1660 GtkTreePath *tmp = NULL;
1661 gboolean retval = FALSE;
1663 if (!gtk_tree_get_row_drag_data (selection_data,
1668 /* can only drag to ourselves */
1669 if (src_model != GTK_TREE_MODEL (drag_dest))
1672 /* Can't drop into ourself. */
1673 if (gtk_tree_path_is_ancestor (src_path,
1677 /* Can't drop if dest_path's parent doesn't exist */
1681 if (gtk_tree_path_get_depth (dest_path) > 1)
1683 tmp = gtk_tree_path_copy (dest_path);
1684 gtk_tree_path_up (tmp);
1686 if (!gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_dest),
1692 /* Can otherwise drop anywhere. */
1698 gtk_tree_path_free (src_path);
1700 gtk_tree_path_free (tmp);
1706 typedef struct _SortTuple
1713 gtk_tree_store_compare_func (gconstpointer a,
1717 GtkTreeStore *tree_store = user_data;
1720 GtkTreeIterCompareFunc func;
1727 if (tree_store->sort_column_id != -1)
1729 GtkTreeDataSortHeader *header;
1731 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1732 tree_store->sort_column_id);
1733 g_return_val_if_fail (header != NULL, 0);
1734 g_return_val_if_fail (header->func != NULL, 0);
1736 func = header->func;
1737 data = header->data;
1741 g_return_val_if_fail (tree_store->default_sort_func != NULL, 0);
1742 func = tree_store->default_sort_func;
1743 data = tree_store->default_sort_data;
1746 node_a = ((SortTuple *) a)->node;
1747 node_b = ((SortTuple *) b)->node;
1749 iter_a.stamp = tree_store->stamp;
1750 iter_a.user_data = node_a;
1751 iter_b.stamp = tree_store->stamp;
1752 iter_b.user_data = node_b;
1754 retval = (* func) (GTK_TREE_MODEL (user_data), &iter_a, &iter_b, data);
1756 if (tree_store->order == GTK_SORT_DESCENDING)
1760 else if (retval < 0)
1767 gtk_tree_store_sort_helper (GtkTreeStore *tree_store,
1780 node = parent->children;
1781 if (node == NULL || node->next == NULL)
1784 g_assert (GTK_TREE_STORE_IS_SORTED (tree_store));
1787 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1790 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), list_length);
1793 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1798 tuple.node = tmp_node;
1799 g_array_append_val (sort_array, tuple);
1803 /* Sort the array */
1804 g_array_sort_with_data (sort_array, gtk_tree_store_compare_func, tree_store);
1806 for (i = 0; i < list_length - 1; i++)
1808 g_array_index (sort_array, SortTuple, i).node->next =
1809 g_array_index (sort_array, SortTuple, i + 1).node;
1810 g_array_index (sort_array, SortTuple, i + 1).node->prev =
1811 g_array_index (sort_array, SortTuple, i).node;
1813 g_array_index (sort_array, SortTuple, list_length - 1).node->next = NULL;
1814 g_array_index (sort_array, SortTuple, 0).node->prev = NULL;
1815 parent->children = g_array_index (sort_array, SortTuple, 0).node;
1817 /* Let the world know about our new order */
1818 new_order = g_new (gint, list_length);
1819 for (i = 0; i < list_length; i++)
1820 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1822 iter.stamp = tree_store->stamp;
1823 iter.user_data = parent;
1824 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &iter);
1825 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
1826 path, &iter, new_order);
1827 gtk_tree_path_free (path);
1829 g_array_free (sort_array, TRUE);
1833 for (tmp_node = parent->children; tmp_node; tmp_node = tmp_node->next)
1835 if (tmp_node->children)
1836 gtk_tree_store_sort_helper (tree_store, tmp_node, TRUE);
1842 gtk_tree_store_sort (GtkTreeStore *tree_store)
1844 if (tree_store->sort_column_id != -1)
1846 GtkTreeDataSortHeader *header = NULL;
1848 header = _gtk_tree_data_list_get_header (tree_store->sort_list, tree_store->sort_column_id);
1850 /* We want to make sure that we have a function */
1851 g_return_if_fail (header != NULL);
1852 g_return_if_fail (header->func != NULL);
1856 g_return_if_fail (tree_store->default_sort_func != NULL);
1859 gtk_tree_store_sort_helper (tree_store, G_NODE (tree_store->root), TRUE);
1863 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
1870 GtkTreePath *tmp_path;
1871 GtkTreeIter tmp_iter;
1879 GtkTreeIterCompareFunc func;
1882 g_return_if_fail (G_NODE (iter->user_data)->parent != NULL);
1884 tmp_iter.stamp = tree_store->stamp;
1885 if (tree_store->sort_column_id != -1)
1887 GtkTreeDataSortHeader *header;
1888 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1889 tree_store->sort_column_id);
1890 g_return_if_fail (header != NULL);
1891 g_return_if_fail (header->func != NULL);
1892 func = header->func;
1893 data = header->data;
1897 g_return_if_fail (tree_store->default_sort_func != NULL);
1898 func = tree_store->default_sort_func;
1899 data = tree_store->default_sort_data;
1902 /* If it's the built in function, we don't sort. */
1903 if (func == gtk_tree_data_list_compare_func &&
1904 tree_store->sort_column_id != column)
1908 node = G_NODE (iter->user_data)->parent->children;
1909 /* First we find the iter, its prev, and its next */
1912 if (node == G_NODE (iter->user_data))
1917 g_assert (node != NULL);
1922 /* Check the common case, where we don't need to sort it moved. */
1925 tmp_iter.user_data = prev;
1926 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1931 tmp_iter.user_data = next;
1932 cmp_b = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1936 if (tree_store->order == GTK_SORT_DESCENDING)
1949 if (prev == NULL && cmp_b <= 0)
1951 else if (next == NULL && cmp_a <= 0)
1953 else if (prev != NULL && next != NULL &&
1954 cmp_a <= 0 && cmp_b <= 0)
1957 /* We actually need to sort it */
1958 /* First, remove the old link. */
1963 node->parent->children = next;
1970 /* FIXME: as an optimization, we can potentially start at next */
1972 node = node->parent->children;
1974 tmp_iter.user_data = node;
1975 if (tree_store->order == GTK_SORT_DESCENDING)
1976 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1978 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1980 while ((node->next) && (cmp_a > 0))
1985 tmp_iter.user_data = node;
1986 if (tree_store->order == GTK_SORT_DESCENDING)
1987 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1989 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1992 if ((!node->next) && (cmp_a > 0))
1994 node->next = G_NODE (iter->user_data);
1995 node->next->prev = node;
1999 prev->next = G_NODE (iter->user_data);
2000 prev->next->prev = prev;
2001 G_NODE (iter->user_data)->next = node;
2002 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
2006 G_NODE (iter->user_data)->next = G_NODE (iter->user_data)->parent->children;
2007 G_NODE (iter->user_data)->parent->children = G_NODE (iter->user_data);
2010 /* Emit the reordered signal. */
2011 length = g_node_n_children (node->parent);
2012 new_order = g_new (int, length);
2013 if (old_location < new_location)
2014 for (i = 0; i < length; i++)
2016 if (i < old_location ||
2019 else if (i >= old_location &&
2021 new_order[i] = i + 1;
2022 else if (i == new_location)
2023 new_order[i] = old_location;
2026 for (i = 0; i < length; i++)
2028 if (i < new_location ||
2031 else if (i > new_location &&
2033 new_order[i] = i - 1;
2034 else if (i == new_location)
2035 new_order[i] = old_location;
2038 tmp_iter.user_data = node->parent;
2039 tmp_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &tmp_iter);
2041 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2042 tmp_path, &tmp_iter,
2045 gtk_tree_path_free (tmp_path);
2051 gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
2052 gint *sort_column_id,
2055 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2057 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2059 if (tree_store->sort_column_id == -1)
2063 * sort_column_id = tree_store->sort_column_id;
2065 * order = tree_store->order;
2071 gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
2072 gint sort_column_id,
2075 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2077 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2080 if ((tree_store->sort_column_id == sort_column_id) &&
2081 (tree_store->order == order))
2084 if (sort_column_id != -1)
2086 GtkTreeDataSortHeader *header = NULL;
2088 header = _gtk_tree_data_list_get_header (tree_store->sort_list, sort_column_id);
2090 /* We want to make sure that we have a function */
2091 g_return_if_fail (header != NULL);
2092 g_return_if_fail (header->func != NULL);
2096 g_return_if_fail (tree_store->default_sort_func != NULL);
2099 tree_store->sort_column_id = sort_column_id;
2100 tree_store->order = order;
2102 gtk_tree_store_sort (tree_store);
2104 gtk_tree_sortable_sort_column_changed (sortable);
2108 gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
2109 gint sort_column_id,
2110 GtkTreeIterCompareFunc func,
2112 GtkDestroyNotify destroy)
2114 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2115 GtkTreeDataSortHeader *header = NULL;
2118 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2119 g_return_if_fail (func != NULL);
2121 for (list = tree_store->sort_list; list; list = list->next)
2123 header = (GtkTreeDataSortHeader*) list->data;
2124 if (header->sort_column_id == sort_column_id)
2130 header = g_new0 (GtkTreeDataSortHeader, 1);
2131 header->sort_column_id = sort_column_id;
2132 tree_store->sort_list = g_list_append (tree_store->sort_list, header);
2135 if (header->destroy)
2136 (* header->destroy) (header->data);
2138 header->func = func;
2139 header->data = data;
2140 header->destroy = destroy;
2145 gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
2146 GtkTreeIterCompareFunc func,
2148 GtkDestroyNotify destroy)
2150 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2152 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2154 if (tree_store->default_sort_destroy)
2155 (* tree_store->default_sort_destroy) (tree_store->default_sort_data);
2157 tree_store->default_sort_func = func;
2158 tree_store->default_sort_data = data;
2159 tree_store->default_sort_destroy = destroy;
2163 gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable)
2165 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2167 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2169 return (tree_store->default_sort_func != NULL);
2173 validate_gnode (GNode* node)
2177 iter = node->children;
2178 while (iter != NULL)
2180 g_assert (iter->parent == node);
2182 g_assert (iter->prev->next == iter);
2183 validate_gnode (iter);