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 GtkTreeModel *src_model,
87 GtkTreePath *src_path,
88 GtkTreePath *dest_path);
90 /* Sortable Interfaces */
92 static void gtk_tree_store_sort (GtkTreeStore *tree_store);
93 static void gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
96 static gboolean gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
99 static void gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
102 static void gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
104 GtkTreeIterCompareFunc func,
106 GtkDestroyNotify destroy);
107 static void gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
108 GtkTreeIterCompareFunc func,
110 GtkDestroyNotify destroy);
111 static gboolean gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable);
113 static void validate_gnode (GNode *node);
116 static GObjectClass *parent_class = NULL;
120 validate_tree (GtkTreeStore *tree_store)
122 if (gtk_debug_flags & GTK_DEBUG_TREE)
124 g_assert (G_NODE (tree_store->root)->parent == NULL);
126 validate_gnode (G_NODE (tree_store->root));
131 gtk_tree_store_get_type (void)
133 static GType tree_store_type = 0;
135 if (!tree_store_type)
137 static const GTypeInfo tree_store_info =
139 sizeof (GtkTreeStoreClass),
140 NULL, /* base_init */
141 NULL, /* base_finalize */
142 (GClassInitFunc) gtk_tree_store_class_init,
143 NULL, /* class_finalize */
144 NULL, /* class_data */
145 sizeof (GtkTreeStore),
147 (GInstanceInitFunc) gtk_tree_store_init
150 static const GInterfaceInfo tree_model_info =
152 (GInterfaceInitFunc) gtk_tree_store_tree_model_init,
157 static const GInterfaceInfo drag_source_info =
159 (GInterfaceInitFunc) gtk_tree_store_drag_source_init,
164 static const GInterfaceInfo drag_dest_info =
166 (GInterfaceInitFunc) gtk_tree_store_drag_dest_init,
171 static const GInterfaceInfo sortable_info =
173 (GInterfaceInitFunc) gtk_tree_store_sortable_init,
178 tree_store_type = g_type_register_static (G_TYPE_OBJECT, "GtkTreeStore", &tree_store_info, 0);
180 g_type_add_interface_static (tree_store_type,
183 g_type_add_interface_static (tree_store_type,
184 GTK_TYPE_TREE_DRAG_SOURCE,
186 g_type_add_interface_static (tree_store_type,
187 GTK_TYPE_TREE_DRAG_DEST,
189 g_type_add_interface_static (tree_store_type,
190 GTK_TYPE_TREE_SORTABLE,
195 return tree_store_type;
199 gtk_tree_store_class_init (GtkTreeStoreClass *class)
201 GObjectClass *object_class;
203 parent_class = g_type_class_peek_parent (class);
204 object_class = (GObjectClass *) class;
206 object_class->finalize = gtk_tree_store_finalize;
210 gtk_tree_store_tree_model_init (GtkTreeModelIface *iface)
212 iface->get_flags = gtk_tree_store_get_flags;
213 iface->get_n_columns = gtk_tree_store_get_n_columns;
214 iface->get_column_type = gtk_tree_store_get_column_type;
215 iface->get_iter = gtk_tree_store_get_iter;
216 iface->get_path = gtk_tree_store_get_path;
217 iface->get_value = gtk_tree_store_get_value;
218 iface->iter_next = gtk_tree_store_iter_next;
219 iface->iter_children = gtk_tree_store_iter_children;
220 iface->iter_has_child = gtk_tree_store_iter_has_child;
221 iface->iter_n_children = gtk_tree_store_iter_n_children;
222 iface->iter_nth_child = gtk_tree_store_iter_nth_child;
223 iface->iter_parent = gtk_tree_store_iter_parent;
227 gtk_tree_store_drag_source_init (GtkTreeDragSourceIface *iface)
229 iface->drag_data_delete = gtk_tree_store_drag_data_delete;
230 iface->drag_data_get = gtk_tree_store_drag_data_get;
234 gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface)
236 iface->drag_data_received = gtk_tree_store_drag_data_received;
237 iface->row_drop_possible = gtk_tree_store_row_drop_possible;
241 gtk_tree_store_sortable_init (GtkTreeSortableIface *iface)
243 iface->get_sort_column_id = gtk_tree_store_get_sort_column_id;
244 iface->set_sort_column_id = gtk_tree_store_set_sort_column_id;
245 iface->set_sort_func = gtk_tree_store_set_sort_func;
246 iface->set_default_sort_func = gtk_tree_store_set_default_sort_func;
247 iface->has_default_sort_func = gtk_tree_store_has_default_sort_func;
251 gtk_tree_store_init (GtkTreeStore *tree_store)
253 tree_store->root = g_node_new (NULL);
256 tree_store->stamp = g_random_int ();
258 while (tree_store->stamp == 0);
259 tree_store->sort_list = NULL;
260 tree_store->sort_column_id = -2;
264 * gtk_tree_store_new:
265 * @n_columns: number of columns in the tree store
266 * @Varargs: all #GType types for the columns, from first to last
268 * Creates a new tree store as with @n_columns columns each of the types passed
269 * in. As an example, gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
270 * GDK_TYPE_PIXBUF); will create a new GtkTreeStore with three columns, of type
271 * int, string and GDkPixbuf respectively.
273 * Return value: a new #GtkTreeStore
276 gtk_tree_store_new (gint n_columns,
279 GtkTreeStore *retval;
283 g_return_val_if_fail (n_columns > 0, NULL);
285 retval = GTK_TREE_STORE (g_object_new (GTK_TYPE_TREE_STORE, NULL));
286 gtk_tree_store_set_n_columns (retval, n_columns);
288 va_start (args, n_columns);
290 for (i = 0; i < n_columns; i++)
292 GType type = va_arg (args, GType);
293 if (! _gtk_tree_data_list_check_type (type))
295 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (type));
296 g_object_unref (G_OBJECT (retval));
299 gtk_tree_store_set_column_type (retval, i, type);
306 * gtk_tree_store_newv:
307 * @n_columns: number of columns in the tree store
308 * @types: an array of #GType types for the columns, from first to last
310 * Non vararg creation function. Used primarily by language bindings.
312 * Return value: a new #GtkTreeStore
315 gtk_tree_store_newv (gint n_columns,
318 GtkTreeStore *retval;
321 g_return_val_if_fail (n_columns > 0, NULL);
323 retval = GTK_TREE_STORE (g_object_new (GTK_TYPE_TREE_STORE, NULL));
324 gtk_tree_store_set_n_columns (retval, n_columns);
326 for (i = 0; i < n_columns; i++)
328 if (! _gtk_tree_data_list_check_type (types[i]))
330 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (types[i]));
331 g_object_unref (G_OBJECT (retval));
334 gtk_tree_store_set_column_type (retval, i, types[i]);
341 gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
346 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
348 if (tree_store->n_columns == n_columns)
351 new_columns = g_new0 (GType, n_columns);
352 if (tree_store->column_headers)
354 /* copy the old header orders over */
355 if (n_columns >= tree_store->n_columns)
356 memcpy (new_columns, tree_store->column_headers, tree_store->n_columns * sizeof (gchar *));
358 memcpy (new_columns, tree_store->column_headers, n_columns * sizeof (GType));
360 g_free (tree_store->column_headers);
363 if (tree_store->sort_list)
364 _gtk_tree_data_list_header_free (tree_store->sort_list);
366 tree_store->sort_list = _gtk_tree_data_list_header_new (n_columns, tree_store->column_headers);
368 tree_store->column_headers = new_columns;
369 tree_store->n_columns = n_columns;
373 * gtk_tree_store_set_column_type:
374 * @tree_store: a #GtkTreeStore
375 * @column: column number
376 * @type: type of the data to be stored in @column
378 * Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
379 * %G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
380 * %G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
381 * subclasses of those types such as %GDK_TYPE_PIXBUF.
385 gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
389 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
390 g_return_if_fail (column >=0 && column < tree_store->n_columns);
391 if (!_gtk_tree_data_list_check_type (type))
393 g_warning ("%s: Invalid type %s passed to gtk_tree_store_new_with_types\n", G_STRLOC, g_type_name (type));
396 tree_store->column_headers[column] = type;
400 node_free (GNode *node, gpointer data)
402 _gtk_tree_data_list_free (node->data, (GType*)data);
406 gtk_tree_store_finalize (GObject *object)
408 GtkTreeStore *tree_store = GTK_TREE_STORE (object);
410 g_node_children_foreach (tree_store->root, G_TRAVERSE_LEAFS, node_free, tree_store->column_headers);
411 _gtk_tree_data_list_header_free (tree_store->sort_list);
412 g_free (tree_store->column_headers);
414 if (tree_store->default_sort_destroy)
416 (* tree_store->default_sort_destroy) (tree_store->default_sort_data);
417 tree_store->default_sort_destroy = NULL;
418 tree_store->default_sort_data = NULL;
421 (* parent_class->finalize) (object);
424 /* fulfill the GtkTreeModel requirements */
425 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node. However,
426 * it is not visible to the tree or to the user., and the path "0" refers to the
427 * first child of GtkTreeStore::root.
432 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
434 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
436 return GTK_TREE_MODEL_ITERS_PERSIST;
440 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
442 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
444 return GTK_TREE_STORE (tree_model)->n_columns;
448 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
451 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), G_TYPE_INVALID);
452 g_return_val_if_fail (index < GTK_TREE_STORE (tree_model)->n_columns &&
453 index >= 0, G_TYPE_INVALID);
455 return GTK_TREE_STORE (tree_model)->column_headers[index];
459 gtk_tree_store_get_iter (GtkTreeModel *tree_model,
463 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
468 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
470 indices = gtk_tree_path_get_indices (path);
471 depth = gtk_tree_path_get_depth (path);
473 g_return_val_if_fail (depth > 0, FALSE);
475 parent.stamp = tree_store->stamp;
476 parent.user_data = tree_store->root;
478 if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[0]))
481 for (i = 1; i < depth; i++)
484 if (! gtk_tree_model_iter_nth_child (tree_model, iter, &parent, indices[i]))
492 gtk_tree_store_get_path (GtkTreeModel *tree_model,
499 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), NULL);
500 g_return_val_if_fail (iter != NULL, NULL);
501 g_return_val_if_fail (iter->user_data != NULL, NULL);
502 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, NULL);
504 validate_tree ((GtkTreeStore*)tree_model);
506 if (G_NODE (iter->user_data)->parent == NULL &&
507 G_NODE (iter->user_data) == GTK_TREE_STORE (tree_model)->root)
508 return gtk_tree_path_new ();
509 g_assert (G_NODE (iter->user_data)->parent != NULL);
511 if (G_NODE (iter->user_data)->parent == G_NODE (GTK_TREE_STORE (tree_model)->root))
513 retval = gtk_tree_path_new ();
514 tmp_node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
518 GtkTreeIter tmp_iter = *iter;
520 tmp_iter.user_data = G_NODE (iter->user_data)->parent;
522 retval = gtk_tree_store_get_path (tree_model,
524 tmp_node = G_NODE (iter->user_data)->parent->children;
530 if (tmp_node == NULL)
532 gtk_tree_path_free (retval);
536 for (; tmp_node; tmp_node = tmp_node->next)
538 if (tmp_node == G_NODE (iter->user_data))
543 if (tmp_node == NULL)
545 /* We couldn't find node, meaning it's prolly not ours */
546 /* Perhaps I should do a g_return_if_fail here. */
547 gtk_tree_path_free (retval);
551 gtk_tree_path_append_index (retval, i);
558 gtk_tree_store_get_value (GtkTreeModel *tree_model,
563 GtkTreeDataList *list;
564 gint tmp_column = column;
566 g_return_if_fail (GTK_IS_TREE_STORE (tree_model));
567 g_return_if_fail (iter != NULL);
568 g_return_if_fail (column < GTK_TREE_STORE (tree_model)->n_columns);
570 list = G_NODE (iter->user_data)->data;
572 while (tmp_column-- > 0 && list)
577 _gtk_tree_data_list_node_to_value (list,
578 GTK_TREE_STORE (tree_model)->column_headers[column],
583 /* We want to return an initialized but empty (default) value */
584 g_value_init (value, GTK_TREE_STORE (tree_model)->column_headers[column]);
589 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
592 g_return_val_if_fail (iter->user_data != NULL, FALSE);
594 if (G_NODE (iter->user_data)->next)
596 iter->user_data = G_NODE (iter->user_data)->next;
604 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
610 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
613 children = G_NODE (parent->user_data)->children;
615 children = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
619 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
620 iter->user_data = children;
628 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
631 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
632 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
633 g_return_val_if_fail (iter->user_data != NULL, FALSE);
635 return G_NODE (iter->user_data)->children != NULL;
639 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
645 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
646 g_return_val_if_fail (iter == NULL || iter->user_data != NULL, FALSE);
649 node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
651 node = G_NODE (iter->user_data)->children;
663 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
671 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
672 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
675 parent_node = GTK_TREE_STORE (tree_model)->root;
677 parent_node = parent->user_data;
679 child = g_node_nth_child (parent_node, n);
683 iter->user_data = child;
684 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
692 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
698 g_return_val_if_fail (iter != NULL, FALSE);
699 g_return_val_if_fail (iter->user_data != NULL, FALSE);
701 parent = G_NODE (child->user_data)->parent;
703 g_assert (parent != NULL);
705 if (parent != GTK_TREE_STORE (tree_model)->root)
707 iter->user_data = parent;
708 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
716 /* Does not emit a signal */
718 gtk_tree_store_real_set_value (GtkTreeStore *tree_store,
723 GtkTreeDataList *list;
724 GtkTreeDataList *prev;
725 GtkTreePath *path = NULL;
726 GValue real_value = {0, };
727 gboolean converted = FALSE;
728 gint orig_column = column;
729 gboolean retval = FALSE;
731 if (! g_type_is_a (G_VALUE_TYPE (value), tree_store->column_headers[column]))
733 if (! (g_value_type_compatible (G_VALUE_TYPE (value), tree_store->column_headers[column]) &&
734 g_value_type_compatible (tree_store->column_headers[column], G_VALUE_TYPE (value))))
736 g_warning ("%s: Unable to convert from %s to %s\n",
738 g_type_name (G_VALUE_TYPE (value)),
739 g_type_name (tree_store->column_headers[column]));
742 if (!g_value_transform (value, &real_value))
744 g_warning ("%s: Unable to make conversion from %s to %s\n",
746 g_type_name (G_VALUE_TYPE (value)),
747 g_type_name (tree_store->column_headers[column]));
748 g_value_unset (&real_value);
754 prev = list = G_NODE (iter->user_data)->data;
756 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
763 _gtk_tree_data_list_value_to_node (list, &real_value);
765 _gtk_tree_data_list_value_to_node (list, value);
767 gtk_tree_path_free (path);
769 g_value_unset (&real_value);
778 if (G_NODE (iter->user_data)->data == NULL)
780 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
785 list = prev->next = _gtk_tree_data_list_alloc ();
791 list->next = _gtk_tree_data_list_alloc ();
797 _gtk_tree_data_list_value_to_node (list, &real_value);
799 _gtk_tree_data_list_value_to_node (list, value);
801 gtk_tree_path_free (path);
803 g_value_unset (&real_value);
805 if (GTK_TREE_STORE_IS_SORTED (tree_store))
806 gtk_tree_store_sort_iter_changed (tree_store, iter, orig_column);
812 * gtk_tree_store_set_value:
813 * @tree_store: a #GtkTreeStore
814 * @iter: A valid #GtkTreeIter for the row being modified
815 * @column: column number to modify
816 * @value: new value for the cell
818 * Sets the data in the cell specified by @iter and @column.
819 * The type of @value must be convertible to the type of the
824 gtk_tree_store_set_value (GtkTreeStore *tree_store,
829 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
830 g_return_if_fail (VALID_ITER (iter, tree_store));
831 g_return_if_fail (column >= 0 && column < tree_store->n_columns);
832 g_return_if_fail (G_IS_VALUE (value));
834 if (gtk_tree_store_real_set_value (tree_store, iter, column, value))
838 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
839 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
840 gtk_tree_path_free (path);
845 * gtk_tree_store_set_valist:
846 * @tree_store: A #GtkTreeStore
847 * @iter: A valid #GtkTreeIter for the row being modified
848 * @var_args: va_list of column/value pairs
850 * See @gtk_tree_store_set; this version takes a va_list for
851 * use by language bindings.
855 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
860 gboolean emit_signal = FALSE;
862 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
863 g_return_if_fail (VALID_ITER (iter, tree_store));
865 column = va_arg (var_args, gint);
869 GValue value = { 0, };
872 if (column >= tree_store->n_columns)
874 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
877 g_value_init (&value, tree_store->column_headers[column]);
879 G_VALUE_COLLECT (&value, var_args, 0, &error);
882 g_warning ("%s: %s", G_STRLOC, error);
885 /* we purposely leak the value here, it might not be
886 * in a sane state if an error condition occoured
891 emit_signal = gtk_tree_store_real_set_value (tree_store,
894 &value) || emit_signal;
896 g_value_unset (&value);
898 column = va_arg (var_args, gint);
904 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
905 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
906 gtk_tree_path_free (path);
911 * gtk_tree_store_set:
912 * @tree_store: A #GtkTreeStore
913 * @iter: A valid #GtkTreeIter for the row being modified
914 * @Varargs: pairs of column number and value, terminated with -1
916 * Sets the value of one or more cells in the row referenced by @iter.
917 * The variable argument list should contain integer column numbers,
918 * each column number followed by the value to be set. For example,
919 * The list is terminated by a -1. For example, to set column 0 with type
920 * %G_TYPE_STRING to "Foo", you would write gtk_tree_store_set (store, iter,
924 gtk_tree_store_set (GtkTreeStore *tree_store,
930 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
931 g_return_if_fail (VALID_ITER (iter, tree_store));
933 va_start (var_args, iter);
934 gtk_tree_store_set_valist (tree_store, iter, var_args);
939 * gtk_tree_store_remove:
940 * @tree_store: A #GtkTreeStore
941 * @iter: A valid #GtkTreeIter
943 * Removes @iter from @tree_store. After being removed, @iter is set to the
944 * next valid row at that level, or invalidated if it previeously pointed to the
948 gtk_tree_store_remove (GtkTreeStore *tree_store,
952 GtkTreeIter new_iter = {0,};
956 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
957 g_return_if_fail (VALID_ITER (iter, tree_store));
959 parent = G_NODE (iter->user_data)->parent;
961 g_assert (parent != NULL);
962 next_node = G_NODE (iter->user_data)->next;
964 if (G_NODE (iter->user_data)->data)
965 _gtk_tree_data_list_free ((GtkTreeDataList *) G_NODE (iter->user_data)->data,
966 tree_store->column_headers);
968 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
969 g_node_destroy (G_NODE (iter->user_data));
971 gtk_tree_model_row_deleted (GTK_TREE_MODEL (tree_store), path);
973 if (parent != G_NODE (tree_store->root))
976 if (parent->children == NULL)
978 gtk_tree_path_up (path);
980 new_iter.stamp = tree_store->stamp;
981 new_iter.user_data = parent;
982 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &new_iter);
985 gtk_tree_path_free (path);
987 /* revalidate iter */
988 if (next_node != NULL)
990 iter->stamp = tree_store->stamp;
991 iter->user_data = next_node;
996 iter->user_data = NULL;
1001 * gtk_tree_store_insert:
1002 * @tree_store: A #GtkListStore
1003 * @iter: An unset #GtkTreeIter to set to the new row
1004 * @parent: A valid #GtkTreeIter, or %NULL
1005 * @position: position to insert the new row
1007 * Creates a new row at @position. If parent is non-NULL, then the row will be
1008 * made a child of @parent. Otherwise, the row will be created at the toplevel.
1009 * If @position is larger than the number of rows at that level, then the new
1010 * row will be inserted to the end of the list. @iter will be changed to point
1011 * to this new row. The row will be empty before this function is called. To
1012 * fill in values, you need to call @gtk_list_store_set or
1013 * @gtk_list_store_set_value.
1017 gtk_tree_store_insert (GtkTreeStore *tree_store,
1019 GtkTreeIter *parent,
1025 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1027 g_return_if_fail (VALID_ITER (parent, tree_store));
1030 parent_node = parent->user_data;
1032 parent_node = tree_store->root;
1034 iter->stamp = tree_store->stamp;
1035 iter->user_data = g_node_new (NULL);
1036 g_node_insert (parent_node, position, G_NODE (iter->user_data));
1038 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1039 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1041 gtk_tree_path_free (path);
1043 validate_tree ((GtkTreeStore*)tree_store);
1047 * gtk_tree_store_insert_before:
1048 * @tree_store: A #GtkTreeStore
1049 * @iter: An unset #GtkTreeIter to set to the new row
1050 * @parent: A valid #GtkTreeIter, or %NULL
1051 * @sibling: A valid #GtkTreeIter, or %NULL
1053 * Inserts a new row before @sibling. If @sibling is %NULL, then the row will
1054 * be appended to the beginning of the @parent 's children. If @parent and
1055 * @sibling are %NULL, then the row will be appended to the toplevel. If both
1056 * @sibling and @parent are set, then @parent must be the parent of @sibling.
1057 * When @sibling is set, @parent is optional.
1059 * @iter will be changed to point to this new row. The row will be empty after
1060 * this function is called. To fill in values, you need to call
1061 * @gtk_tree_store_set or @gtk_tree_store_set_value.
1065 gtk_tree_store_insert_before (GtkTreeStore *tree_store,
1067 GtkTreeIter *parent,
1068 GtkTreeIter *sibling)
1071 GNode *parent_node = NULL;
1074 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1075 g_return_if_fail (iter != NULL);
1077 g_return_if_fail (VALID_ITER (parent, tree_store));
1078 if (sibling != NULL)
1079 g_return_if_fail (VALID_ITER (sibling, tree_store));
1081 new_node = g_node_new (NULL);
1083 if (parent == NULL && sibling == NULL)
1084 parent_node = tree_store->root;
1085 else if (parent == NULL)
1086 parent_node = G_NODE (sibling->user_data)->parent;
1087 else if (sibling == NULL)
1088 parent_node = G_NODE (parent->user_data);
1091 g_return_if_fail (G_NODE (sibling->user_data)->parent == G_NODE (parent->user_data));
1092 parent_node = G_NODE (parent->user_data);
1095 g_node_insert_before (parent_node,
1096 sibling ? G_NODE (sibling->user_data) : NULL,
1099 iter->stamp = tree_store->stamp;
1100 iter->user_data = new_node;
1102 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1103 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1105 gtk_tree_path_free (path);
1107 validate_tree ((GtkTreeStore*)tree_store);
1111 * gtk_tree_store_insert_after:
1112 * @tree_store: A #GtkTreeStore
1113 * @iter: An unset #GtkTreeIter to set to the new row
1114 * @parent: A valid #GtkTreeIter, or %NULL
1115 * @sibling: A valid #GtkTreeIter, or %NULL
1117 * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
1118 * prepended to the beginning of the @parent 's children. If @parent and
1119 * @sibling are %NULL, then the row will be prepended to the toplevel. If both
1120 * @sibling and @parent are set, then @parent must be the parent of @sibling.
1121 * When @sibling is set, @parent is optional.
1123 * @iter will be changed to point to this new row. The row will be empty after
1124 * this function is called. To fill in values, you need to call
1125 * @gtk_tree_store_set or @gtk_tree_store_set_value.
1129 gtk_tree_store_insert_after (GtkTreeStore *tree_store,
1131 GtkTreeIter *parent,
1132 GtkTreeIter *sibling)
1138 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1139 g_return_if_fail (iter != NULL);
1141 g_return_if_fail (VALID_ITER (parent, tree_store));
1142 if (sibling != NULL)
1143 g_return_if_fail (VALID_ITER (sibling, tree_store));
1145 new_node = g_node_new (NULL);
1147 if (parent == NULL && sibling == NULL)
1148 parent_node = tree_store->root;
1149 else if (parent == NULL)
1150 parent_node = G_NODE (sibling->user_data)->parent;
1151 else if (sibling == NULL)
1152 parent_node = G_NODE (parent->user_data);
1155 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
1156 G_NODE (parent->user_data));
1157 parent_node = G_NODE (parent->user_data);
1161 g_node_insert_after (parent_node,
1162 sibling ? G_NODE (sibling->user_data) : NULL,
1165 iter->stamp = tree_store->stamp;
1166 iter->user_data = new_node;
1168 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1169 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1171 gtk_tree_path_free (path);
1173 validate_tree ((GtkTreeStore*)tree_store);
1177 * gtk_tree_store_prepend:
1178 * @tree_store: A #GtkTreeStore
1179 * @iter: An unset #GtkTreeIter to set to the prepended row
1180 * @parent: A valid #GtkTreeIter, or %NULL
1182 * Prepends a new row to @tree_store. If @parent is non-NULL, then it will prepend
1183 * the new row before the last child of @parent, otherwise it will prepend a row
1184 * to the top level. @iter will be changed to point to this new row. The row
1185 * will be empty after this function is called. To fill in values, you need to
1186 * call @gtk_tree_store_set or @gtk_tree_store_set_value.
1189 gtk_tree_store_prepend (GtkTreeStore *tree_store,
1191 GtkTreeIter *parent)
1195 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1196 g_return_if_fail (iter != NULL);
1198 g_return_if_fail (VALID_ITER (parent, tree_store));
1201 parent_node = tree_store->root;
1203 parent_node = parent->user_data;
1205 if (parent_node->children == NULL)
1209 iter->stamp = tree_store->stamp;
1210 iter->user_data = g_node_new (NULL);
1212 g_node_prepend (parent_node, iter->user_data);
1214 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1215 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1217 if (parent_node != tree_store->root)
1219 gtk_tree_path_up (path);
1220 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1222 gtk_tree_path_free (path);
1226 gtk_tree_store_insert_after (tree_store, iter, parent, NULL);
1229 validate_tree ((GtkTreeStore*)tree_store);
1233 * gtk_tree_store_append:
1234 * @tree_store: A #GtkTreeStore
1235 * @iter: An unset #GtkTreeIter to set to the appended row
1236 * @parent: A valid #GtkTreeIter, or %NULL
1238 * Appends a new row to @tree_store. If @parent is non-NULL, then it will append the
1239 * new row after the last child of @parent, otherwise it will append a row to
1240 * the top level. @iter will be changed to point to this new row. The row will
1241 * be empty after this function is called. To fill in values, you need to call
1242 * @gtk_tree_store_set or @gtk_tree_store_set_value.
1245 gtk_tree_store_append (GtkTreeStore *tree_store,
1247 GtkTreeIter *parent)
1251 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1252 g_return_if_fail (iter != NULL);
1255 g_return_if_fail (VALID_ITER (parent, tree_store));
1258 parent_node = tree_store->root;
1260 parent_node = parent->user_data;
1262 if (parent_node->children == NULL)
1266 iter->stamp = tree_store->stamp;
1267 iter->user_data = g_node_new (NULL);
1269 g_node_append (parent_node, G_NODE (iter->user_data));
1271 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1272 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1274 if (parent_node != tree_store->root)
1276 gtk_tree_path_up (path);
1277 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1279 gtk_tree_path_free (path);
1283 gtk_tree_store_insert_before (tree_store, iter, parent, NULL);
1286 validate_tree ((GtkTreeStore*)tree_store);
1290 * gtk_tree_store_is_ancestor:
1291 * @tree_store: A #GtkTreeStore
1292 * @iter: A valid #GtkTreeIter
1293 * @descendant: A valid #GtkTreeIter
1295 * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
1296 * parent (or grandparent or great-grandparent) of @descendant.
1298 * Return value: %TRUE, if @iter is an ancestor of @descendant
1301 gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
1303 GtkTreeIter *descendant)
1305 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1306 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1307 g_return_val_if_fail (VALID_ITER (descendant, tree_store), FALSE);
1309 return g_node_is_ancestor (G_NODE (iter->user_data),
1310 G_NODE (descendant->user_data));
1315 * gtk_tree_store_iter_depth:
1316 * @tree_store: A #GtkTreeStore
1317 * @iter: A valid #GtkTreeIter
1319 * Returns the depth of @iter. This will be 0 for anything on the root level, 1
1320 * for anything down a level, etc.
1322 * Return value: The depth of @iter
1325 gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
1328 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), 0);
1329 g_return_val_if_fail (VALID_ITER (iter, tree_store), 0);
1331 return g_node_depth (G_NODE (iter->user_data)) - 1;
1336 * gtk_tree_store_clear:
1337 * @tree_store: @ #GtkTreeStore
1339 * Removes all rows from @tree_store
1342 gtk_tree_store_clear (GtkTreeStore *tree_store)
1346 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1348 while (G_NODE (tree_store->root)->children)
1350 iter.stamp = tree_store->stamp;
1351 iter.user_data = G_NODE (tree_store->root)->children;
1352 gtk_tree_store_remove (tree_store, &iter);
1360 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1365 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1367 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_source),
1371 gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1382 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1384 GtkSelectionData *selection_data)
1386 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1388 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1389 * target, because the default handler does it for us, but
1390 * we do anyway for the convenience of someone maybe overriding the
1394 if (gtk_selection_data_set_tree_row (selection_data,
1395 GTK_TREE_MODEL (drag_source),
1402 /* FIXME handle text targets at least. */
1409 copy_node_data (GtkTreeStore *tree_store,
1410 GtkTreeIter *src_iter,
1411 GtkTreeIter *dest_iter)
1413 GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
1414 GtkTreeDataList *copy_head = NULL;
1415 GtkTreeDataList *copy_prev = NULL;
1416 GtkTreeDataList *copy_iter = NULL;
1423 copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->column_headers[col]);
1425 if (copy_head == NULL)
1426 copy_head = copy_iter;
1429 copy_prev->next = copy_iter;
1431 copy_prev = copy_iter;
1437 G_NODE (dest_iter->user_data)->data = copy_head;
1439 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
1440 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, dest_iter);
1441 gtk_tree_path_free (path);
1445 recursive_node_copy (GtkTreeStore *tree_store,
1446 GtkTreeIter *src_iter,
1447 GtkTreeIter *dest_iter)
1450 GtkTreeModel *model;
1452 model = GTK_TREE_MODEL (tree_store);
1454 copy_node_data (tree_store, src_iter, dest_iter);
1456 if (gtk_tree_model_iter_children (model,
1460 /* Need to create children and recurse. Note our
1461 * dependence on persistent iterators here.
1467 /* Gee, a really slow algorithm... ;-) FIXME */
1468 gtk_tree_store_append (tree_store,
1472 recursive_node_copy (tree_store, &child, ©);
1474 while (gtk_tree_model_iter_next (model, &child));
1479 gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
1481 GtkSelectionData *selection_data)
1483 GtkTreeModel *tree_model;
1484 GtkTreeStore *tree_store;
1485 GtkTreeModel *src_model = NULL;
1486 GtkTreePath *src_path = NULL;
1487 gboolean retval = FALSE;
1489 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
1491 tree_model = GTK_TREE_MODEL (drag_dest);
1492 tree_store = GTK_TREE_STORE (drag_dest);
1494 validate_tree (tree_store);
1496 if (gtk_selection_data_get_tree_row (selection_data,
1499 src_model == tree_model)
1501 /* Copy the given row to a new position */
1502 GtkTreeIter src_iter;
1503 GtkTreeIter dest_iter;
1506 if (!gtk_tree_model_get_iter (src_model,
1513 /* Get the path to insert _after_ (dest is the path to insert _before_) */
1514 prev = gtk_tree_path_copy (dest);
1516 if (!gtk_tree_path_prev (prev))
1518 GtkTreeIter dest_parent;
1519 GtkTreePath *parent;
1520 GtkTreeIter *dest_parent_p;
1522 /* dest was the first spot at the current depth; which means
1523 * we are supposed to prepend.
1526 /* Get the parent, NULL if parent is the root */
1527 dest_parent_p = NULL;
1528 parent = gtk_tree_path_copy (dest);
1529 if (gtk_tree_path_up (parent))
1531 gtk_tree_model_get_iter (tree_model,
1534 dest_parent_p = &dest_parent;
1536 gtk_tree_path_free (parent);
1539 gtk_tree_store_prepend (GTK_TREE_STORE (tree_model),
1547 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model),
1551 GtkTreeIter tmp_iter = dest_iter;
1552 gtk_tree_store_insert_after (GTK_TREE_STORE (tree_model),
1561 gtk_tree_path_free (prev);
1563 /* If we succeeded in creating dest_iter, walk src_iter tree branch,
1564 * duplicating it below dest_iter.
1569 recursive_node_copy (tree_store,
1576 /* FIXME maybe add some data targets eventually, or handle text
1577 * targets in the simple case.
1585 gtk_tree_path_free (src_path);
1591 gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
1592 GtkTreeModel *src_model,
1593 GtkTreePath *src_path,
1594 GtkTreePath *dest_path)
1596 /* can only drag to ourselves */
1597 if (src_model != GTK_TREE_MODEL (drag_dest))
1600 /* Can't drop into ourself. */
1601 if (gtk_tree_path_is_ancestor (src_path,
1605 /* Can't drop if dest_path's parent doesn't exist */
1608 GtkTreePath *tmp = gtk_tree_path_copy (dest_path);
1610 /* if we can't go up, we know the parent exists, the root
1613 if (gtk_tree_path_up (tmp))
1615 if (!gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_dest),
1619 gtk_tree_path_free (tmp);
1625 gtk_tree_path_free (tmp);
1628 /* Can otherwise drop anywhere. */
1633 typedef struct _SortTuple
1640 gtk_tree_store_compare_func (gconstpointer a,
1644 GtkTreeStore *tree_store = user_data;
1647 GtkTreeIterCompareFunc func;
1654 if (tree_store->sort_column_id != -1)
1656 GtkTreeDataSortHeader *header;
1658 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1659 tree_store->sort_column_id);
1660 g_return_val_if_fail (header != NULL, 0);
1661 g_return_val_if_fail (header->func != NULL, 0);
1663 func = header->func;
1664 data = header->data;
1668 g_return_val_if_fail (tree_store->default_sort_func != NULL, 0);
1669 func = tree_store->default_sort_func;
1670 data = tree_store->default_sort_data;
1673 node_a = ((SortTuple *) a)->node;
1674 node_b = ((SortTuple *) b)->node;
1676 iter_a.stamp = tree_store->stamp;
1677 iter_a.user_data = node_a;
1678 iter_b.stamp = tree_store->stamp;
1679 iter_b.user_data = node_b;
1681 retval = (* func) (GTK_TREE_MODEL (user_data), &iter_a, &iter_b, data);
1683 if (tree_store->order == GTK_SORT_DESCENDING)
1687 else if (retval < 0)
1694 gtk_tree_store_sort_helper (GtkTreeStore *tree_store,
1707 node = parent->children;
1708 if (node == NULL || node->next == NULL)
1711 g_assert (GTK_TREE_STORE_IS_SORTED (tree_store));
1714 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1717 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), list_length);
1720 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1725 tuple.node = tmp_node;
1726 g_array_append_val (sort_array, tuple);
1730 g_array_sort_with_data (sort_array, gtk_tree_store_compare_func, tree_store);
1732 for (i = 0; i < list_length - 1; i++)
1734 g_array_index (sort_array, SortTuple, i).node->next =
1735 g_array_index (sort_array, SortTuple, i + 1).node;
1736 g_array_index (sort_array, SortTuple, i + 1).node->prev =
1737 g_array_index (sort_array, SortTuple, i).node;
1739 g_array_index (sort_array, SortTuple, list_length - 1).node->next = NULL;
1740 g_array_index (sort_array, SortTuple, 0).node->prev = NULL;
1741 parent->children = g_array_index (sort_array, SortTuple, 0).node;
1743 /* Let the world know about our new order */
1744 new_order = g_new (gint, list_length);
1745 for (i = 0; i < list_length; i++)
1746 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1748 iter.stamp = tree_store->stamp;
1749 iter.user_data = parent;
1750 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &iter);
1751 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
1752 path, &iter, new_order);
1753 gtk_tree_path_free (path);
1755 g_array_free (sort_array, TRUE);
1759 for (tmp_node = parent->children; tmp_node; tmp_node = tmp_node->next)
1761 if (tmp_node->children)
1762 gtk_tree_store_sort_helper (tree_store, tmp_node, TRUE);
1768 gtk_tree_store_sort (GtkTreeStore *tree_store)
1770 if (tree_store->sort_column_id != -1)
1772 GtkTreeDataSortHeader *header = NULL;
1774 header = _gtk_tree_data_list_get_header (tree_store->sort_list, tree_store->sort_column_id);
1776 /* We want to make sure that we have a function */
1777 g_return_if_fail (header != NULL);
1778 g_return_if_fail (header->func != NULL);
1782 g_return_if_fail (tree_store->default_sort_func != NULL);
1785 gtk_tree_store_sort_helper (tree_store, G_NODE (tree_store->root), TRUE);
1789 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
1796 GtkTreePath *tmp_path;
1797 GtkTreeIter tmp_iter;
1805 GtkTreeIterCompareFunc func;
1808 g_return_if_fail (G_NODE (iter->user_data)->parent != NULL);
1810 tmp_iter.stamp = tree_store->stamp;
1811 if (tree_store->sort_column_id != -1)
1813 GtkTreeDataSortHeader *header;
1814 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1815 tree_store->sort_column_id);
1816 g_return_if_fail (header != NULL);
1817 g_return_if_fail (header->func != NULL);
1818 func = header->func;
1819 data = header->data;
1823 g_return_if_fail (tree_store->default_sort_func != NULL);
1824 func = tree_store->default_sort_func;
1825 data = tree_store->default_sort_data;
1828 /* If it's the built in function, we don't sort. */
1829 if (func == gtk_tree_data_list_compare_func &&
1830 tree_store->sort_column_id != column)
1834 node = G_NODE (iter->user_data)->parent->children;
1835 /* First we find the iter, its prev, and its next */
1838 if (node == G_NODE (iter->user_data))
1843 g_assert (node != NULL);
1848 /* Check the common case, where we don't need to sort it moved. */
1851 tmp_iter.user_data = prev;
1852 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1857 tmp_iter.user_data = next;
1858 cmp_b = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1862 if (tree_store->order == GTK_SORT_DESCENDING)
1875 if (prev == NULL && cmp_b <= 0)
1877 else if (next == NULL && cmp_a <= 0)
1879 else if (prev != NULL && next != NULL &&
1880 cmp_a <= 0 && cmp_b <= 0)
1883 /* We actually need to sort it */
1884 /* First, remove the old link. */
1889 node->parent->children = next;
1896 /* FIXME: as an optimization, we can potentially start at next */
1898 node = node->parent->children;
1900 tmp_iter.user_data = node;
1901 if (tree_store->order == GTK_SORT_DESCENDING)
1902 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1904 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1906 while ((node->next) && (cmp_a > 0))
1911 tmp_iter.user_data = node;
1912 if (tree_store->order == GTK_SORT_DESCENDING)
1913 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1915 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1918 if ((!node->next) && (cmp_a > 0))
1920 node->next = G_NODE (iter->user_data);
1921 node->next->prev = node;
1925 prev->next = G_NODE (iter->user_data);
1926 prev->next->prev = prev;
1927 G_NODE (iter->user_data)->next = node;
1928 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
1932 G_NODE (iter->user_data)->next = G_NODE (iter->user_data)->parent->children;
1933 G_NODE (iter->user_data)->parent->children = G_NODE (iter->user_data);
1936 /* Emit the reordered signal. */
1937 length = g_node_n_children (node->parent);
1938 new_order = g_new (int, length);
1939 if (old_location < new_location)
1940 for (i = 0; i < length; i++)
1942 if (i < old_location ||
1945 else if (i >= old_location &&
1947 new_order[i] = i + 1;
1948 else if (i == new_location)
1949 new_order[i] = old_location;
1952 for (i = 0; i < length; i++)
1954 if (i < new_location ||
1957 else if (i > new_location &&
1959 new_order[i] = i - 1;
1960 else if (i == new_location)
1961 new_order[i] = old_location;
1964 tmp_iter.user_data = node->parent;
1965 tmp_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &tmp_iter);
1967 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
1968 tmp_path, &tmp_iter,
1971 gtk_tree_path_free (tmp_path);
1977 gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
1978 gint *sort_column_id,
1981 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
1983 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
1985 if (tree_store->sort_column_id == -1)
1989 * sort_column_id = tree_store->sort_column_id;
1991 * order = tree_store->order;
1997 gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
1998 gint sort_column_id,
2001 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2003 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2006 if ((tree_store->sort_column_id == sort_column_id) &&
2007 (tree_store->order == order))
2010 if (sort_column_id != -1)
2012 GtkTreeDataSortHeader *header = NULL;
2014 header = _gtk_tree_data_list_get_header (tree_store->sort_list, sort_column_id);
2016 /* We want to make sure that we have a function */
2017 g_return_if_fail (header != NULL);
2018 g_return_if_fail (header->func != NULL);
2022 g_return_if_fail (tree_store->default_sort_func != NULL);
2025 tree_store->sort_column_id = sort_column_id;
2026 tree_store->order = order;
2028 gtk_tree_store_sort (tree_store);
2030 gtk_tree_sortable_sort_column_changed (sortable);
2034 gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
2035 gint sort_column_id,
2036 GtkTreeIterCompareFunc func,
2038 GtkDestroyNotify destroy)
2040 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2041 GtkTreeDataSortHeader *header = NULL;
2044 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2045 g_return_if_fail (func != NULL);
2047 for (list = tree_store->sort_list; list; list = list->next)
2049 header = (GtkTreeDataSortHeader*) list->data;
2050 if (header->sort_column_id == sort_column_id)
2056 header = g_new0 (GtkTreeDataSortHeader, 1);
2057 header->sort_column_id = sort_column_id;
2058 tree_store->sort_list = g_list_append (tree_store->sort_list, header);
2061 if (header->destroy)
2062 (* header->destroy) (header->data);
2064 header->func = func;
2065 header->data = data;
2066 header->destroy = destroy;
2071 gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
2072 GtkTreeIterCompareFunc func,
2074 GtkDestroyNotify destroy)
2076 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2078 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2080 if (tree_store->default_sort_destroy)
2081 (* tree_store->default_sort_destroy) (tree_store->default_sort_data);
2083 tree_store->default_sort_func = func;
2084 tree_store->default_sort_data = data;
2085 tree_store->default_sort_destroy = destroy;
2089 gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable)
2091 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2093 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2095 return (tree_store->default_sort_func != NULL);
2099 validate_gnode (GNode* node)
2103 iter = node->children;
2104 while (iter != NULL)
2106 g_assert (iter->parent == node);
2108 g_assert (iter->prev->next == iter);
2109 validate_gnode (iter);