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 (column < GTK_TREE_STORE (tree_model)->n_columns);
617 list = G_NODE (iter->user_data)->data;
619 while (tmp_column-- > 0 && list)
624 _gtk_tree_data_list_node_to_value (list,
625 GTK_TREE_STORE (tree_model)->column_headers[column],
630 /* We want to return an initialized but empty (default) value */
631 g_value_init (value, GTK_TREE_STORE (tree_model)->column_headers[column]);
636 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
639 g_return_val_if_fail (iter->user_data != NULL, FALSE);
641 if (G_NODE (iter->user_data)->next)
643 iter->user_data = G_NODE (iter->user_data)->next;
651 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
657 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
660 children = G_NODE (parent->user_data)->children;
662 children = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
666 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
667 iter->user_data = children;
675 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
678 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
679 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->stamp, FALSE);
680 g_return_val_if_fail (iter->user_data != NULL, FALSE);
682 return G_NODE (iter->user_data)->children != NULL;
686 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
692 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), 0);
693 g_return_val_if_fail (iter == NULL || iter->user_data != NULL, FALSE);
696 node = G_NODE (GTK_TREE_STORE (tree_model)->root)->children;
698 node = G_NODE (iter->user_data)->children;
710 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
718 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_model), FALSE);
719 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
722 parent_node = GTK_TREE_STORE (tree_model)->root;
724 parent_node = parent->user_data;
726 child = g_node_nth_child (parent_node, n);
730 iter->user_data = child;
731 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
739 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
745 g_return_val_if_fail (iter != NULL, FALSE);
746 g_return_val_if_fail (iter->user_data != NULL, FALSE);
748 parent = G_NODE (child->user_data)->parent;
750 g_assert (parent != NULL);
752 if (parent != GTK_TREE_STORE (tree_model)->root)
754 iter->user_data = parent;
755 iter->stamp = GTK_TREE_STORE (tree_model)->stamp;
763 /* Does not emit a signal */
765 gtk_tree_store_real_set_value (GtkTreeStore *tree_store,
770 GtkTreeDataList *list;
771 GtkTreeDataList *prev;
772 GtkTreePath *path = NULL;
773 GValue real_value = {0, };
774 gboolean converted = FALSE;
775 gint orig_column = column;
776 gboolean retval = FALSE;
778 if (! g_type_is_a (G_VALUE_TYPE (value), tree_store->column_headers[column]))
780 if (! (g_value_type_compatible (G_VALUE_TYPE (value), tree_store->column_headers[column]) &&
781 g_value_type_compatible (tree_store->column_headers[column], G_VALUE_TYPE (value))))
783 g_warning ("%s: Unable to convert from %s to %s\n",
785 g_type_name (G_VALUE_TYPE (value)),
786 g_type_name (tree_store->column_headers[column]));
789 if (!g_value_transform (value, &real_value))
791 g_warning ("%s: Unable to make conversion from %s to %s\n",
793 g_type_name (G_VALUE_TYPE (value)),
794 g_type_name (tree_store->column_headers[column]));
795 g_value_unset (&real_value);
801 prev = list = G_NODE (iter->user_data)->data;
803 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
810 _gtk_tree_data_list_value_to_node (list, &real_value);
812 _gtk_tree_data_list_value_to_node (list, value);
814 gtk_tree_path_free (path);
816 g_value_unset (&real_value);
825 if (G_NODE (iter->user_data)->data == NULL)
827 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
832 list = prev->next = _gtk_tree_data_list_alloc ();
838 list->next = _gtk_tree_data_list_alloc ();
844 _gtk_tree_data_list_value_to_node (list, &real_value);
846 _gtk_tree_data_list_value_to_node (list, value);
849 gtk_tree_path_free (path);
851 g_value_unset (&real_value);
853 if (GTK_TREE_STORE_IS_SORTED (tree_store))
854 gtk_tree_store_sort_iter_changed (tree_store, iter, orig_column);
860 * gtk_tree_store_set_value:
861 * @tree_store: a #GtkTreeStore
862 * @iter: A valid #GtkTreeIter for the row being modified
863 * @column: column number to modify
864 * @value: new value for the cell
866 * Sets the data in the cell specified by @iter and @column.
867 * The type of @value must be convertible to the type of the
872 gtk_tree_store_set_value (GtkTreeStore *tree_store,
877 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
878 g_return_if_fail (VALID_ITER (iter, tree_store));
879 g_return_if_fail (column >= 0 && column < tree_store->n_columns);
880 g_return_if_fail (G_IS_VALUE (value));
882 if (gtk_tree_store_real_set_value (tree_store, iter, column, value))
886 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
887 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
888 gtk_tree_path_free (path);
893 * gtk_tree_store_set_valist:
894 * @tree_store: A #GtkTreeStore
895 * @iter: A valid #GtkTreeIter for the row being modified
896 * @var_args: <type>va_list</type> of column/value pairs
898 * See gtk_tree_store_set(); this version takes a <type>va_list</type> for
899 * use by language bindings.
903 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
908 gboolean emit_signal = FALSE;
910 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
911 g_return_if_fail (VALID_ITER (iter, tree_store));
913 column = va_arg (var_args, gint);
917 GValue value = { 0, };
920 if (column >= tree_store->n_columns)
922 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
925 g_value_init (&value, tree_store->column_headers[column]);
927 G_VALUE_COLLECT (&value, var_args, 0, &error);
930 g_warning ("%s: %s", G_STRLOC, error);
933 /* we purposely leak the value here, it might not be
934 * in a sane state if an error condition occoured
939 emit_signal = gtk_tree_store_real_set_value (tree_store,
942 &value) || emit_signal;
944 g_value_unset (&value);
946 column = va_arg (var_args, gint);
952 path = gtk_tree_model_get_path (GTK_TREE_MODEL (tree_store), iter);
953 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
954 gtk_tree_path_free (path);
959 * gtk_tree_store_set:
960 * @tree_store: A #GtkTreeStore
961 * @iter: A valid #GtkTreeIter for the row being modified
962 * @Varargs: pairs of column number and value, terminated with -1
964 * Sets the value of one or more cells in the row referenced by @iter.
965 * The variable argument list should contain integer column numbers,
966 * each column number followed by the value to be set.
967 * The list is terminated by a -1. For example, to set column 0 with type
968 * %G_TYPE_STRING to "Foo", you would write
969 * <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
972 gtk_tree_store_set (GtkTreeStore *tree_store,
978 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
979 g_return_if_fail (VALID_ITER (iter, tree_store));
981 va_start (var_args, iter);
982 gtk_tree_store_set_valist (tree_store, iter, var_args);
987 * gtk_tree_store_remove:
988 * @tree_store: A #GtkTreeStore
989 * @iter: A valid #GtkTreeIter
991 * Removes @iter from @tree_store. After being removed, @iter is set to the
992 * next valid row at that level, or invalidated if it previously pointed to the
996 gtk_tree_store_remove (GtkTreeStore *tree_store,
1000 GtkTreeIter new_iter = {0,};
1004 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1005 g_return_if_fail (VALID_ITER (iter, tree_store));
1007 parent = G_NODE (iter->user_data)->parent;
1009 g_assert (parent != NULL);
1010 next_node = G_NODE (iter->user_data)->next;
1012 if (G_NODE (iter->user_data)->data)
1013 _gtk_tree_data_list_free ((GtkTreeDataList *) G_NODE (iter->user_data)->data,
1014 tree_store->column_headers);
1016 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1017 g_node_destroy (G_NODE (iter->user_data));
1019 gtk_tree_model_row_deleted (GTK_TREE_MODEL (tree_store), path);
1021 if (parent != G_NODE (tree_store->root))
1024 if (parent->children == NULL)
1026 gtk_tree_path_up (path);
1028 new_iter.stamp = tree_store->stamp;
1029 new_iter.user_data = parent;
1030 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &new_iter);
1033 gtk_tree_path_free (path);
1035 /* revalidate iter */
1036 if (next_node != NULL)
1038 iter->stamp = tree_store->stamp;
1039 iter->user_data = next_node;
1044 iter->user_data = NULL;
1049 * gtk_tree_store_insert:
1050 * @tree_store: A #GtkTreeStore
1051 * @iter: An unset #GtkTreeIter to set to the new row
1052 * @parent: A valid #GtkTreeIter, or %NULL
1053 * @position: position to insert the new row
1055 * Creates a new row at @position. If parent is non-%NULL, then the row will be
1056 * made a child of @parent. Otherwise, the row will be created at the toplevel.
1057 * If @position is larger than the number of rows at that level, then the new
1058 * row will be inserted to the end of the list. @iter will be changed to point
1059 * to this new row. The row will be empty before this function is called. To
1060 * fill in values, you need to call gtk_tree_store_set() or
1061 * gtk_tree_store_set_value().
1065 gtk_tree_store_insert (GtkTreeStore *tree_store,
1067 GtkTreeIter *parent,
1073 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1075 g_return_if_fail (VALID_ITER (parent, tree_store));
1078 parent_node = parent->user_data;
1080 parent_node = tree_store->root;
1082 tree_store->columns_dirty = TRUE;
1084 iter->stamp = tree_store->stamp;
1085 iter->user_data = g_node_new (NULL);
1086 g_node_insert (parent_node, position, G_NODE (iter->user_data));
1088 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1089 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1091 gtk_tree_path_free (path);
1093 validate_tree ((GtkTreeStore*)tree_store);
1097 * gtk_tree_store_insert_before:
1098 * @tree_store: A #GtkTreeStore
1099 * @iter: An unset #GtkTreeIter to set to the new row
1100 * @parent: A valid #GtkTreeIter, or %NULL
1101 * @sibling: A valid #GtkTreeIter, or %NULL
1103 * Inserts a new row before @sibling. If @sibling is %NULL, then the row will
1104 * be appended to the beginning of the @parent 's children. If @parent and
1105 * @sibling are %NULL, then the row will be appended to the toplevel. If both
1106 * @sibling and @parent are set, then @parent must be the parent of @sibling.
1107 * When @sibling is set, @parent is optional.
1109 * @iter will be changed to point to this new row. The row will be empty after
1110 * this function is called. To fill in values, you need to call
1111 * gtk_tree_store_set() or gtk_tree_store_set_value().
1115 gtk_tree_store_insert_before (GtkTreeStore *tree_store,
1117 GtkTreeIter *parent,
1118 GtkTreeIter *sibling)
1121 GNode *parent_node = NULL;
1124 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1125 g_return_if_fail (iter != NULL);
1127 g_return_if_fail (VALID_ITER (parent, tree_store));
1128 if (sibling != NULL)
1129 g_return_if_fail (VALID_ITER (sibling, tree_store));
1131 tree_store->columns_dirty = TRUE;
1133 new_node = g_node_new (NULL);
1135 if (parent == NULL && sibling == NULL)
1136 parent_node = tree_store->root;
1137 else if (parent == NULL)
1138 parent_node = G_NODE (sibling->user_data)->parent;
1139 else if (sibling == NULL)
1140 parent_node = G_NODE (parent->user_data);
1143 g_return_if_fail (G_NODE (sibling->user_data)->parent == G_NODE (parent->user_data));
1144 parent_node = G_NODE (parent->user_data);
1147 g_node_insert_before (parent_node,
1148 sibling ? G_NODE (sibling->user_data) : NULL,
1151 iter->stamp = tree_store->stamp;
1152 iter->user_data = new_node;
1154 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1155 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1157 gtk_tree_path_free (path);
1159 validate_tree ((GtkTreeStore*)tree_store);
1163 * gtk_tree_store_insert_after:
1164 * @tree_store: A #GtkTreeStore
1165 * @iter: An unset #GtkTreeIter to set to the new row
1166 * @parent: A valid #GtkTreeIter, or %NULL
1167 * @sibling: A valid #GtkTreeIter, or %NULL
1169 * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
1170 * prepended to the beginning of the @parent 's children. If @parent and
1171 * @sibling are %NULL, then the row will be prepended to the toplevel. If both
1172 * @sibling and @parent are set, then @parent must be the parent of @sibling.
1173 * When @sibling is set, @parent is optional.
1175 * @iter will be changed to point to this new row. The row will be empty after
1176 * this function is called. To fill in values, you need to call
1177 * gtk_tree_store_set() or gtk_tree_store_set_value().
1181 gtk_tree_store_insert_after (GtkTreeStore *tree_store,
1183 GtkTreeIter *parent,
1184 GtkTreeIter *sibling)
1190 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1191 g_return_if_fail (iter != NULL);
1193 g_return_if_fail (VALID_ITER (parent, tree_store));
1194 if (sibling != NULL)
1195 g_return_if_fail (VALID_ITER (sibling, tree_store));
1197 tree_store->columns_dirty = TRUE;
1199 new_node = g_node_new (NULL);
1201 if (parent == NULL && sibling == NULL)
1202 parent_node = tree_store->root;
1203 else if (parent == NULL)
1204 parent_node = G_NODE (sibling->user_data)->parent;
1205 else if (sibling == NULL)
1206 parent_node = G_NODE (parent->user_data);
1209 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
1210 G_NODE (parent->user_data));
1211 parent_node = G_NODE (parent->user_data);
1215 g_node_insert_after (parent_node,
1216 sibling ? G_NODE (sibling->user_data) : NULL,
1219 iter->stamp = tree_store->stamp;
1220 iter->user_data = new_node;
1222 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1223 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1225 gtk_tree_path_free (path);
1227 validate_tree ((GtkTreeStore*)tree_store);
1231 * gtk_tree_store_prepend:
1232 * @tree_store: A #GtkTreeStore
1233 * @iter: An unset #GtkTreeIter to set to the prepended row
1234 * @parent: A valid #GtkTreeIter, or %NULL
1236 * Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
1237 * the new row before the first child of @parent, otherwise it will prepend a row
1238 * to the top level. @iter will be changed to point to this new row. The row
1239 * will be empty after this function is called. To fill in values, you need to
1240 * call gtk_tree_store_set() or gtk_tree_store_set_value().
1243 gtk_tree_store_prepend (GtkTreeStore *tree_store,
1245 GtkTreeIter *parent)
1249 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1250 g_return_if_fail (iter != NULL);
1252 g_return_if_fail (VALID_ITER (parent, tree_store));
1254 tree_store->columns_dirty = TRUE;
1257 parent_node = tree_store->root;
1259 parent_node = parent->user_data;
1261 if (parent_node->children == NULL)
1265 iter->stamp = tree_store->stamp;
1266 iter->user_data = g_node_new (NULL);
1268 g_node_prepend (parent_node, iter->user_data);
1270 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1271 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1273 if (parent_node != tree_store->root)
1275 gtk_tree_path_up (path);
1276 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1278 gtk_tree_path_free (path);
1282 gtk_tree_store_insert_after (tree_store, iter, parent, NULL);
1285 validate_tree ((GtkTreeStore*)tree_store);
1289 * gtk_tree_store_append:
1290 * @tree_store: A #GtkTreeStore
1291 * @iter: An unset #GtkTreeIter to set to the appended row
1292 * @parent: A valid #GtkTreeIter, or %NULL
1294 * Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
1295 * new row after the last child of @parent, otherwise it will append a row to
1296 * the top level. @iter will be changed to point to this new row. The row will
1297 * be empty after this function is called. To fill in values, you need to call
1298 * gtk_tree_store_set() or gtk_tree_store_set_value().
1301 gtk_tree_store_append (GtkTreeStore *tree_store,
1303 GtkTreeIter *parent)
1307 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1308 g_return_if_fail (iter != NULL);
1311 g_return_if_fail (VALID_ITER (parent, tree_store));
1314 parent_node = tree_store->root;
1316 parent_node = parent->user_data;
1318 tree_store->columns_dirty = TRUE;
1320 if (parent_node->children == NULL)
1324 iter->stamp = tree_store->stamp;
1325 iter->user_data = g_node_new (NULL);
1327 g_node_append (parent_node, G_NODE (iter->user_data));
1329 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1330 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1332 if (parent_node != tree_store->root)
1334 gtk_tree_path_up (path);
1335 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1337 gtk_tree_path_free (path);
1341 gtk_tree_store_insert_before (tree_store, iter, parent, NULL);
1344 validate_tree ((GtkTreeStore*)tree_store);
1348 * gtk_tree_store_is_ancestor:
1349 * @tree_store: A #GtkTreeStore
1350 * @iter: A valid #GtkTreeIter
1351 * @descendant: A valid #GtkTreeIter
1353 * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
1354 * parent (or grandparent or great-grandparent) of @descendant.
1356 * Return value: %TRUE, if @iter is an ancestor of @descendant
1359 gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
1361 GtkTreeIter *descendant)
1363 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1364 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1365 g_return_val_if_fail (VALID_ITER (descendant, tree_store), FALSE);
1367 return g_node_is_ancestor (G_NODE (iter->user_data),
1368 G_NODE (descendant->user_data));
1373 * gtk_tree_store_iter_depth:
1374 * @tree_store: A #GtkTreeStore
1375 * @iter: A valid #GtkTreeIter
1377 * Returns the depth of @iter. This will be 0 for anything on the root level, 1
1378 * for anything down a level, etc.
1380 * Return value: The depth of @iter
1383 gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
1386 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), 0);
1387 g_return_val_if_fail (VALID_ITER (iter, tree_store), 0);
1389 return g_node_depth (G_NODE (iter->user_data)) - 2;
1393 * gtk_tree_store_clear:
1394 * @tree_store: a #GtkTreeStore
1396 * Removes all rows from @tree_store
1399 gtk_tree_store_clear (GtkTreeStore *tree_store)
1403 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1405 while (G_NODE (tree_store->root)->children)
1407 iter.stamp = tree_store->stamp;
1408 iter.user_data = G_NODE (tree_store->root)->children;
1409 gtk_tree_store_remove (tree_store, &iter);
1417 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1422 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1424 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_source),
1428 gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1439 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1441 GtkSelectionData *selection_data)
1443 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_source), FALSE);
1445 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1446 * target, because the default handler does it for us, but
1447 * we do anyway for the convenience of someone maybe overriding the
1451 if (gtk_tree_set_row_drag_data (selection_data,
1452 GTK_TREE_MODEL (drag_source),
1459 /* FIXME handle text targets at least. */
1466 copy_node_data (GtkTreeStore *tree_store,
1467 GtkTreeIter *src_iter,
1468 GtkTreeIter *dest_iter)
1470 GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
1471 GtkTreeDataList *copy_head = NULL;
1472 GtkTreeDataList *copy_prev = NULL;
1473 GtkTreeDataList *copy_iter = NULL;
1480 copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->column_headers[col]);
1482 if (copy_head == NULL)
1483 copy_head = copy_iter;
1486 copy_prev->next = copy_iter;
1488 copy_prev = copy_iter;
1494 G_NODE (dest_iter->user_data)->data = copy_head;
1496 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
1497 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, dest_iter);
1498 gtk_tree_path_free (path);
1502 recursive_node_copy (GtkTreeStore *tree_store,
1503 GtkTreeIter *src_iter,
1504 GtkTreeIter *dest_iter)
1507 GtkTreeModel *model;
1509 model = GTK_TREE_MODEL (tree_store);
1511 copy_node_data (tree_store, src_iter, dest_iter);
1513 if (gtk_tree_model_iter_children (model,
1517 /* Need to create children and recurse. Note our
1518 * dependence on persistent iterators here.
1524 /* Gee, a really slow algorithm... ;-) FIXME */
1525 gtk_tree_store_append (tree_store,
1529 recursive_node_copy (tree_store, &child, ©);
1531 while (gtk_tree_model_iter_next (model, &child));
1536 gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
1538 GtkSelectionData *selection_data)
1540 GtkTreeModel *tree_model;
1541 GtkTreeStore *tree_store;
1542 GtkTreeModel *src_model = NULL;
1543 GtkTreePath *src_path = NULL;
1544 gboolean retval = FALSE;
1546 g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
1548 tree_model = GTK_TREE_MODEL (drag_dest);
1549 tree_store = GTK_TREE_STORE (drag_dest);
1551 validate_tree (tree_store);
1553 if (gtk_tree_get_row_drag_data (selection_data,
1556 src_model == tree_model)
1558 /* Copy the given row to a new position */
1559 GtkTreeIter src_iter;
1560 GtkTreeIter dest_iter;
1563 if (!gtk_tree_model_get_iter (src_model,
1570 /* Get the path to insert _after_ (dest is the path to insert _before_) */
1571 prev = gtk_tree_path_copy (dest);
1573 if (!gtk_tree_path_prev (prev))
1575 GtkTreeIter dest_parent;
1576 GtkTreePath *parent;
1577 GtkTreeIter *dest_parent_p;
1579 /* dest was the first spot at the current depth; which means
1580 * we are supposed to prepend.
1583 /* Get the parent, NULL if parent is the root */
1584 dest_parent_p = NULL;
1585 parent = gtk_tree_path_copy (dest);
1586 if (gtk_tree_path_up (parent))
1588 gtk_tree_model_get_iter (tree_model,
1591 dest_parent_p = &dest_parent;
1593 gtk_tree_path_free (parent);
1596 gtk_tree_store_prepend (GTK_TREE_STORE (tree_model),
1604 if (gtk_tree_model_get_iter (GTK_TREE_MODEL (tree_model),
1608 GtkTreeIter tmp_iter = dest_iter;
1609 gtk_tree_store_insert_after (GTK_TREE_STORE (tree_model),
1618 gtk_tree_path_free (prev);
1620 /* If we succeeded in creating dest_iter, walk src_iter tree branch,
1621 * duplicating it below dest_iter.
1626 recursive_node_copy (tree_store,
1633 /* FIXME maybe add some data targets eventually, or handle text
1634 * targets in the simple case.
1642 gtk_tree_path_free (src_path);
1648 gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
1649 GtkTreePath *dest_path,
1650 GtkSelectionData *selection_data)
1652 GtkTreeModel *src_model = NULL;
1653 GtkTreePath *src_path = NULL;
1654 GtkTreePath *tmp = NULL;
1655 gboolean retval = FALSE;
1657 if (!gtk_tree_get_row_drag_data (selection_data,
1662 /* can only drag to ourselves */
1663 if (src_model != GTK_TREE_MODEL (drag_dest))
1666 /* Can't drop into ourself. */
1667 if (gtk_tree_path_is_ancestor (src_path,
1671 /* Can't drop if dest_path's parent doesn't exist */
1675 if (gtk_tree_path_get_depth (dest_path) > 1)
1677 tmp = gtk_tree_path_copy (dest_path);
1678 gtk_tree_path_up (tmp);
1680 if (!gtk_tree_model_get_iter (GTK_TREE_MODEL (drag_dest),
1686 /* Can otherwise drop anywhere. */
1692 gtk_tree_path_free (src_path);
1694 gtk_tree_path_free (tmp);
1700 typedef struct _SortTuple
1707 gtk_tree_store_compare_func (gconstpointer a,
1711 GtkTreeStore *tree_store = user_data;
1714 GtkTreeIterCompareFunc func;
1721 if (tree_store->sort_column_id != -1)
1723 GtkTreeDataSortHeader *header;
1725 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1726 tree_store->sort_column_id);
1727 g_return_val_if_fail (header != NULL, 0);
1728 g_return_val_if_fail (header->func != NULL, 0);
1730 func = header->func;
1731 data = header->data;
1735 g_return_val_if_fail (tree_store->default_sort_func != NULL, 0);
1736 func = tree_store->default_sort_func;
1737 data = tree_store->default_sort_data;
1740 node_a = ((SortTuple *) a)->node;
1741 node_b = ((SortTuple *) b)->node;
1743 iter_a.stamp = tree_store->stamp;
1744 iter_a.user_data = node_a;
1745 iter_b.stamp = tree_store->stamp;
1746 iter_b.user_data = node_b;
1748 retval = (* func) (GTK_TREE_MODEL (user_data), &iter_a, &iter_b, data);
1750 if (tree_store->order == GTK_SORT_DESCENDING)
1754 else if (retval < 0)
1761 gtk_tree_store_sort_helper (GtkTreeStore *tree_store,
1774 node = parent->children;
1775 if (node == NULL || node->next == NULL)
1778 g_assert (GTK_TREE_STORE_IS_SORTED (tree_store));
1781 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1784 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), list_length);
1787 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
1792 tuple.node = tmp_node;
1793 g_array_append_val (sort_array, tuple);
1797 /* Sort the array */
1798 g_array_sort_with_data (sort_array, gtk_tree_store_compare_func, tree_store);
1800 for (i = 0; i < list_length - 1; i++)
1802 g_array_index (sort_array, SortTuple, i).node->next =
1803 g_array_index (sort_array, SortTuple, i + 1).node;
1804 g_array_index (sort_array, SortTuple, i + 1).node->prev =
1805 g_array_index (sort_array, SortTuple, i).node;
1807 g_array_index (sort_array, SortTuple, list_length - 1).node->next = NULL;
1808 g_array_index (sort_array, SortTuple, 0).node->prev = NULL;
1809 parent->children = g_array_index (sort_array, SortTuple, 0).node;
1811 /* Let the world know about our new order */
1812 new_order = g_new (gint, list_length);
1813 for (i = 0; i < list_length; i++)
1814 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
1816 iter.stamp = tree_store->stamp;
1817 iter.user_data = parent;
1818 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &iter);
1819 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
1820 path, &iter, new_order);
1821 gtk_tree_path_free (path);
1823 g_array_free (sort_array, TRUE);
1827 for (tmp_node = parent->children; tmp_node; tmp_node = tmp_node->next)
1829 if (tmp_node->children)
1830 gtk_tree_store_sort_helper (tree_store, tmp_node, TRUE);
1836 gtk_tree_store_sort (GtkTreeStore *tree_store)
1838 if (tree_store->sort_column_id != -1)
1840 GtkTreeDataSortHeader *header = NULL;
1842 header = _gtk_tree_data_list_get_header (tree_store->sort_list, tree_store->sort_column_id);
1844 /* We want to make sure that we have a function */
1845 g_return_if_fail (header != NULL);
1846 g_return_if_fail (header->func != NULL);
1850 g_return_if_fail (tree_store->default_sort_func != NULL);
1853 gtk_tree_store_sort_helper (tree_store, G_NODE (tree_store->root), TRUE);
1857 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
1864 GtkTreePath *tmp_path;
1865 GtkTreeIter tmp_iter;
1873 GtkTreeIterCompareFunc func;
1876 g_return_if_fail (G_NODE (iter->user_data)->parent != NULL);
1878 tmp_iter.stamp = tree_store->stamp;
1879 if (tree_store->sort_column_id != -1)
1881 GtkTreeDataSortHeader *header;
1882 header = _gtk_tree_data_list_get_header (tree_store->sort_list,
1883 tree_store->sort_column_id);
1884 g_return_if_fail (header != NULL);
1885 g_return_if_fail (header->func != NULL);
1886 func = header->func;
1887 data = header->data;
1891 g_return_if_fail (tree_store->default_sort_func != NULL);
1892 func = tree_store->default_sort_func;
1893 data = tree_store->default_sort_data;
1896 /* If it's the built in function, we don't sort. */
1897 if (func == gtk_tree_data_list_compare_func &&
1898 tree_store->sort_column_id != column)
1902 node = G_NODE (iter->user_data)->parent->children;
1903 /* First we find the iter, its prev, and its next */
1906 if (node == G_NODE (iter->user_data))
1911 g_assert (node != NULL);
1916 /* Check the common case, where we don't need to sort it moved. */
1919 tmp_iter.user_data = prev;
1920 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1925 tmp_iter.user_data = next;
1926 cmp_b = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1930 if (tree_store->order == GTK_SORT_DESCENDING)
1943 if (prev == NULL && cmp_b <= 0)
1945 else if (next == NULL && cmp_a <= 0)
1947 else if (prev != NULL && next != NULL &&
1948 cmp_a <= 0 && cmp_b <= 0)
1951 /* We actually need to sort it */
1952 /* First, remove the old link. */
1957 node->parent->children = next;
1964 /* FIXME: as an optimization, we can potentially start at next */
1966 node = node->parent->children;
1968 tmp_iter.user_data = node;
1969 if (tree_store->order == GTK_SORT_DESCENDING)
1970 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1972 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1974 while ((node->next) && (cmp_a > 0))
1979 tmp_iter.user_data = node;
1980 if (tree_store->order == GTK_SORT_DESCENDING)
1981 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
1983 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
1986 if ((!node->next) && (cmp_a > 0))
1988 node->next = G_NODE (iter->user_data);
1989 node->next->prev = node;
1993 prev->next = G_NODE (iter->user_data);
1994 prev->next->prev = prev;
1995 G_NODE (iter->user_data)->next = node;
1996 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
2000 G_NODE (iter->user_data)->next = G_NODE (iter->user_data)->parent->children;
2001 G_NODE (iter->user_data)->parent->children = G_NODE (iter->user_data);
2004 /* Emit the reordered signal. */
2005 length = g_node_n_children (node->parent);
2006 new_order = g_new (int, length);
2007 if (old_location < new_location)
2008 for (i = 0; i < length; i++)
2010 if (i < old_location ||
2013 else if (i >= old_location &&
2015 new_order[i] = i + 1;
2016 else if (i == new_location)
2017 new_order[i] = old_location;
2020 for (i = 0; i < length; i++)
2022 if (i < new_location ||
2025 else if (i > new_location &&
2027 new_order[i] = i - 1;
2028 else if (i == new_location)
2029 new_order[i] = old_location;
2032 tmp_iter.user_data = node->parent;
2033 tmp_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &tmp_iter);
2035 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2036 tmp_path, &tmp_iter,
2039 gtk_tree_path_free (tmp_path);
2045 gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
2046 gint *sort_column_id,
2049 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2051 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2053 if (tree_store->sort_column_id == -1)
2057 * sort_column_id = tree_store->sort_column_id;
2059 * order = tree_store->order;
2065 gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
2066 gint sort_column_id,
2069 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2071 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2074 if ((tree_store->sort_column_id == sort_column_id) &&
2075 (tree_store->order == order))
2078 if (sort_column_id != -1)
2080 GtkTreeDataSortHeader *header = NULL;
2082 header = _gtk_tree_data_list_get_header (tree_store->sort_list, sort_column_id);
2084 /* We want to make sure that we have a function */
2085 g_return_if_fail (header != NULL);
2086 g_return_if_fail (header->func != NULL);
2090 g_return_if_fail (tree_store->default_sort_func != NULL);
2093 tree_store->sort_column_id = sort_column_id;
2094 tree_store->order = order;
2096 gtk_tree_store_sort (tree_store);
2098 gtk_tree_sortable_sort_column_changed (sortable);
2102 gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
2103 gint sort_column_id,
2104 GtkTreeIterCompareFunc func,
2106 GtkDestroyNotify destroy)
2108 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2109 GtkTreeDataSortHeader *header = NULL;
2112 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2113 g_return_if_fail (func != NULL);
2115 for (list = tree_store->sort_list; list; list = list->next)
2117 header = (GtkTreeDataSortHeader*) list->data;
2118 if (header->sort_column_id == sort_column_id)
2124 header = g_new0 (GtkTreeDataSortHeader, 1);
2125 header->sort_column_id = sort_column_id;
2126 tree_store->sort_list = g_list_append (tree_store->sort_list, header);
2129 if (header->destroy)
2130 (* header->destroy) (header->data);
2132 header->func = func;
2133 header->data = data;
2134 header->destroy = destroy;
2139 gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
2140 GtkTreeIterCompareFunc func,
2142 GtkDestroyNotify destroy)
2144 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2146 g_return_if_fail (GTK_IS_TREE_STORE (sortable));
2148 if (tree_store->default_sort_destroy)
2149 (* tree_store->default_sort_destroy) (tree_store->default_sort_data);
2151 tree_store->default_sort_func = func;
2152 tree_store->default_sort_data = data;
2153 tree_store->default_sort_destroy = destroy;
2157 gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable)
2159 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
2161 g_return_val_if_fail (GTK_IS_TREE_STORE (sortable), FALSE);
2163 return (tree_store->default_sort_func != NULL);
2167 validate_gnode (GNode* node)
2171 iter = node->children;
2172 while (iter != NULL)
2174 g_assert (iter->parent == node);
2176 g_assert (iter->prev->next == iter);
2177 validate_gnode (iter);