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, see <http://www.gnu.org/licenses/>.
20 #include <gobject/gvaluecollector.h>
21 #include "gtktreemodel.h"
22 #include "gtktreestore.h"
23 #include "gtktreedatalist.h"
24 #include "gtktreednd.h"
25 #include "gtkbuildable.h"
31 * SECTION:gtktreestore
32 * @Short_description: A tree-like data structure that can be used with the GtkTreeView
33 * @Title: GtkTreeStore
34 * @See_also: #GtkTreeModel
36 * The #GtkTreeStore object is a list model for use with a #GtkTreeView
37 * widget. It implements the #GtkTreeModel interface, and consequentialy,
38 * can use all of the methods available there. It also implements the
39 * #GtkTreeSortable interface so it can be sorted by the view. Finally,
40 * it also implements the tree <link linkend="gtktreednd">drag and
41 * drop</link> interfaces.
43 * <refsect2 id="GtkTreeStore-BUILDER-UI">
44 * <title>GtkTreeStore as GtkBuildable</title>
45 * The GtkTreeStore implementation of the #GtkBuildable interface allows
46 * to specify the model columns with a <columns> element that may
47 * contain multiple <column> elements, each specifying one model
48 * column. The "type" attribute specifies the data type for the column.
50 * <title>A UI Definition fragment for a tree store</title>
51 * <programlisting><![CDATA[
52 * <object class="GtkTreeStore">
54 * <column type="gchararray"/>
55 * <column type="gchararray"/>
56 * <column type="gint"/>
59 * ]]></programlisting>
64 struct _GtkTreeStorePrivate
73 GType *column_headers;
74 GtkTreeIterCompareFunc default_sort_func;
75 gpointer default_sort_data;
76 GDestroyNotify default_sort_destroy;
77 guint columns_dirty : 1;
81 #define G_NODE(node) ((GNode *)node)
82 #define GTK_TREE_STORE_IS_SORTED(tree) (((GtkTreeStore*)(tree))->priv->sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
83 #define VALID_ITER(iter, tree_store) ((iter)!= NULL && (iter)->user_data != NULL && ((GtkTreeStore*)(tree_store))->priv->stamp == (iter)->stamp)
85 static void gtk_tree_store_tree_model_init (GtkTreeModelIface *iface);
86 static void gtk_tree_store_drag_source_init(GtkTreeDragSourceIface *iface);
87 static void gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface);
88 static void gtk_tree_store_sortable_init (GtkTreeSortableIface *iface);
89 static void gtk_tree_store_buildable_init (GtkBuildableIface *iface);
90 static void gtk_tree_store_finalize (GObject *object);
91 static GtkTreeModelFlags gtk_tree_store_get_flags (GtkTreeModel *tree_model);
92 static gint gtk_tree_store_get_n_columns (GtkTreeModel *tree_model);
93 static GType gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
95 static gboolean gtk_tree_store_get_iter (GtkTreeModel *tree_model,
98 static GtkTreePath *gtk_tree_store_get_path (GtkTreeModel *tree_model,
100 static void gtk_tree_store_get_value (GtkTreeModel *tree_model,
104 static gboolean gtk_tree_store_iter_next (GtkTreeModel *tree_model,
106 static gboolean gtk_tree_store_iter_previous (GtkTreeModel *tree_model,
108 static gboolean gtk_tree_store_iter_children (GtkTreeModel *tree_model,
110 GtkTreeIter *parent);
111 static gboolean gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
113 static gint gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
115 static gboolean gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
119 static gboolean gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
124 static void gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
126 static void gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
130 static void gtk_tree_store_increment_stamp (GtkTreeStore *tree_store);
134 static gboolean real_gtk_tree_store_row_draggable (GtkTreeDragSource *drag_source,
136 static gboolean gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
138 static gboolean gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
140 GtkSelectionData *selection_data);
141 static gboolean gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
143 GtkSelectionData *selection_data);
144 static gboolean gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
145 GtkTreePath *dest_path,
146 GtkSelectionData *selection_data);
148 /* Sortable Interfaces */
150 static void gtk_tree_store_sort (GtkTreeStore *tree_store);
151 static void gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
154 gboolean emit_signal);
155 static gboolean gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
156 gint *sort_column_id,
158 static void gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
161 static void gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
163 GtkTreeIterCompareFunc func,
165 GDestroyNotify destroy);
166 static void gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
167 GtkTreeIterCompareFunc func,
169 GDestroyNotify destroy);
170 static gboolean gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable);
175 static gboolean gtk_tree_store_buildable_custom_tag_start (GtkBuildable *buildable,
178 const gchar *tagname,
179 GMarkupParser *parser,
181 static void gtk_tree_store_buildable_custom_finished (GtkBuildable *buildable,
184 const gchar *tagname,
187 static void validate_gnode (GNode *node);
189 static void gtk_tree_store_move (GtkTreeStore *tree_store,
191 GtkTreeIter *position,
196 validate_tree (GtkTreeStore *tree_store)
198 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
200 g_assert (G_NODE (tree_store->priv->root)->parent == NULL);
202 validate_gnode (G_NODE (tree_store->priv->root));
206 G_DEFINE_TYPE_WITH_CODE (GtkTreeStore, gtk_tree_store, G_TYPE_OBJECT,
207 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
208 gtk_tree_store_tree_model_init)
209 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
210 gtk_tree_store_drag_source_init)
211 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_DEST,
212 gtk_tree_store_drag_dest_init)
213 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_SORTABLE,
214 gtk_tree_store_sortable_init)
215 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
216 gtk_tree_store_buildable_init))
219 gtk_tree_store_class_init (GtkTreeStoreClass *class)
221 GObjectClass *object_class;
223 object_class = (GObjectClass *) class;
225 object_class->finalize = gtk_tree_store_finalize;
227 g_type_class_add_private (class, sizeof (GtkTreeStorePrivate));
231 gtk_tree_store_tree_model_init (GtkTreeModelIface *iface)
233 iface->get_flags = gtk_tree_store_get_flags;
234 iface->get_n_columns = gtk_tree_store_get_n_columns;
235 iface->get_column_type = gtk_tree_store_get_column_type;
236 iface->get_iter = gtk_tree_store_get_iter;
237 iface->get_path = gtk_tree_store_get_path;
238 iface->get_value = gtk_tree_store_get_value;
239 iface->iter_next = gtk_tree_store_iter_next;
240 iface->iter_previous = gtk_tree_store_iter_previous;
241 iface->iter_children = gtk_tree_store_iter_children;
242 iface->iter_has_child = gtk_tree_store_iter_has_child;
243 iface->iter_n_children = gtk_tree_store_iter_n_children;
244 iface->iter_nth_child = gtk_tree_store_iter_nth_child;
245 iface->iter_parent = gtk_tree_store_iter_parent;
249 gtk_tree_store_drag_source_init (GtkTreeDragSourceIface *iface)
251 iface->row_draggable = real_gtk_tree_store_row_draggable;
252 iface->drag_data_delete = gtk_tree_store_drag_data_delete;
253 iface->drag_data_get = gtk_tree_store_drag_data_get;
257 gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface)
259 iface->drag_data_received = gtk_tree_store_drag_data_received;
260 iface->row_drop_possible = gtk_tree_store_row_drop_possible;
264 gtk_tree_store_sortable_init (GtkTreeSortableIface *iface)
266 iface->get_sort_column_id = gtk_tree_store_get_sort_column_id;
267 iface->set_sort_column_id = gtk_tree_store_set_sort_column_id;
268 iface->set_sort_func = gtk_tree_store_set_sort_func;
269 iface->set_default_sort_func = gtk_tree_store_set_default_sort_func;
270 iface->has_default_sort_func = gtk_tree_store_has_default_sort_func;
274 gtk_tree_store_buildable_init (GtkBuildableIface *iface)
276 iface->custom_tag_start = gtk_tree_store_buildable_custom_tag_start;
277 iface->custom_finished = gtk_tree_store_buildable_custom_finished;
281 gtk_tree_store_init (GtkTreeStore *tree_store)
283 GtkTreeStorePrivate *priv;
285 priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_store,
287 GtkTreeStorePrivate);
288 tree_store->priv = priv;
289 priv->root = g_node_new (NULL);
290 /* While the odds are against us getting 0... */
293 priv->stamp = g_random_int ();
295 while (priv->stamp == 0);
297 priv->sort_list = NULL;
298 priv->sort_column_id = GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID;
299 priv->columns_dirty = FALSE;
303 * gtk_tree_store_new:
304 * @n_columns: number of columns in the tree store
305 * @...: all #GType types for the columns, from first to last
307 * Creates a new tree store as with @n_columns columns each of the types passed
308 * in. Note that only types derived from standard GObject fundamental types
311 * As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
312 * GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
313 * <type>int</type>, <type>string</type> and #GdkPixbuf respectively.
315 * Return value: a new #GtkTreeStore
318 gtk_tree_store_new (gint n_columns,
321 GtkTreeStore *retval;
325 g_return_val_if_fail (n_columns > 0, NULL);
327 retval = g_object_new (GTK_TYPE_TREE_STORE, NULL);
328 gtk_tree_store_set_n_columns (retval, n_columns);
330 va_start (args, n_columns);
332 for (i = 0; i < n_columns; i++)
334 GType type = va_arg (args, GType);
335 if (! _gtk_tree_data_list_check_type (type))
337 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (type));
338 g_object_unref (retval);
342 gtk_tree_store_set_column_type (retval, i, type);
349 * gtk_tree_store_newv:
350 * @n_columns: number of columns in the tree store
351 * @types: (array length=n_columns): an array of #GType types for the columns, from first to last
353 * Non vararg creation function. Used primarily by language bindings.
355 * Return value: (transfer full): a new #GtkTreeStore
356 * Rename to: gtk_tree_store_new
359 gtk_tree_store_newv (gint n_columns,
362 GtkTreeStore *retval;
365 g_return_val_if_fail (n_columns > 0, NULL);
367 retval = g_object_new (GTK_TYPE_TREE_STORE, NULL);
368 gtk_tree_store_set_n_columns (retval, n_columns);
370 for (i = 0; i < n_columns; i++)
372 if (! _gtk_tree_data_list_check_type (types[i]))
374 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (types[i]));
375 g_object_unref (retval);
378 gtk_tree_store_set_column_type (retval, i, types[i]);
386 * gtk_tree_store_set_column_types:
387 * @tree_store: A #GtkTreeStore
388 * @n_columns: Number of columns for the tree store
389 * @types: (array length=n_columns): An array of #GType types, one for each column
391 * This function is meant primarily for #GObjects that inherit from
392 * #GtkTreeStore, and should only be used when constructing a new
393 * #GtkTreeStore. It will not function after a row has been added,
394 * or a method on the #GtkTreeModel interface is called.
397 gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
403 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
404 g_return_if_fail (tree_store->priv->columns_dirty == 0);
406 gtk_tree_store_set_n_columns (tree_store, n_columns);
407 for (i = 0; i < n_columns; i++)
409 if (! _gtk_tree_data_list_check_type (types[i]))
411 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (types[i]));
414 gtk_tree_store_set_column_type (tree_store, i, types[i]);
419 gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
422 GtkTreeStorePrivate *priv = tree_store->priv;
425 if (priv->n_columns == n_columns)
428 priv->column_headers = g_renew (GType, priv->column_headers, n_columns);
429 for (i = priv->n_columns; i < n_columns; i++)
430 priv->column_headers[i] = G_TYPE_INVALID;
431 priv->n_columns = n_columns;
434 _gtk_tree_data_list_header_free (priv->sort_list);
436 priv->sort_list = _gtk_tree_data_list_header_new (n_columns, priv->column_headers);
440 * gtk_tree_store_set_column_type:
441 * @tree_store: a #GtkTreeStore
442 * @column: column number
443 * @type: type of the data to be stored in @column
445 * Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
446 * %G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
447 * %G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
448 * subclasses of those types such as %GDK_TYPE_PIXBUF.
452 gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
456 GtkTreeStorePrivate *priv = tree_store->priv;
458 if (!_gtk_tree_data_list_check_type (type))
460 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (type));
463 priv->column_headers[column] = type;
467 node_free (GNode *node, gpointer data)
470 _gtk_tree_data_list_free (node->data, (GType*)data);
477 gtk_tree_store_finalize (GObject *object)
479 GtkTreeStore *tree_store = GTK_TREE_STORE (object);
480 GtkTreeStorePrivate *priv = tree_store->priv;
482 g_node_traverse (priv->root, G_POST_ORDER, G_TRAVERSE_ALL, -1,
483 node_free, priv->column_headers);
484 g_node_destroy (priv->root);
485 _gtk_tree_data_list_header_free (priv->sort_list);
486 g_free (priv->column_headers);
488 if (priv->default_sort_destroy)
490 GDestroyNotify d = priv->default_sort_destroy;
492 priv->default_sort_destroy = NULL;
493 d (priv->default_sort_data);
494 priv->default_sort_data = NULL;
498 G_OBJECT_CLASS (gtk_tree_store_parent_class)->finalize (object);
501 /* fulfill the GtkTreeModel requirements */
502 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node. However,
503 * it is not visible to the tree or to the user., and the path "0" refers to the
504 * first child of GtkTreeStore::root.
508 static GtkTreeModelFlags
509 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
511 return GTK_TREE_MODEL_ITERS_PERSIST;
515 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
517 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
518 GtkTreeStorePrivate *priv = tree_store->priv;
520 priv->columns_dirty = TRUE;
522 return priv->n_columns;
526 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
529 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
530 GtkTreeStorePrivate *priv = tree_store->priv;
532 g_return_val_if_fail (index < priv->n_columns, G_TYPE_INVALID);
534 priv->columns_dirty = TRUE;
536 return priv->column_headers[index];
540 gtk_tree_store_get_iter (GtkTreeModel *tree_model,
544 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
545 GtkTreeStorePrivate *priv = tree_store->priv;
550 priv->columns_dirty = TRUE;
552 indices = gtk_tree_path_get_indices (path);
553 depth = gtk_tree_path_get_depth (path);
555 g_return_val_if_fail (depth > 0, FALSE);
557 parent.stamp = priv->stamp;
558 parent.user_data = priv->root;
560 if (!gtk_tree_store_iter_nth_child (tree_model, iter, &parent, indices[0]))
566 for (i = 1; i < depth; i++)
569 if (!gtk_tree_store_iter_nth_child (tree_model, iter, &parent, indices[i]))
580 gtk_tree_store_get_path (GtkTreeModel *tree_model,
583 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
584 GtkTreeStorePrivate *priv = tree_store->priv;
589 g_return_val_if_fail (iter->user_data != NULL, NULL);
590 g_return_val_if_fail (iter->stamp == priv->stamp, NULL);
592 validate_tree (tree_store);
594 if (G_NODE (iter->user_data)->parent == NULL &&
595 G_NODE (iter->user_data) == priv->root)
596 return gtk_tree_path_new ();
597 g_assert (G_NODE (iter->user_data)->parent != NULL);
599 if (G_NODE (iter->user_data)->parent == G_NODE (priv->root))
601 retval = gtk_tree_path_new ();
602 tmp_node = G_NODE (priv->root)->children;
606 GtkTreeIter tmp_iter = *iter;
608 tmp_iter.user_data = G_NODE (iter->user_data)->parent;
610 retval = gtk_tree_store_get_path (tree_model, &tmp_iter);
611 tmp_node = G_NODE (iter->user_data)->parent->children;
617 if (tmp_node == NULL)
619 gtk_tree_path_free (retval);
623 for (; tmp_node; tmp_node = tmp_node->next)
625 if (tmp_node == G_NODE (iter->user_data))
630 if (tmp_node == NULL)
632 /* We couldn't find node, meaning it's prolly not ours */
633 /* Perhaps I should do a g_return_if_fail here. */
634 gtk_tree_path_free (retval);
638 gtk_tree_path_append_index (retval, i);
645 gtk_tree_store_get_value (GtkTreeModel *tree_model,
650 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
651 GtkTreeStorePrivate *priv = tree_store->priv;
652 GtkTreeDataList *list;
653 gint tmp_column = column;
655 g_return_if_fail (column < priv->n_columns);
656 g_return_if_fail (VALID_ITER (iter, tree_store));
658 list = G_NODE (iter->user_data)->data;
660 while (tmp_column-- > 0 && list)
665 _gtk_tree_data_list_node_to_value (list,
666 priv->column_headers[column],
671 /* We want to return an initialized but empty (default) value */
672 g_value_init (value, priv->column_headers[column]);
677 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
680 g_return_val_if_fail (iter->user_data != NULL, FALSE);
681 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->priv->stamp, FALSE);
683 if (G_NODE (iter->user_data)->next == NULL)
689 iter->user_data = G_NODE (iter->user_data)->next;
695 gtk_tree_store_iter_previous (GtkTreeModel *tree_model,
698 g_return_val_if_fail (iter->user_data != NULL, FALSE);
699 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->priv->stamp, FALSE);
701 if (G_NODE (iter->user_data)->prev == NULL)
707 iter->user_data = G_NODE (iter->user_data)->prev;
713 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
717 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
718 GtkTreeStorePrivate *priv = tree_store->priv;
722 g_return_val_if_fail (VALID_ITER (parent, tree_store), FALSE);
725 children = G_NODE (parent->user_data)->children;
727 children = G_NODE (priv->root)->children;
731 iter->stamp = priv->stamp;
732 iter->user_data = children;
743 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
746 g_return_val_if_fail (iter->user_data != NULL, FALSE);
747 g_return_val_if_fail (VALID_ITER (iter, tree_model), FALSE);
749 return G_NODE (iter->user_data)->children != NULL;
753 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
759 g_return_val_if_fail (iter == NULL || iter->user_data != NULL, 0);
762 node = G_NODE (GTK_TREE_STORE (tree_model)->priv->root)->children;
764 node = G_NODE (iter->user_data)->children;
776 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
781 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
782 GtkTreeStorePrivate *priv = tree_store->priv;
786 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
789 parent_node = priv->root;
791 parent_node = parent->user_data;
793 child = g_node_nth_child (parent_node, n);
797 iter->user_data = child;
798 iter->stamp = priv->stamp;
809 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
813 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
814 GtkTreeStorePrivate *priv = tree_store->priv;
817 g_return_val_if_fail (iter != NULL, FALSE);
818 g_return_val_if_fail (VALID_ITER (child, tree_store), FALSE);
820 parent = G_NODE (child->user_data)->parent;
822 g_assert (parent != NULL);
824 if (parent != priv->root)
826 iter->user_data = parent;
827 iter->stamp = priv->stamp;
838 /* Does not emit a signal */
840 gtk_tree_store_real_set_value (GtkTreeStore *tree_store,
846 GtkTreeStorePrivate *priv = tree_store->priv;
847 GtkTreeDataList *list;
848 GtkTreeDataList *prev;
849 gint old_column = column;
850 GValue real_value = G_VALUE_INIT;
851 gboolean converted = FALSE;
852 gboolean retval = FALSE;
854 if (! g_type_is_a (G_VALUE_TYPE (value), priv->column_headers[column]))
856 if (! (g_value_type_transformable (G_VALUE_TYPE (value), priv->column_headers[column])))
858 g_warning ("%s: Unable to convert from %s to %s\n",
860 g_type_name (G_VALUE_TYPE (value)),
861 g_type_name (priv->column_headers[column]));
865 g_value_init (&real_value, priv->column_headers[column]);
866 if (!g_value_transform (value, &real_value))
868 g_warning ("%s: Unable to make conversion from %s to %s\n",
870 g_type_name (G_VALUE_TYPE (value)),
871 g_type_name (priv->column_headers[column]));
872 g_value_unset (&real_value);
878 prev = list = G_NODE (iter->user_data)->data;
885 _gtk_tree_data_list_value_to_node (list, &real_value);
887 _gtk_tree_data_list_value_to_node (list, value);
890 g_value_unset (&real_value);
891 if (sort && GTK_TREE_STORE_IS_SORTED (tree_store))
892 gtk_tree_store_sort_iter_changed (tree_store, iter, old_column, TRUE);
901 if (G_NODE (iter->user_data)->data == NULL)
903 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
908 list = prev->next = _gtk_tree_data_list_alloc ();
914 list->next = _gtk_tree_data_list_alloc ();
921 _gtk_tree_data_list_value_to_node (list, &real_value);
923 _gtk_tree_data_list_value_to_node (list, value);
927 g_value_unset (&real_value);
929 if (sort && GTK_TREE_STORE_IS_SORTED (tree_store))
930 gtk_tree_store_sort_iter_changed (tree_store, iter, old_column, TRUE);
936 * gtk_tree_store_set_value:
937 * @tree_store: a #GtkTreeStore
938 * @iter: A valid #GtkTreeIter for the row being modified
939 * @column: column number to modify
940 * @value: new value for the cell
942 * Sets the data in the cell specified by @iter and @column.
943 * The type of @value must be convertible to the type of the
948 gtk_tree_store_set_value (GtkTreeStore *tree_store,
953 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
954 g_return_if_fail (VALID_ITER (iter, tree_store));
955 g_return_if_fail (column >= 0 && column < tree_store->priv->n_columns);
956 g_return_if_fail (G_IS_VALUE (value));
958 if (gtk_tree_store_real_set_value (tree_store, iter, column, value, TRUE))
962 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
963 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
964 gtk_tree_path_free (path);
968 static GtkTreeIterCompareFunc
969 gtk_tree_store_get_compare_func (GtkTreeStore *tree_store)
971 GtkTreeStorePrivate *priv = tree_store->priv;
972 GtkTreeIterCompareFunc func = NULL;
974 if (GTK_TREE_STORE_IS_SORTED (tree_store))
976 if (priv->sort_column_id != -1)
978 GtkTreeDataSortHeader *header;
979 header = _gtk_tree_data_list_get_header (priv->sort_list,
980 priv->sort_column_id);
981 g_return_val_if_fail (header != NULL, NULL);
982 g_return_val_if_fail (header->func != NULL, NULL);
987 func = priv->default_sort_func;
995 gtk_tree_store_set_vector_internal (GtkTreeStore *tree_store,
997 gboolean *emit_signal,
998 gboolean *maybe_need_sort,
1003 GtkTreeStorePrivate *priv = tree_store->priv;
1005 GtkTreeIterCompareFunc func = NULL;
1007 func = gtk_tree_store_get_compare_func (tree_store);
1008 if (func != _gtk_tree_data_list_compare_func)
1009 *maybe_need_sort = TRUE;
1011 for (i = 0; i < n_values; i++)
1013 *emit_signal = gtk_tree_store_real_set_value (tree_store, iter,
1014 columns[i], &values[i],
1015 FALSE) || *emit_signal;
1017 if (func == _gtk_tree_data_list_compare_func &&
1018 columns[i] == priv->sort_column_id)
1019 *maybe_need_sort = TRUE;
1024 gtk_tree_store_set_valist_internal (GtkTreeStore *tree_store,
1026 gboolean *emit_signal,
1027 gboolean *maybe_need_sort,
1030 GtkTreeStorePrivate *priv = tree_store->priv;
1032 GtkTreeIterCompareFunc func = NULL;
1034 column = va_arg (var_args, gint);
1036 func = gtk_tree_store_get_compare_func (tree_store);
1037 if (func != _gtk_tree_data_list_compare_func)
1038 *maybe_need_sort = TRUE;
1040 while (column != -1)
1042 GValue value = G_VALUE_INIT;
1043 gchar *error = NULL;
1045 if (column < 0 || column >= priv->n_columns)
1047 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
1051 G_VALUE_COLLECT_INIT (&value, priv->column_headers[column],
1052 var_args, 0, &error);
1055 g_warning ("%s: %s", G_STRLOC, error);
1058 /* we purposely leak the value here, it might not be
1059 * in a sane state if an error condition occoured
1064 *emit_signal = gtk_tree_store_real_set_value (tree_store,
1068 FALSE) || *emit_signal;
1070 if (func == _gtk_tree_data_list_compare_func &&
1071 column == priv->sort_column_id)
1072 *maybe_need_sort = TRUE;
1074 g_value_unset (&value);
1076 column = va_arg (var_args, gint);
1081 * gtk_tree_store_set_valuesv:
1082 * @tree_store: A #GtkTreeStore
1083 * @iter: A valid #GtkTreeIter for the row being modified
1084 * @columns: (array length=n_values): an array of column numbers
1085 * @values: (array length=n_values): an array of GValues
1086 * @n_values: the length of the @columns and @values arrays
1088 * A variant of gtk_tree_store_set_valist() which takes
1089 * the columns and values as two arrays, instead of varargs. This
1090 * function is mainly intended for language bindings or in case
1091 * the number of columns to change is not known until run-time.
1094 * Rename to: gtk_tree_store_set
1097 gtk_tree_store_set_valuesv (GtkTreeStore *tree_store,
1103 GtkTreeStorePrivate *priv = tree_store->priv;
1104 gboolean emit_signal = FALSE;
1105 gboolean maybe_need_sort = FALSE;
1107 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1108 g_return_if_fail (VALID_ITER (iter, tree_store));
1110 gtk_tree_store_set_vector_internal (tree_store, iter,
1113 columns, values, n_values);
1115 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1116 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, TRUE);
1122 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1123 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
1124 gtk_tree_path_free (path);
1129 * gtk_tree_store_set_valist:
1130 * @tree_store: A #GtkTreeStore
1131 * @iter: A valid #GtkTreeIter for the row being modified
1132 * @var_args: <type>va_list</type> of column/value pairs
1134 * See gtk_tree_store_set(); this version takes a <type>va_list</type> for
1135 * use by language bindings.
1139 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
1143 GtkTreeStorePrivate *priv = tree_store->priv;
1144 gboolean emit_signal = FALSE;
1145 gboolean maybe_need_sort = FALSE;
1147 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1148 g_return_if_fail (VALID_ITER (iter, tree_store));
1150 gtk_tree_store_set_valist_internal (tree_store, iter,
1155 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1156 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, TRUE);
1162 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1163 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
1164 gtk_tree_path_free (path);
1169 * gtk_tree_store_set:
1170 * @tree_store: A #GtkTreeStore
1171 * @iter: A valid #GtkTreeIter for the row being modified
1172 * @...: pairs of column number and value, terminated with -1
1174 * Sets the value of one or more cells in the row referenced by @iter.
1175 * The variable argument list should contain integer column numbers,
1176 * each column number followed by the value to be set.
1177 * The list is terminated by a -1. For example, to set column 0 with type
1178 * %G_TYPE_STRING to "Foo", you would write
1179 * <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
1181 * The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
1182 * will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
1185 gtk_tree_store_set (GtkTreeStore *tree_store,
1191 va_start (var_args, iter);
1192 gtk_tree_store_set_valist (tree_store, iter, var_args);
1197 * gtk_tree_store_remove:
1198 * @tree_store: A #GtkTreeStore
1199 * @iter: A valid #GtkTreeIter
1201 * Removes @iter from @tree_store. After being removed, @iter is set to the
1202 * next valid row at that level, or invalidated if it previously pointed to the
1205 * Return value: %TRUE if @iter is still valid, %FALSE if not.
1208 gtk_tree_store_remove (GtkTreeStore *tree_store,
1211 GtkTreeStorePrivate *priv = tree_store->priv;
1213 GtkTreeIter new_iter = {0,};
1217 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1218 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1220 parent = G_NODE (iter->user_data)->parent;
1222 g_assert (parent != NULL);
1223 next_node = G_NODE (iter->user_data)->next;
1225 if (G_NODE (iter->user_data)->data)
1226 g_node_traverse (G_NODE (iter->user_data), G_POST_ORDER, G_TRAVERSE_ALL,
1227 -1, node_free, priv->column_headers);
1229 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1230 g_node_destroy (G_NODE (iter->user_data));
1232 gtk_tree_model_row_deleted (GTK_TREE_MODEL (tree_store), path);
1234 if (parent != G_NODE (priv->root))
1237 if (parent->children == NULL)
1239 gtk_tree_path_up (path);
1241 new_iter.stamp = priv->stamp;
1242 new_iter.user_data = parent;
1243 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &new_iter);
1246 gtk_tree_path_free (path);
1248 /* revalidate iter */
1249 if (next_node != NULL)
1251 iter->stamp = priv->stamp;
1252 iter->user_data = next_node;
1258 iter->user_data = NULL;
1265 * gtk_tree_store_insert:
1266 * @tree_store: A #GtkTreeStore
1267 * @iter: (out): An unset #GtkTreeIter to set to the new row
1268 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1269 * @position: position to insert the new row, or -1 for last
1271 * Creates a new row at @position. If parent is non-%NULL, then the row will be
1272 * made a child of @parent. Otherwise, the row will be created at the toplevel.
1273 * If @position is -1 or is larger than the number of rows at that level, then
1274 * the new row will be inserted to the end of the list. @iter will be changed
1275 * to point to this new row. The row will be empty after this function is
1276 * called. To fill in values, you need to call gtk_tree_store_set() or
1277 * gtk_tree_store_set_value().
1281 gtk_tree_store_insert (GtkTreeStore *tree_store,
1283 GtkTreeIter *parent,
1286 GtkTreeStorePrivate *priv = tree_store->priv;
1291 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1292 g_return_if_fail (iter != NULL);
1294 g_return_if_fail (VALID_ITER (parent, tree_store));
1297 parent_node = parent->user_data;
1299 parent_node = priv->root;
1301 priv->columns_dirty = TRUE;
1303 new_node = g_node_new (NULL);
1305 iter->stamp = priv->stamp;
1306 iter->user_data = new_node;
1307 g_node_insert (parent_node, position, new_node);
1309 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1310 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1312 if (parent_node != priv->root)
1314 if (new_node->prev == NULL && new_node->next == NULL)
1316 gtk_tree_path_up (path);
1317 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1321 gtk_tree_path_free (path);
1323 validate_tree ((GtkTreeStore*)tree_store);
1327 * gtk_tree_store_insert_before:
1328 * @tree_store: A #GtkTreeStore
1329 * @iter: (out): An unset #GtkTreeIter to set to the new row
1330 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1331 * @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
1333 * Inserts a new row before @sibling. If @sibling is %NULL, then the row will
1334 * be appended to @parent 's children. If @parent and @sibling are %NULL, then
1335 * the row will be appended to the toplevel. If both @sibling and @parent are
1336 * set, then @parent must be the parent of @sibling. When @sibling is set,
1337 * @parent is optional.
1339 * @iter will be changed to point to this new row. The row will be empty after
1340 * this function is called. To fill in values, you need to call
1341 * gtk_tree_store_set() or gtk_tree_store_set_value().
1345 gtk_tree_store_insert_before (GtkTreeStore *tree_store,
1347 GtkTreeIter *parent,
1348 GtkTreeIter *sibling)
1350 GtkTreeStorePrivate *priv = tree_store->priv;
1352 GNode *parent_node = NULL;
1355 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1356 g_return_if_fail (iter != NULL);
1358 g_return_if_fail (VALID_ITER (parent, tree_store));
1359 if (sibling != NULL)
1360 g_return_if_fail (VALID_ITER (sibling, tree_store));
1362 if (parent == NULL && sibling == NULL)
1363 parent_node = priv->root;
1364 else if (parent == NULL)
1365 parent_node = G_NODE (sibling->user_data)->parent;
1366 else if (sibling == NULL)
1367 parent_node = G_NODE (parent->user_data);
1370 g_return_if_fail (G_NODE (sibling->user_data)->parent == G_NODE (parent->user_data));
1371 parent_node = G_NODE (parent->user_data);
1374 priv->columns_dirty = TRUE;
1376 new_node = g_node_new (NULL);
1378 g_node_insert_before (parent_node,
1379 sibling ? G_NODE (sibling->user_data) : NULL,
1382 iter->stamp = priv->stamp;
1383 iter->user_data = new_node;
1385 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1386 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1388 if (parent_node != priv->root)
1390 if (new_node->prev == NULL && new_node->next == NULL)
1392 GtkTreeIter parent_iter;
1394 parent_iter.stamp = priv->stamp;
1395 parent_iter.user_data = parent_node;
1397 gtk_tree_path_up (path);
1398 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &parent_iter);
1402 gtk_tree_path_free (path);
1404 validate_tree (tree_store);
1408 * gtk_tree_store_insert_after:
1409 * @tree_store: A #GtkTreeStore
1410 * @iter: (out): An unset #GtkTreeIter to set to the new row
1411 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1412 * @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
1414 * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
1415 * prepended to @parent 's children. If @parent and @sibling are %NULL, then
1416 * the row will be prepended to the toplevel. If both @sibling and @parent are
1417 * set, then @parent must be the parent of @sibling. When @sibling is set,
1418 * @parent is optional.
1420 * @iter will be changed to point to this new row. The row will be empty after
1421 * this function is called. To fill in values, you need to call
1422 * gtk_tree_store_set() or gtk_tree_store_set_value().
1426 gtk_tree_store_insert_after (GtkTreeStore *tree_store,
1428 GtkTreeIter *parent,
1429 GtkTreeIter *sibling)
1431 GtkTreeStorePrivate *priv = tree_store->priv;
1436 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1437 g_return_if_fail (iter != NULL);
1439 g_return_if_fail (VALID_ITER (parent, tree_store));
1440 if (sibling != NULL)
1441 g_return_if_fail (VALID_ITER (sibling, tree_store));
1443 if (parent == NULL && sibling == NULL)
1444 parent_node = priv->root;
1445 else if (parent == NULL)
1446 parent_node = G_NODE (sibling->user_data)->parent;
1447 else if (sibling == NULL)
1448 parent_node = G_NODE (parent->user_data);
1451 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
1452 G_NODE (parent->user_data));
1453 parent_node = G_NODE (parent->user_data);
1456 priv->columns_dirty = TRUE;
1458 new_node = g_node_new (NULL);
1460 g_node_insert_after (parent_node,
1461 sibling ? G_NODE (sibling->user_data) : NULL,
1464 iter->stamp = priv->stamp;
1465 iter->user_data = new_node;
1467 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1468 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1470 if (parent_node != priv->root)
1472 if (new_node->prev == NULL && new_node->next == NULL)
1474 GtkTreeIter parent_iter;
1476 parent_iter.stamp = priv->stamp;
1477 parent_iter.user_data = parent_node;
1479 gtk_tree_path_up (path);
1480 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &parent_iter);
1484 gtk_tree_path_free (path);
1486 validate_tree (tree_store);
1490 * gtk_tree_store_insert_with_values:
1491 * @tree_store: A #GtkTreeStore
1492 * @iter: (out) (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
1493 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1494 * @position: position to insert the new row, or -1 to append after existing rows
1495 * @...: pairs of column number and value, terminated with -1
1497 * Creates a new row at @position. @iter will be changed to point to this
1498 * new row. If @position is -1, or larger than the number of rows on the list, then
1499 * the new row will be appended to the list. The row will be filled with
1500 * the values given to this function.
1503 * <literal>gtk_tree_store_insert_with_values (tree_store, iter, position, ...)</literal>
1504 * has the same effect as calling
1506 * gtk_tree_store_insert (tree_store, iter, position);
1507 * gtk_tree_store_set (tree_store, iter, ...);
1509 * with the different that the former will only emit a row_inserted signal,
1510 * while the latter will emit row_inserted, row_changed and if the tree store
1511 * is sorted, rows_reordered. Since emitting the rows_reordered signal
1512 * repeatedly can affect the performance of the program,
1513 * gtk_tree_store_insert_with_values() should generally be preferred when
1514 * inserting rows in a sorted tree store.
1519 gtk_tree_store_insert_with_values (GtkTreeStore *tree_store,
1521 GtkTreeIter *parent,
1525 GtkTreeStorePrivate *priv = tree_store->priv;
1529 GtkTreeIter tmp_iter;
1531 gboolean changed = FALSE;
1532 gboolean maybe_need_sort = FALSE;
1534 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1540 g_return_if_fail (VALID_ITER (parent, tree_store));
1543 parent_node = parent->user_data;
1545 parent_node = priv->root;
1547 priv->columns_dirty = TRUE;
1549 new_node = g_node_new (NULL);
1551 iter->stamp = priv->stamp;
1552 iter->user_data = new_node;
1553 g_node_insert (parent_node, position, new_node);
1555 va_start (var_args, position);
1556 gtk_tree_store_set_valist_internal (tree_store, iter,
1557 &changed, &maybe_need_sort,
1561 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1562 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, FALSE);
1564 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1565 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1567 if (parent_node != priv->root)
1569 if (new_node->prev == NULL && new_node->next == NULL)
1571 gtk_tree_path_up (path);
1572 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1576 gtk_tree_path_free (path);
1578 validate_tree ((GtkTreeStore *)tree_store);
1582 * gtk_tree_store_insert_with_valuesv:
1583 * @tree_store: A #GtkTreeStore
1584 * @iter: (out) (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
1585 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1586 * @position: position to insert the new row, or -1 for last
1587 * @columns: (array length=n_values): an array of column numbers
1588 * @values: (array length=n_values): an array of GValues
1589 * @n_values: the length of the @columns and @values arrays
1591 * A variant of gtk_tree_store_insert_with_values() which takes
1592 * the columns and values as two arrays, instead of varargs. This
1593 * function is mainly intended for language bindings.
1596 * Rename to: gtk_tree_store_insert_with_values
1599 gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store,
1601 GtkTreeIter *parent,
1607 GtkTreeStorePrivate *priv = tree_store->priv;
1611 GtkTreeIter tmp_iter;
1612 gboolean changed = FALSE;
1613 gboolean maybe_need_sort = FALSE;
1615 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1621 g_return_if_fail (VALID_ITER (parent, tree_store));
1624 parent_node = parent->user_data;
1626 parent_node = priv->root;
1628 priv->columns_dirty = TRUE;
1630 new_node = g_node_new (NULL);
1632 iter->stamp = priv->stamp;
1633 iter->user_data = new_node;
1634 g_node_insert (parent_node, position, new_node);
1636 gtk_tree_store_set_vector_internal (tree_store, iter,
1637 &changed, &maybe_need_sort,
1638 columns, values, n_values);
1640 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1641 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, FALSE);
1643 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1644 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1646 if (parent_node != priv->root)
1648 if (new_node->prev == NULL && new_node->next == NULL)
1650 gtk_tree_path_up (path);
1651 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1655 gtk_tree_path_free (path);
1657 validate_tree ((GtkTreeStore *)tree_store);
1661 * gtk_tree_store_prepend:
1662 * @tree_store: A #GtkTreeStore
1663 * @iter: (out): An unset #GtkTreeIter to set to the prepended row
1664 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1666 * Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
1667 * the new row before the first child of @parent, otherwise it will prepend a row
1668 * to the top level. @iter will be changed to point to this new row. The row
1669 * will be empty after this function is called. To fill in values, you need to
1670 * call gtk_tree_store_set() or gtk_tree_store_set_value().
1673 gtk_tree_store_prepend (GtkTreeStore *tree_store,
1675 GtkTreeIter *parent)
1677 GtkTreeStorePrivate *priv = tree_store->priv;
1680 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1681 g_return_if_fail (iter != NULL);
1683 g_return_if_fail (VALID_ITER (parent, tree_store));
1685 priv->columns_dirty = TRUE;
1688 parent_node = priv->root;
1690 parent_node = parent->user_data;
1692 if (parent_node->children == NULL)
1696 iter->stamp = priv->stamp;
1697 iter->user_data = g_node_new (NULL);
1699 g_node_prepend (parent_node, G_NODE (iter->user_data));
1701 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1702 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1704 if (parent_node != priv->root)
1706 gtk_tree_path_up (path);
1707 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1709 gtk_tree_path_free (path);
1713 gtk_tree_store_insert_after (tree_store, iter, parent, NULL);
1716 validate_tree (tree_store);
1720 * gtk_tree_store_append:
1721 * @tree_store: A #GtkTreeStore
1722 * @iter: (out): An unset #GtkTreeIter to set to the appended row
1723 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1725 * Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
1726 * new row after the last child of @parent, otherwise it will append a row to
1727 * the top level. @iter will be changed to point to this new row. The row will
1728 * be empty after this function is called. To fill in values, you need to call
1729 * gtk_tree_store_set() or gtk_tree_store_set_value().
1732 gtk_tree_store_append (GtkTreeStore *tree_store,
1734 GtkTreeIter *parent)
1736 GtkTreeStorePrivate *priv = tree_store->priv;
1739 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1740 g_return_if_fail (iter != NULL);
1742 g_return_if_fail (VALID_ITER (parent, tree_store));
1745 parent_node = priv->root;
1747 parent_node = parent->user_data;
1749 priv->columns_dirty = TRUE;
1751 if (parent_node->children == NULL)
1755 iter->stamp = priv->stamp;
1756 iter->user_data = g_node_new (NULL);
1758 g_node_append (parent_node, G_NODE (iter->user_data));
1760 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1761 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1763 if (parent_node != priv->root)
1765 gtk_tree_path_up (path);
1766 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1768 gtk_tree_path_free (path);
1772 gtk_tree_store_insert_before (tree_store, iter, parent, NULL);
1775 validate_tree (tree_store);
1779 * gtk_tree_store_is_ancestor:
1780 * @tree_store: A #GtkTreeStore
1781 * @iter: A valid #GtkTreeIter
1782 * @descendant: A valid #GtkTreeIter
1784 * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
1785 * parent (or grandparent or great-grandparent) of @descendant.
1787 * Return value: %TRUE, if @iter is an ancestor of @descendant
1790 gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
1792 GtkTreeIter *descendant)
1794 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1795 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1796 g_return_val_if_fail (VALID_ITER (descendant, tree_store), FALSE);
1798 return g_node_is_ancestor (G_NODE (iter->user_data),
1799 G_NODE (descendant->user_data));
1804 * gtk_tree_store_iter_depth:
1805 * @tree_store: A #GtkTreeStore
1806 * @iter: A valid #GtkTreeIter
1808 * Returns the depth of @iter. This will be 0 for anything on the root level, 1
1809 * for anything down a level, etc.
1811 * Return value: The depth of @iter
1814 gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
1817 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), 0);
1818 g_return_val_if_fail (VALID_ITER (iter, tree_store), 0);
1820 return g_node_depth (G_NODE (iter->user_data)) - 2;
1823 /* simple ripoff from g_node_traverse_post_order */
1825 gtk_tree_store_clear_traverse (GNode *node,
1826 GtkTreeStore *store)
1834 child = node->children;
1837 register GNode *current;
1840 child = current->next;
1841 if (gtk_tree_store_clear_traverse (current, store))
1847 iter.stamp = store->priv->stamp;
1848 iter.user_data = node;
1850 gtk_tree_store_remove (store, &iter);
1853 else if (node->parent)
1855 iter.stamp = store->priv->stamp;
1856 iter.user_data = node;
1858 gtk_tree_store_remove (store, &iter);
1865 gtk_tree_store_increment_stamp (GtkTreeStore *tree_store)
1867 GtkTreeStorePrivate *priv = tree_store->priv;
1872 while (priv->stamp == 0);
1876 * gtk_tree_store_clear:
1877 * @tree_store: a #GtkTreeStore
1879 * Removes all rows from @tree_store
1882 gtk_tree_store_clear (GtkTreeStore *tree_store)
1884 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1886 gtk_tree_store_clear_traverse (tree_store->priv->root, tree_store);
1887 gtk_tree_store_increment_stamp (tree_store);
1891 gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter,
1900 if (node == iter->user_data)
1904 if (gtk_tree_store_iter_is_valid_helper (iter, node->children))
1915 * gtk_tree_store_iter_is_valid:
1916 * @tree_store: A #GtkTreeStore.
1917 * @iter: A #GtkTreeIter.
1919 * WARNING: This function is slow. Only use it for debugging and/or testing
1922 * Checks if the given iter is a valid iter for this #GtkTreeStore.
1924 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
1929 gtk_tree_store_iter_is_valid (GtkTreeStore *tree_store,
1932 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1933 g_return_val_if_fail (iter != NULL, FALSE);
1935 if (!VALID_ITER (iter, tree_store))
1938 return gtk_tree_store_iter_is_valid_helper (iter, tree_store->priv->root);
1944 static gboolean real_gtk_tree_store_row_draggable (GtkTreeDragSource *drag_source,
1951 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1956 if (gtk_tree_store_get_iter (GTK_TREE_MODEL (drag_source),
1960 gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1971 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1973 GtkSelectionData *selection_data)
1975 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1976 * target, because the default handler does it for us, but
1977 * we do anyway for the convenience of someone maybe overriding the
1981 if (gtk_tree_set_row_drag_data (selection_data,
1982 GTK_TREE_MODEL (drag_source),
1989 /* FIXME handle text targets at least. */
1996 copy_node_data (GtkTreeStore *tree_store,
1997 GtkTreeIter *src_iter,
1998 GtkTreeIter *dest_iter)
2000 GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
2001 GtkTreeDataList *copy_head = NULL;
2002 GtkTreeDataList *copy_prev = NULL;
2003 GtkTreeDataList *copy_iter = NULL;
2010 copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->priv->column_headers[col]);
2012 if (copy_head == NULL)
2013 copy_head = copy_iter;
2016 copy_prev->next = copy_iter;
2018 copy_prev = copy_iter;
2024 G_NODE (dest_iter->user_data)->data = copy_head;
2026 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
2027 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, dest_iter);
2028 gtk_tree_path_free (path);
2032 recursive_node_copy (GtkTreeStore *tree_store,
2033 GtkTreeIter *src_iter,
2034 GtkTreeIter *dest_iter)
2037 GtkTreeModel *model;
2039 model = GTK_TREE_MODEL (tree_store);
2041 copy_node_data (tree_store, src_iter, dest_iter);
2043 if (gtk_tree_store_iter_children (model,
2047 /* Need to create children and recurse. Note our
2048 * dependence on persistent iterators here.
2054 /* Gee, a really slow algorithm... ;-) FIXME */
2055 gtk_tree_store_append (tree_store,
2059 recursive_node_copy (tree_store, &child, ©);
2061 while (gtk_tree_store_iter_next (model, &child));
2066 gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
2068 GtkSelectionData *selection_data)
2070 GtkTreeModel *tree_model;
2071 GtkTreeStore *tree_store;
2072 GtkTreeModel *src_model = NULL;
2073 GtkTreePath *src_path = NULL;
2074 gboolean retval = FALSE;
2076 tree_model = GTK_TREE_MODEL (drag_dest);
2077 tree_store = GTK_TREE_STORE (drag_dest);
2079 validate_tree (tree_store);
2081 if (gtk_tree_get_row_drag_data (selection_data,
2084 src_model == tree_model)
2086 /* Copy the given row to a new position */
2087 GtkTreeIter src_iter;
2088 GtkTreeIter dest_iter;
2091 if (!gtk_tree_store_get_iter (src_model,
2098 /* Get the path to insert _after_ (dest is the path to insert _before_) */
2099 prev = gtk_tree_path_copy (dest);
2101 if (!gtk_tree_path_prev (prev))
2103 GtkTreeIter dest_parent;
2104 GtkTreePath *parent;
2105 GtkTreeIter *dest_parent_p;
2107 /* dest was the first spot at the current depth; which means
2108 * we are supposed to prepend.
2111 /* Get the parent, NULL if parent is the root */
2112 dest_parent_p = NULL;
2113 parent = gtk_tree_path_copy (dest);
2114 if (gtk_tree_path_up (parent) &&
2115 gtk_tree_path_get_depth (parent) > 0)
2117 gtk_tree_store_get_iter (tree_model,
2120 dest_parent_p = &dest_parent;
2122 gtk_tree_path_free (parent);
2125 gtk_tree_store_prepend (tree_store,
2133 if (gtk_tree_store_get_iter (tree_model, &dest_iter, prev))
2135 GtkTreeIter tmp_iter = dest_iter;
2137 gtk_tree_store_insert_after (tree_store, &dest_iter, NULL,
2144 gtk_tree_path_free (prev);
2146 /* If we succeeded in creating dest_iter, walk src_iter tree branch,
2147 * duplicating it below dest_iter.
2152 recursive_node_copy (tree_store,
2159 /* FIXME maybe add some data targets eventually, or handle text
2160 * targets in the simple case.
2168 gtk_tree_path_free (src_path);
2174 gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
2175 GtkTreePath *dest_path,
2176 GtkSelectionData *selection_data)
2178 GtkTreeModel *src_model = NULL;
2179 GtkTreePath *src_path = NULL;
2180 GtkTreePath *tmp = NULL;
2181 gboolean retval = FALSE;
2183 /* don't accept drops if the tree has been sorted */
2184 if (GTK_TREE_STORE_IS_SORTED (drag_dest))
2187 if (!gtk_tree_get_row_drag_data (selection_data,
2192 /* can only drag to ourselves */
2193 if (src_model != GTK_TREE_MODEL (drag_dest))
2196 /* Can't drop into ourself. */
2197 if (gtk_tree_path_is_ancestor (src_path,
2201 /* Can't drop if dest_path's parent doesn't exist */
2205 if (gtk_tree_path_get_depth (dest_path) > 1)
2207 tmp = gtk_tree_path_copy (dest_path);
2208 gtk_tree_path_up (tmp);
2210 if (!gtk_tree_store_get_iter (GTK_TREE_MODEL (drag_dest),
2216 /* Can otherwise drop anywhere. */
2222 gtk_tree_path_free (src_path);
2224 gtk_tree_path_free (tmp);
2229 /* Sorting and reordering */
2230 typedef struct _SortTuple
2238 gtk_tree_store_reorder_func (gconstpointer a,
2242 SortTuple *a_reorder;
2243 SortTuple *b_reorder;
2245 a_reorder = (SortTuple *)a;
2246 b_reorder = (SortTuple *)b;
2248 if (a_reorder->offset < b_reorder->offset)
2250 if (a_reorder->offset > b_reorder->offset)
2257 * gtk_tree_store_reorder: (skip)
2258 * @tree_store: A #GtkTreeStore.
2259 * @parent: A #GtkTreeIter.
2260 * @new_order: (array): an array of integers mapping the new position of each child
2261 * to its old position before the re-ordering,
2262 * i.e. @new_order<literal>[newpos] = oldpos</literal>.
2264 * Reorders the children of @parent in @tree_store to follow the order
2265 * indicated by @new_order. Note that this function only works with
2271 gtk_tree_store_reorder (GtkTreeStore *tree_store,
2272 GtkTreeIter *parent,
2276 GNode *level, *node;
2278 SortTuple *sort_array;
2280 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
2281 g_return_if_fail (!GTK_TREE_STORE_IS_SORTED (tree_store));
2282 g_return_if_fail (parent == NULL || VALID_ITER (parent, tree_store));
2283 g_return_if_fail (new_order != NULL);
2286 level = G_NODE (tree_store->priv->root)->children;
2288 level = G_NODE (parent->user_data)->children;
2298 /* set up sortarray */
2299 sort_array = g_new (SortTuple, length);
2302 for (i = 0; i < length; i++)
2304 sort_array[new_order[i]].offset = i;
2305 sort_array[i].node = node;
2310 g_qsort_with_data (sort_array,
2313 gtk_tree_store_reorder_func,
2317 for (i = 0; i < length - 1; i++)
2319 sort_array[i].node->next = sort_array[i+1].node;
2320 sort_array[i+1].node->prev = sort_array[i].node;
2323 sort_array[length-1].node->next = NULL;
2324 sort_array[0].node->prev = NULL;
2326 G_NODE (parent->user_data)->children = sort_array[0].node;
2328 G_NODE (tree_store->priv->root)->children = sort_array[0].node;
2332 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), parent);
2334 path = gtk_tree_path_new ();
2335 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store), path,
2337 gtk_tree_path_free (path);
2338 g_free (sort_array);
2342 * gtk_tree_store_swap:
2343 * @tree_store: A #GtkTreeStore.
2344 * @a: A #GtkTreeIter.
2345 * @b: Another #GtkTreeIter.
2347 * Swaps @a and @b in the same level of @tree_store. Note that this function
2348 * only works with unsorted stores.
2353 gtk_tree_store_swap (GtkTreeStore *tree_store,
2357 GNode *tmp, *node_a, *node_b, *parent_node;
2358 GNode *a_prev, *a_next, *b_prev, *b_next;
2359 gint i, a_count, b_count, length, *order;
2360 GtkTreePath *path_a, *path_b;
2363 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
2364 g_return_if_fail (VALID_ITER (a, tree_store));
2365 g_return_if_fail (VALID_ITER (b, tree_store));
2367 node_a = G_NODE (a->user_data);
2368 node_b = G_NODE (b->user_data);
2370 /* basic sanity checking */
2371 if (node_a == node_b)
2374 path_a = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), a);
2375 path_b = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), b);
2377 g_return_if_fail (path_a && path_b);
2379 gtk_tree_path_up (path_a);
2380 gtk_tree_path_up (path_b);
2382 if (gtk_tree_path_get_depth (path_a) == 0
2383 || gtk_tree_path_get_depth (path_b) == 0)
2385 if (gtk_tree_path_get_depth (path_a) != gtk_tree_path_get_depth (path_b))
2387 gtk_tree_path_free (path_a);
2388 gtk_tree_path_free (path_b);
2390 g_warning ("Given children are not in the same level\n");
2393 parent_node = G_NODE (tree_store->priv->root);
2397 if (gtk_tree_path_compare (path_a, path_b))
2399 gtk_tree_path_free (path_a);
2400 gtk_tree_path_free (path_b);
2402 g_warning ("Given children don't have a common parent\n");
2405 gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store), &parent,
2407 parent_node = G_NODE (parent.user_data);
2409 gtk_tree_path_free (path_b);
2411 /* old links which we have to keep around */
2412 a_prev = node_a->prev;
2413 a_next = node_a->next;
2415 b_prev = node_b->prev;
2416 b_next = node_b->next;
2418 /* fix up links if the nodes are next to eachother */
2419 if (a_prev == node_b)
2421 if (a_next == node_b)
2424 if (b_prev == node_a)
2426 if (b_next == node_a)
2429 /* counting nodes */
2430 tmp = parent_node->children;
2431 i = a_count = b_count = 0;
2444 /* hacking the tree */
2446 parent_node->children = node_b;
2448 a_prev->next = node_b;
2451 a_next->prev = node_b;
2454 parent_node->children = node_a;
2456 b_prev->next = node_a;
2459 b_next->prev = node_a;
2461 node_a->prev = b_prev;
2462 node_a->next = b_next;
2464 node_b->prev = a_prev;
2465 node_b->next = a_next;
2468 order = g_new (gint, length);
2469 for (i = 0; i < length; i++)
2472 else if (i == b_count)
2477 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store), path_a,
2478 parent_node == tree_store->priv->root
2479 ? NULL : &parent, order);
2480 gtk_tree_path_free (path_a);
2484 /* WARNING: this function is *incredibly* fragile. Please smashtest after
2485 * making changes here.
2489 gtk_tree_store_move (GtkTreeStore *tree_store,
2491 GtkTreeIter *position,
2494 GNode *parent, *node, *a, *b, *tmp, *tmp_a, *tmp_b;
2495 gint old_pos, new_pos, length, i, *order;
2496 GtkTreePath *path = NULL, *tmppath, *pos_path = NULL;
2497 GtkTreeIter parent_iter, dst_a, dst_b;
2499 gboolean handle_b = TRUE;
2501 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
2502 g_return_if_fail (!GTK_TREE_STORE_IS_SORTED (tree_store));
2503 g_return_if_fail (VALID_ITER (iter, tree_store));
2505 g_return_if_fail (VALID_ITER (position, tree_store));
2512 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
2513 pos_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store),
2517 * moving the iter before path or "path + 1" doesn't make sense
2519 * moving the iter before path or "path - 1" doesn't make sense
2521 if (!gtk_tree_path_compare (path, pos_path))
2522 goto free_paths_and_out;
2525 gtk_tree_path_next (path);
2527 gtk_tree_path_prev (path);
2529 if (!gtk_tree_path_compare (path, pos_path))
2530 goto free_paths_and_out;
2533 gtk_tree_path_prev (path);
2535 gtk_tree_path_next (path);
2537 if (gtk_tree_path_get_depth (path) != gtk_tree_path_get_depth (pos_path))
2539 g_warning ("Given children are not in the same level\n");
2541 goto free_paths_and_out;
2544 tmppath = gtk_tree_path_copy (pos_path);
2545 gtk_tree_path_up (path);
2546 gtk_tree_path_up (tmppath);
2548 if (gtk_tree_path_get_depth (path) > 0 &&
2549 gtk_tree_path_compare (path, tmppath))
2551 g_warning ("Given children are not in the same level\n");
2553 gtk_tree_path_free (tmppath);
2554 goto free_paths_and_out;
2557 gtk_tree_path_free (tmppath);
2562 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
2563 gtk_tree_path_up (path);
2566 depth = gtk_tree_path_get_depth (path);
2570 gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store),
2571 &parent_iter, path);
2573 parent = G_NODE (parent_iter.user_data);
2576 parent = G_NODE (tree_store->priv->root);
2578 /* yes, I know that this can be done shorter, but I'm doing it this way
2579 * so the code is also maintainable
2582 if (before && position)
2584 b = G_NODE (position->user_data);
2586 if (gtk_tree_path_get_indices (pos_path)[gtk_tree_path_get_depth (pos_path) - 1] > 0)
2588 gtk_tree_path_prev (pos_path);
2589 if (gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store),
2591 a = G_NODE (dst_a.user_data);
2594 gtk_tree_path_next (pos_path);
2597 /* if b is NULL, a is NULL too -- we are at the beginning of the list
2598 * yes and we leak memory here ...
2600 g_return_if_fail (b);
2602 else if (before && !position)
2604 /* move before without position is appending */
2611 a = G_NODE (position->user_data);
2617 gtk_tree_path_next (pos_path);
2618 if (gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store), &dst_b, pos_path))
2619 b = G_NODE (dst_b.user_data);
2622 gtk_tree_path_prev (pos_path);
2626 /* move after without position is prepending */
2628 gtk_tree_store_iter_children (GTK_TREE_MODEL (tree_store), &dst_b,
2631 gtk_tree_store_iter_children (GTK_TREE_MODEL (tree_store), &dst_b,
2634 b = G_NODE (dst_b.user_data);
2637 /* if a is NULL, b is NULL too -- we are at the end of the list
2638 * yes and we leak memory here ...
2641 g_return_if_fail (a);
2644 /* counting nodes */
2645 tmp = parent->children;
2647 length = old_pos = 0;
2650 if (tmp == iter->user_data)
2657 /* remove node from list */
2658 node = G_NODE (iter->user_data);
2663 tmp_a->next = tmp_b;
2665 parent->children = tmp_b;
2668 tmp_b->prev = tmp_a;
2670 /* and reinsert the node */
2679 else if (!a && !before)
2681 tmp = parent->children;
2684 parent->children = node;
2692 else if (!a && before)
2696 node->parent = NULL;
2697 node->next = node->prev = NULL;
2699 /* before with sibling = NULL appends */
2700 g_node_insert_before (parent, NULL, node);
2704 node->parent = NULL;
2705 node->next = node->prev = NULL;
2707 /* after with sibling = NULL prepends */
2708 g_node_insert_after (parent, NULL, node);
2724 else if (!(!a && before)) /* !a && before is completely handled above */
2730 new_pos = gtk_tree_path_get_indices (pos_path)[gtk_tree_path_get_depth (pos_path)-1];
2734 new_pos = gtk_tree_store_iter_n_children (GTK_TREE_MODEL (tree_store),
2737 new_pos = gtk_tree_store_iter_n_children (GTK_TREE_MODEL (tree_store),
2743 if (new_pos > old_pos)
2745 if (before && position)
2750 if (!before && position)
2754 order = g_new (gint, length);
2755 if (new_pos > old_pos)
2757 for (i = 0; i < length; i++)
2760 else if (i >= old_pos && i < new_pos)
2762 else if (i == new_pos)
2769 for (i = 0; i < length; i++)
2772 else if (i > new_pos && i <= old_pos)
2780 tmppath = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store),
2782 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2783 tmppath, &parent_iter, order);
2787 tmppath = gtk_tree_path_new ();
2788 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2789 tmppath, NULL, order);
2792 gtk_tree_path_free (tmppath);
2793 gtk_tree_path_free (path);
2795 gtk_tree_path_free (pos_path);
2801 gtk_tree_path_free (path);
2802 gtk_tree_path_free (pos_path);
2806 * gtk_tree_store_move_before:
2807 * @tree_store: A #GtkTreeStore.
2808 * @iter: A #GtkTreeIter.
2809 * @position: (allow-none): A #GtkTreeIter or %NULL.
2811 * Moves @iter in @tree_store to the position before @position. @iter and
2812 * @position should be in the same level. Note that this function only
2813 * works with unsorted stores. If @position is %NULL, @iter will be
2814 * moved to the end of the level.
2819 gtk_tree_store_move_before (GtkTreeStore *tree_store,
2821 GtkTreeIter *position)
2823 gtk_tree_store_move (tree_store, iter, position, TRUE);
2827 * gtk_tree_store_move_after:
2828 * @tree_store: A #GtkTreeStore.
2829 * @iter: A #GtkTreeIter.
2830 * @position: (allow-none): A #GtkTreeIter.
2832 * Moves @iter in @tree_store to the position after @position. @iter and
2833 * @position should be in the same level. Note that this function only
2834 * works with unsorted stores. If @position is %NULL, @iter will be moved
2835 * to the start of the level.
2840 gtk_tree_store_move_after (GtkTreeStore *tree_store,
2842 GtkTreeIter *position)
2844 gtk_tree_store_move (tree_store, iter, position, FALSE);
2849 gtk_tree_store_compare_func (gconstpointer a,
2853 GtkTreeStore *tree_store = user_data;
2854 GtkTreeStorePrivate *priv = tree_store->priv;
2857 GtkTreeIterCompareFunc func;
2864 if (priv->sort_column_id != -1)
2866 GtkTreeDataSortHeader *header;
2868 header = _gtk_tree_data_list_get_header (priv->sort_list,
2869 priv->sort_column_id);
2870 g_return_val_if_fail (header != NULL, 0);
2871 g_return_val_if_fail (header->func != NULL, 0);
2873 func = header->func;
2874 data = header->data;
2878 g_return_val_if_fail (priv->default_sort_func != NULL, 0);
2879 func = priv->default_sort_func;
2880 data = priv->default_sort_data;
2883 node_a = ((SortTuple *) a)->node;
2884 node_b = ((SortTuple *) b)->node;
2886 iter_a.stamp = priv->stamp;
2887 iter_a.user_data = node_a;
2888 iter_b.stamp = priv->stamp;
2889 iter_b.user_data = node_b;
2891 retval = (* func) (GTK_TREE_MODEL (user_data), &iter_a, &iter_b, data);
2893 if (priv->order == GTK_SORT_DESCENDING)
2897 else if (retval < 0)
2904 gtk_tree_store_sort_helper (GtkTreeStore *tree_store,
2917 node = parent->children;
2918 if (node == NULL || node->next == NULL)
2920 if (recurse && node && node->children)
2921 gtk_tree_store_sort_helper (tree_store, node, TRUE);
2927 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
2930 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), list_length);
2933 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
2938 tuple.node = tmp_node;
2939 g_array_append_val (sort_array, tuple);
2943 /* Sort the array */
2944 g_array_sort_with_data (sort_array, gtk_tree_store_compare_func, tree_store);
2946 for (i = 0; i < list_length - 1; i++)
2948 g_array_index (sort_array, SortTuple, i).node->next =
2949 g_array_index (sort_array, SortTuple, i + 1).node;
2950 g_array_index (sort_array, SortTuple, i + 1).node->prev =
2951 g_array_index (sort_array, SortTuple, i).node;
2953 g_array_index (sort_array, SortTuple, list_length - 1).node->next = NULL;
2954 g_array_index (sort_array, SortTuple, 0).node->prev = NULL;
2955 parent->children = g_array_index (sort_array, SortTuple, 0).node;
2957 /* Let the world know about our new order */
2958 new_order = g_new (gint, list_length);
2959 for (i = 0; i < list_length; i++)
2960 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
2962 iter.stamp = tree_store->priv->stamp;
2963 iter.user_data = parent;
2964 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &iter);
2965 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2966 path, &iter, new_order);
2967 gtk_tree_path_free (path);
2969 g_array_free (sort_array, TRUE);
2973 for (tmp_node = parent->children; tmp_node; tmp_node = tmp_node->next)
2975 if (tmp_node->children)
2976 gtk_tree_store_sort_helper (tree_store, tmp_node, TRUE);
2982 gtk_tree_store_sort (GtkTreeStore *tree_store)
2984 GtkTreeStorePrivate *priv = tree_store->priv;
2986 if (!GTK_TREE_STORE_IS_SORTED (tree_store))
2989 if (priv->sort_column_id != -1)
2991 GtkTreeDataSortHeader *header = NULL;
2993 header = _gtk_tree_data_list_get_header (priv->sort_list,
2994 priv->sort_column_id);
2996 /* We want to make sure that we have a function */
2997 g_return_if_fail (header != NULL);
2998 g_return_if_fail (header->func != NULL);
3002 g_return_if_fail (priv->default_sort_func != NULL);
3005 gtk_tree_store_sort_helper (tree_store, G_NODE (priv->root), TRUE);
3009 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
3012 gboolean emit_signal)
3014 GtkTreeStorePrivate *priv = tree_store->priv;
3018 GtkTreePath *tmp_path;
3019 GtkTreeIter tmp_iter;
3027 GtkTreeIterCompareFunc func;
3030 g_return_if_fail (G_NODE (iter->user_data)->parent != NULL);
3032 tmp_iter.stamp = priv->stamp;
3033 if (priv->sort_column_id != -1)
3035 GtkTreeDataSortHeader *header;
3036 header = _gtk_tree_data_list_get_header (priv->sort_list,
3037 priv->sort_column_id);
3038 g_return_if_fail (header != NULL);
3039 g_return_if_fail (header->func != NULL);
3040 func = header->func;
3041 data = header->data;
3045 g_return_if_fail (priv->default_sort_func != NULL);
3046 func = priv->default_sort_func;
3047 data = priv->default_sort_data;
3050 /* If it's the built in function, we don't sort. */
3051 if (func == _gtk_tree_data_list_compare_func &&
3052 priv->sort_column_id != column)
3056 node = G_NODE (iter->user_data)->parent->children;
3057 /* First we find the iter, its prev, and its next */
3060 if (node == G_NODE (iter->user_data))
3065 g_assert (node != NULL);
3070 /* Check the common case, where we don't need to sort it moved. */
3073 tmp_iter.user_data = prev;
3074 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
3079 tmp_iter.user_data = next;
3080 cmp_b = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
3083 if (priv->order == GTK_SORT_DESCENDING)
3096 if (prev == NULL && cmp_b <= 0)
3098 else if (next == NULL && cmp_a <= 0)
3100 else if (prev != NULL && next != NULL &&
3101 cmp_a <= 0 && cmp_b <= 0)
3104 /* We actually need to sort it */
3105 /* First, remove the old link. */
3110 node->parent->children = next;
3118 /* FIXME: as an optimization, we can potentially start at next */
3120 node = node->parent->children;
3122 tmp_iter.user_data = node;
3123 if (priv->order == GTK_SORT_DESCENDING)
3124 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
3126 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
3128 while ((node->next) && (cmp_a > 0))
3133 tmp_iter.user_data = node;
3134 if (priv->order == GTK_SORT_DESCENDING)
3135 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
3137 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
3140 if ((!node->next) && (cmp_a > 0))
3143 node->next = G_NODE (iter->user_data);
3144 node->next->prev = node;
3148 prev->next = G_NODE (iter->user_data);
3149 prev->next->prev = prev;
3150 G_NODE (iter->user_data)->next = node;
3151 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
3155 G_NODE (iter->user_data)->next = G_NODE (iter->user_data)->parent->children;
3156 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
3157 G_NODE (iter->user_data)->parent->children = G_NODE (iter->user_data);
3163 /* Emit the reordered signal. */
3164 length = g_node_n_children (node->parent);
3165 new_order = g_new (int, length);
3166 if (old_location < new_location)
3167 for (i = 0; i < length; i++)
3169 if (i < old_location ||
3172 else if (i >= old_location &&
3174 new_order[i] = i + 1;
3175 else if (i == new_location)
3176 new_order[i] = old_location;
3179 for (i = 0; i < length; i++)
3181 if (i < new_location ||
3184 else if (i > new_location &&
3186 new_order[i] = i - 1;
3187 else if (i == new_location)
3188 new_order[i] = old_location;
3191 tmp_iter.user_data = node->parent;
3192 tmp_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &tmp_iter);
3194 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
3195 tmp_path, &tmp_iter,
3198 gtk_tree_path_free (tmp_path);
3204 gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
3205 gint *sort_column_id,
3208 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3209 GtkTreeStorePrivate *priv = tree_store->priv;
3212 * sort_column_id = priv->sort_column_id;
3214 * order = priv->order;
3216 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
3217 priv->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
3224 gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
3225 gint sort_column_id,
3228 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3229 GtkTreeStorePrivate *priv = tree_store->priv;
3231 if ((priv->sort_column_id == sort_column_id) &&
3232 (priv->order == order))
3235 if (sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
3237 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
3239 GtkTreeDataSortHeader *header = NULL;
3241 header = _gtk_tree_data_list_get_header (priv->sort_list,
3244 /* We want to make sure that we have a function */
3245 g_return_if_fail (header != NULL);
3246 g_return_if_fail (header->func != NULL);
3250 g_return_if_fail (priv->default_sort_func != NULL);
3254 priv->sort_column_id = sort_column_id;
3255 priv->order = order;
3257 gtk_tree_sortable_sort_column_changed (sortable);
3259 gtk_tree_store_sort (tree_store);
3263 gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
3264 gint sort_column_id,
3265 GtkTreeIterCompareFunc func,
3267 GDestroyNotify destroy)
3269 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3270 GtkTreeStorePrivate *priv = tree_store->priv;
3272 priv->sort_list = _gtk_tree_data_list_set_header (priv->sort_list,
3274 func, data, destroy);
3276 if (priv->sort_column_id == sort_column_id)
3277 gtk_tree_store_sort (tree_store);
3281 gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
3282 GtkTreeIterCompareFunc func,
3284 GDestroyNotify destroy)
3286 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3287 GtkTreeStorePrivate *priv = tree_store->priv;
3289 if (priv->default_sort_destroy)
3291 GDestroyNotify d = priv->default_sort_destroy;
3293 priv->default_sort_destroy = NULL;
3294 d (priv->default_sort_data);
3297 priv->default_sort_func = func;
3298 priv->default_sort_data = data;
3299 priv->default_sort_destroy = destroy;
3301 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
3302 gtk_tree_store_sort (tree_store);
3306 gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable)
3308 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3310 return (tree_store->priv->default_sort_func != NULL);
3314 validate_gnode (GNode* node)
3318 iter = node->children;
3319 while (iter != NULL)
3321 g_assert (iter->parent == node);
3323 g_assert (iter->prev->next == iter);
3324 validate_gnode (iter);
3329 /* GtkBuildable custom tag implementation
3332 * <column type="..."/>
3333 * <column type="..."/>
3337 GtkBuilder *builder;
3340 } GSListSubParserData;
3343 tree_model_start_element (GMarkupParseContext *context,
3344 const gchar *element_name,
3345 const gchar **names,
3346 const gchar **values,
3351 GSListSubParserData *data = (GSListSubParserData*)user_data;
3353 for (i = 0; names[i]; i++)
3355 if (strcmp (names[i], "type") == 0)
3356 data->items = g_slist_prepend (data->items, g_strdup (values[i]));
3361 tree_model_end_element (GMarkupParseContext *context,
3362 const gchar *element_name,
3366 GSListSubParserData *data = (GSListSubParserData*)user_data;
3368 g_assert(data->builder);
3370 if (strcmp (element_name, "columns") == 0)
3377 data = (GSListSubParserData*)user_data;
3378 data->items = g_slist_reverse (data->items);
3379 types = g_new0 (GType, g_slist_length (data->items));
3381 for (l = data->items, i = 0; l; l = l->next, i++)
3383 type = gtk_builder_get_type_from_name (data->builder, l->data);
3384 if (type == G_TYPE_INVALID)
3386 g_warning ("Unknown type %s specified in treemodel %s",
3387 (const gchar*)l->data,
3388 gtk_buildable_get_name (GTK_BUILDABLE (data->object)));
3396 gtk_tree_store_set_column_types (GTK_TREE_STORE (data->object), i, types);
3402 static const GMarkupParser tree_model_parser =
3404 tree_model_start_element,
3405 tree_model_end_element
3410 gtk_tree_store_buildable_custom_tag_start (GtkBuildable *buildable,
3411 GtkBuilder *builder,
3413 const gchar *tagname,
3414 GMarkupParser *parser,
3417 GSListSubParserData *parser_data;
3422 if (strcmp (tagname, "columns") == 0)
3424 parser_data = g_slice_new0 (GSListSubParserData);
3425 parser_data->builder = builder;
3426 parser_data->items = NULL;
3427 parser_data->object = G_OBJECT (buildable);
3429 *parser = tree_model_parser;
3430 *data = parser_data;
3438 gtk_tree_store_buildable_custom_finished (GtkBuildable *buildable,
3439 GtkBuilder *builder,
3441 const gchar *tagname,
3444 GSListSubParserData *data;
3446 if (strcmp (tagname, "columns"))
3449 data = (GSListSubParserData*)user_data;
3451 g_slist_free (data->items);
3452 g_slice_free (GSListSubParserData, data);