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.
22 #include <gobject/gvaluecollector.h>
23 #include "gtktreemodel.h"
24 #include "gtktreestore.h"
25 #include "gtktreedatalist.h"
26 #include "gtktreednd.h"
27 #include "gtkbuildable.h"
33 * SECTION:gtktreestore
34 * @Short_description: A tree-like data structure that can be used with the GtkTreeView
35 * @Title: GtkTreeStore
36 * @See_also: #GtkTreeModel
38 * The #GtkTreeStore object is a list model for use with a #GtkTreeView
39 * widget. It implements the #GtkTreeModel interface, and consequentialy,
40 * can use all of the methods available there. It also implements the
41 * #GtkTreeSortable interface so it can be sorted by the view. Finally,
42 * it also implements the tree <link linkend="gtktreednd">drag and
43 * drop</link> interfaces.
45 * <refsect2 id="GtkTreeStore-BUILDER-UI">
46 * <title>GtkTreeStore as GtkBuildable</title>
47 * The GtkTreeStore implementation of the #GtkBuildable interface allows
48 * to specify the model columns with a <columns> element that may
49 * contain multiple <column> elements, each specifying one model
50 * column. The "type" attribute specifies the data type for the column.
52 * <title>A UI Definition fragment for a tree store</title>
53 * <programlisting><![CDATA[
54 * <object class="GtkTreeStore">
56 * <column type="gchararray"/>
57 * <column type="gchararray"/>
58 * <column type="gint"/>
61 * ]]></programlisting>
66 struct _GtkTreeStorePrivate
75 GType *column_headers;
76 GtkTreeIterCompareFunc default_sort_func;
77 gpointer default_sort_data;
78 GDestroyNotify default_sort_destroy;
79 guint columns_dirty : 1;
83 #define G_NODE(node) ((GNode *)node)
84 #define GTK_TREE_STORE_IS_SORTED(tree) (((GtkTreeStore*)(tree))->priv->sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
85 #define VALID_ITER(iter, tree_store) ((iter)!= NULL && (iter)->user_data != NULL && ((GtkTreeStore*)(tree_store))->priv->stamp == (iter)->stamp)
87 static void gtk_tree_store_tree_model_init (GtkTreeModelIface *iface);
88 static void gtk_tree_store_drag_source_init(GtkTreeDragSourceIface *iface);
89 static void gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface);
90 static void gtk_tree_store_sortable_init (GtkTreeSortableIface *iface);
91 static void gtk_tree_store_buildable_init (GtkBuildableIface *iface);
92 static void gtk_tree_store_finalize (GObject *object);
93 static GtkTreeModelFlags gtk_tree_store_get_flags (GtkTreeModel *tree_model);
94 static gint gtk_tree_store_get_n_columns (GtkTreeModel *tree_model);
95 static GType gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
97 static gboolean gtk_tree_store_get_iter (GtkTreeModel *tree_model,
100 static GtkTreePath *gtk_tree_store_get_path (GtkTreeModel *tree_model,
102 static void gtk_tree_store_get_value (GtkTreeModel *tree_model,
106 static gboolean gtk_tree_store_iter_next (GtkTreeModel *tree_model,
108 static gboolean gtk_tree_store_iter_previous (GtkTreeModel *tree_model,
110 static gboolean gtk_tree_store_iter_children (GtkTreeModel *tree_model,
112 GtkTreeIter *parent);
113 static gboolean gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
115 static gint gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
117 static gboolean gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
121 static gboolean gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
126 static void gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
128 static void gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
132 static void gtk_tree_store_increment_stamp (GtkTreeStore *tree_store);
136 static gboolean real_gtk_tree_store_row_draggable (GtkTreeDragSource *drag_source,
138 static gboolean gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
140 static gboolean gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
142 GtkSelectionData *selection_data);
143 static gboolean gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
145 GtkSelectionData *selection_data);
146 static gboolean gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
147 GtkTreePath *dest_path,
148 GtkSelectionData *selection_data);
150 /* Sortable Interfaces */
152 static void gtk_tree_store_sort (GtkTreeStore *tree_store);
153 static void gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
156 gboolean emit_signal);
157 static gboolean gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
158 gint *sort_column_id,
160 static void gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
163 static void gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
165 GtkTreeIterCompareFunc func,
167 GDestroyNotify destroy);
168 static void gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
169 GtkTreeIterCompareFunc func,
171 GDestroyNotify destroy);
172 static gboolean gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable);
177 static gboolean gtk_tree_store_buildable_custom_tag_start (GtkBuildable *buildable,
180 const gchar *tagname,
181 GMarkupParser *parser,
183 static void gtk_tree_store_buildable_custom_finished (GtkBuildable *buildable,
186 const gchar *tagname,
189 static void validate_gnode (GNode *node);
191 static void gtk_tree_store_move (GtkTreeStore *tree_store,
193 GtkTreeIter *position,
198 validate_tree (GtkTreeStore *tree_store)
200 if (gtk_get_debug_flags () & GTK_DEBUG_TREE)
202 g_assert (G_NODE (tree_store->priv->root)->parent == NULL);
204 validate_gnode (G_NODE (tree_store->priv->root));
208 G_DEFINE_TYPE_WITH_CODE (GtkTreeStore, gtk_tree_store, G_TYPE_OBJECT,
209 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
210 gtk_tree_store_tree_model_init)
211 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
212 gtk_tree_store_drag_source_init)
213 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_DEST,
214 gtk_tree_store_drag_dest_init)
215 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_SORTABLE,
216 gtk_tree_store_sortable_init)
217 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
218 gtk_tree_store_buildable_init))
221 gtk_tree_store_class_init (GtkTreeStoreClass *class)
223 GObjectClass *object_class;
225 object_class = (GObjectClass *) class;
227 object_class->finalize = gtk_tree_store_finalize;
229 g_type_class_add_private (class, sizeof (GtkTreeStorePrivate));
233 gtk_tree_store_tree_model_init (GtkTreeModelIface *iface)
235 iface->get_flags = gtk_tree_store_get_flags;
236 iface->get_n_columns = gtk_tree_store_get_n_columns;
237 iface->get_column_type = gtk_tree_store_get_column_type;
238 iface->get_iter = gtk_tree_store_get_iter;
239 iface->get_path = gtk_tree_store_get_path;
240 iface->get_value = gtk_tree_store_get_value;
241 iface->iter_next = gtk_tree_store_iter_next;
242 iface->iter_previous = gtk_tree_store_iter_previous;
243 iface->iter_children = gtk_tree_store_iter_children;
244 iface->iter_has_child = gtk_tree_store_iter_has_child;
245 iface->iter_n_children = gtk_tree_store_iter_n_children;
246 iface->iter_nth_child = gtk_tree_store_iter_nth_child;
247 iface->iter_parent = gtk_tree_store_iter_parent;
251 gtk_tree_store_drag_source_init (GtkTreeDragSourceIface *iface)
253 iface->row_draggable = real_gtk_tree_store_row_draggable;
254 iface->drag_data_delete = gtk_tree_store_drag_data_delete;
255 iface->drag_data_get = gtk_tree_store_drag_data_get;
259 gtk_tree_store_drag_dest_init (GtkTreeDragDestIface *iface)
261 iface->drag_data_received = gtk_tree_store_drag_data_received;
262 iface->row_drop_possible = gtk_tree_store_row_drop_possible;
266 gtk_tree_store_sortable_init (GtkTreeSortableIface *iface)
268 iface->get_sort_column_id = gtk_tree_store_get_sort_column_id;
269 iface->set_sort_column_id = gtk_tree_store_set_sort_column_id;
270 iface->set_sort_func = gtk_tree_store_set_sort_func;
271 iface->set_default_sort_func = gtk_tree_store_set_default_sort_func;
272 iface->has_default_sort_func = gtk_tree_store_has_default_sort_func;
276 gtk_tree_store_buildable_init (GtkBuildableIface *iface)
278 iface->custom_tag_start = gtk_tree_store_buildable_custom_tag_start;
279 iface->custom_finished = gtk_tree_store_buildable_custom_finished;
283 gtk_tree_store_init (GtkTreeStore *tree_store)
285 GtkTreeStorePrivate *priv;
287 priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_store,
289 GtkTreeStorePrivate);
290 tree_store->priv = priv;
291 priv->root = g_node_new (NULL);
292 /* While the odds are against us getting 0... */
295 priv->stamp = g_random_int ();
297 while (priv->stamp == 0);
299 priv->sort_list = NULL;
300 priv->sort_column_id = GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID;
301 priv->columns_dirty = FALSE;
305 * gtk_tree_store_new:
306 * @n_columns: number of columns in the tree store
307 * @...: all #GType types for the columns, from first to last
309 * Creates a new tree store as with @n_columns columns each of the types passed
310 * in. Note that only types derived from standard GObject fundamental types
313 * As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
314 * GDK_TYPE_PIXBUF);</literal> will create a new #GtkTreeStore with three columns, of type
315 * <type>int</type>, <type>string</type> and #GdkPixbuf respectively.
317 * Return value: a new #GtkTreeStore
320 gtk_tree_store_new (gint n_columns,
323 GtkTreeStore *retval;
327 g_return_val_if_fail (n_columns > 0, NULL);
329 retval = g_object_new (GTK_TYPE_TREE_STORE, NULL);
330 gtk_tree_store_set_n_columns (retval, n_columns);
332 va_start (args, n_columns);
334 for (i = 0; i < n_columns; i++)
336 GType type = va_arg (args, GType);
337 if (! _gtk_tree_data_list_check_type (type))
339 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (type));
340 g_object_unref (retval);
344 gtk_tree_store_set_column_type (retval, i, type);
351 * gtk_tree_store_newv:
352 * @n_columns: number of columns in the tree store
353 * @types: (array length=n_columns): an array of #GType types for the columns, from first to last
355 * Non vararg creation function. Used primarily by language bindings.
357 * Return value: (transfer full): a new #GtkTreeStore
358 * Rename to: gtk_tree_store_new
361 gtk_tree_store_newv (gint n_columns,
364 GtkTreeStore *retval;
367 g_return_val_if_fail (n_columns > 0, NULL);
369 retval = g_object_new (GTK_TYPE_TREE_STORE, NULL);
370 gtk_tree_store_set_n_columns (retval, n_columns);
372 for (i = 0; i < n_columns; i++)
374 if (! _gtk_tree_data_list_check_type (types[i]))
376 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (types[i]));
377 g_object_unref (retval);
380 gtk_tree_store_set_column_type (retval, i, types[i]);
388 * gtk_tree_store_set_column_types:
389 * @tree_store: A #GtkTreeStore
390 * @n_columns: Number of columns for the tree store
391 * @types: (array length=n_columns): An array of #GType types, one for each column
393 * This function is meant primarily for #GObjects that inherit from
394 * #GtkTreeStore, and should only be used when constructing a new
395 * #GtkTreeStore. It will not function after a row has been added,
396 * or a method on the #GtkTreeModel interface is called.
399 gtk_tree_store_set_column_types (GtkTreeStore *tree_store,
405 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
406 g_return_if_fail (tree_store->priv->columns_dirty == 0);
408 gtk_tree_store_set_n_columns (tree_store, n_columns);
409 for (i = 0; i < n_columns; i++)
411 if (! _gtk_tree_data_list_check_type (types[i]))
413 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (types[i]));
416 gtk_tree_store_set_column_type (tree_store, i, types[i]);
421 gtk_tree_store_set_n_columns (GtkTreeStore *tree_store,
424 GtkTreeStorePrivate *priv = tree_store->priv;
427 if (priv->n_columns == n_columns)
430 priv->column_headers = g_renew (GType, priv->column_headers, n_columns);
431 for (i = priv->n_columns; i < n_columns; i++)
432 priv->column_headers[i] = G_TYPE_INVALID;
433 priv->n_columns = n_columns;
436 _gtk_tree_data_list_header_free (priv->sort_list);
438 priv->sort_list = _gtk_tree_data_list_header_new (n_columns, priv->column_headers);
442 * gtk_tree_store_set_column_type:
443 * @tree_store: a #GtkTreeStore
444 * @column: column number
445 * @type: type of the data to be stored in @column
447 * Supported types include: %G_TYPE_UINT, %G_TYPE_INT, %G_TYPE_UCHAR,
448 * %G_TYPE_CHAR, %G_TYPE_BOOLEAN, %G_TYPE_POINTER, %G_TYPE_FLOAT,
449 * %G_TYPE_DOUBLE, %G_TYPE_STRING, %G_TYPE_OBJECT, and %G_TYPE_BOXED, along with
450 * subclasses of those types such as %GDK_TYPE_PIXBUF.
454 gtk_tree_store_set_column_type (GtkTreeStore *tree_store,
458 GtkTreeStorePrivate *priv = tree_store->priv;
460 if (!_gtk_tree_data_list_check_type (type))
462 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (type));
465 priv->column_headers[column] = type;
469 node_free (GNode *node, gpointer data)
472 _gtk_tree_data_list_free (node->data, (GType*)data);
479 gtk_tree_store_finalize (GObject *object)
481 GtkTreeStore *tree_store = GTK_TREE_STORE (object);
482 GtkTreeStorePrivate *priv = tree_store->priv;
484 g_node_traverse (priv->root, G_POST_ORDER, G_TRAVERSE_ALL, -1,
485 node_free, priv->column_headers);
486 g_node_destroy (priv->root);
487 _gtk_tree_data_list_header_free (priv->sort_list);
488 g_free (priv->column_headers);
490 if (priv->default_sort_destroy)
492 GDestroyNotify d = priv->default_sort_destroy;
494 priv->default_sort_destroy = NULL;
495 d (priv->default_sort_data);
496 priv->default_sort_data = NULL;
500 G_OBJECT_CLASS (gtk_tree_store_parent_class)->finalize (object);
503 /* fulfill the GtkTreeModel requirements */
504 /* NOTE: GtkTreeStore::root is a GNode, that acts as the parent node. However,
505 * it is not visible to the tree or to the user., and the path "0" refers to the
506 * first child of GtkTreeStore::root.
510 static GtkTreeModelFlags
511 gtk_tree_store_get_flags (GtkTreeModel *tree_model)
513 return GTK_TREE_MODEL_ITERS_PERSIST;
517 gtk_tree_store_get_n_columns (GtkTreeModel *tree_model)
519 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
520 GtkTreeStorePrivate *priv = tree_store->priv;
522 priv->columns_dirty = TRUE;
524 return priv->n_columns;
528 gtk_tree_store_get_column_type (GtkTreeModel *tree_model,
531 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
532 GtkTreeStorePrivate *priv = tree_store->priv;
534 g_return_val_if_fail (index < priv->n_columns, G_TYPE_INVALID);
536 priv->columns_dirty = TRUE;
538 return priv->column_headers[index];
542 gtk_tree_store_get_iter (GtkTreeModel *tree_model,
546 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
547 GtkTreeStorePrivate *priv = tree_store->priv;
552 priv->columns_dirty = TRUE;
554 indices = gtk_tree_path_get_indices (path);
555 depth = gtk_tree_path_get_depth (path);
557 g_return_val_if_fail (depth > 0, FALSE);
559 parent.stamp = priv->stamp;
560 parent.user_data = priv->root;
562 if (!gtk_tree_store_iter_nth_child (tree_model, iter, &parent, indices[0]))
568 for (i = 1; i < depth; i++)
571 if (!gtk_tree_store_iter_nth_child (tree_model, iter, &parent, indices[i]))
582 gtk_tree_store_get_path (GtkTreeModel *tree_model,
585 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
586 GtkTreeStorePrivate *priv = tree_store->priv;
591 g_return_val_if_fail (iter->user_data != NULL, NULL);
592 g_return_val_if_fail (iter->stamp == priv->stamp, NULL);
594 validate_tree (tree_store);
596 if (G_NODE (iter->user_data)->parent == NULL &&
597 G_NODE (iter->user_data) == priv->root)
598 return gtk_tree_path_new ();
599 g_assert (G_NODE (iter->user_data)->parent != NULL);
601 if (G_NODE (iter->user_data)->parent == G_NODE (priv->root))
603 retval = gtk_tree_path_new ();
604 tmp_node = G_NODE (priv->root)->children;
608 GtkTreeIter tmp_iter = *iter;
610 tmp_iter.user_data = G_NODE (iter->user_data)->parent;
612 retval = gtk_tree_store_get_path (tree_model, &tmp_iter);
613 tmp_node = G_NODE (iter->user_data)->parent->children;
619 if (tmp_node == NULL)
621 gtk_tree_path_free (retval);
625 for (; tmp_node; tmp_node = tmp_node->next)
627 if (tmp_node == G_NODE (iter->user_data))
632 if (tmp_node == NULL)
634 /* We couldn't find node, meaning it's prolly not ours */
635 /* Perhaps I should do a g_return_if_fail here. */
636 gtk_tree_path_free (retval);
640 gtk_tree_path_append_index (retval, i);
647 gtk_tree_store_get_value (GtkTreeModel *tree_model,
652 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
653 GtkTreeStorePrivate *priv = tree_store->priv;
654 GtkTreeDataList *list;
655 gint tmp_column = column;
657 g_return_if_fail (column < priv->n_columns);
658 g_return_if_fail (VALID_ITER (iter, tree_store));
660 list = G_NODE (iter->user_data)->data;
662 while (tmp_column-- > 0 && list)
667 _gtk_tree_data_list_node_to_value (list,
668 priv->column_headers[column],
673 /* We want to return an initialized but empty (default) value */
674 g_value_init (value, priv->column_headers[column]);
679 gtk_tree_store_iter_next (GtkTreeModel *tree_model,
682 g_return_val_if_fail (iter->user_data != NULL, FALSE);
683 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->priv->stamp, FALSE);
685 if (G_NODE (iter->user_data)->next == NULL)
691 iter->user_data = G_NODE (iter->user_data)->next;
697 gtk_tree_store_iter_previous (GtkTreeModel *tree_model,
700 g_return_val_if_fail (iter->user_data != NULL, FALSE);
701 g_return_val_if_fail (iter->stamp == GTK_TREE_STORE (tree_model)->priv->stamp, FALSE);
703 if (G_NODE (iter->user_data)->prev == NULL)
709 iter->user_data = G_NODE (iter->user_data)->prev;
715 gtk_tree_store_iter_children (GtkTreeModel *tree_model,
719 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
720 GtkTreeStorePrivate *priv = tree_store->priv;
724 g_return_val_if_fail (VALID_ITER (parent, tree_store), FALSE);
727 children = G_NODE (parent->user_data)->children;
729 children = G_NODE (priv->root)->children;
733 iter->stamp = priv->stamp;
734 iter->user_data = children;
745 gtk_tree_store_iter_has_child (GtkTreeModel *tree_model,
748 g_return_val_if_fail (iter->user_data != NULL, FALSE);
749 g_return_val_if_fail (VALID_ITER (iter, tree_model), FALSE);
751 return G_NODE (iter->user_data)->children != NULL;
755 gtk_tree_store_iter_n_children (GtkTreeModel *tree_model,
761 g_return_val_if_fail (iter == NULL || iter->user_data != NULL, 0);
764 node = G_NODE (GTK_TREE_STORE (tree_model)->priv->root)->children;
766 node = G_NODE (iter->user_data)->children;
778 gtk_tree_store_iter_nth_child (GtkTreeModel *tree_model,
783 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
784 GtkTreeStorePrivate *priv = tree_store->priv;
788 g_return_val_if_fail (parent == NULL || parent->user_data != NULL, FALSE);
791 parent_node = priv->root;
793 parent_node = parent->user_data;
795 child = g_node_nth_child (parent_node, n);
799 iter->user_data = child;
800 iter->stamp = priv->stamp;
811 gtk_tree_store_iter_parent (GtkTreeModel *tree_model,
815 GtkTreeStore *tree_store = (GtkTreeStore *) tree_model;
816 GtkTreeStorePrivate *priv = tree_store->priv;
819 g_return_val_if_fail (iter != NULL, FALSE);
820 g_return_val_if_fail (VALID_ITER (child, tree_store), FALSE);
822 parent = G_NODE (child->user_data)->parent;
824 g_assert (parent != NULL);
826 if (parent != priv->root)
828 iter->user_data = parent;
829 iter->stamp = priv->stamp;
840 /* Does not emit a signal */
842 gtk_tree_store_real_set_value (GtkTreeStore *tree_store,
848 GtkTreeStorePrivate *priv = tree_store->priv;
849 GtkTreeDataList *list;
850 GtkTreeDataList *prev;
851 gint old_column = column;
852 GValue real_value = G_VALUE_INIT;
853 gboolean converted = FALSE;
854 gboolean retval = FALSE;
856 if (! g_type_is_a (G_VALUE_TYPE (value), priv->column_headers[column]))
858 if (! (g_value_type_compatible (G_VALUE_TYPE (value), priv->column_headers[column]) &&
859 g_value_type_compatible (priv->column_headers[column], G_VALUE_TYPE (value))))
861 g_warning ("%s: Unable to convert from %s to %s\n",
863 g_type_name (G_VALUE_TYPE (value)),
864 g_type_name (priv->column_headers[column]));
867 if (!g_value_transform (value, &real_value))
869 g_warning ("%s: Unable to make conversion from %s to %s\n",
871 g_type_name (G_VALUE_TYPE (value)),
872 g_type_name (priv->column_headers[column]));
873 g_value_unset (&real_value);
879 prev = list = G_NODE (iter->user_data)->data;
886 _gtk_tree_data_list_value_to_node (list, &real_value);
888 _gtk_tree_data_list_value_to_node (list, value);
891 g_value_unset (&real_value);
892 if (sort && GTK_TREE_STORE_IS_SORTED (tree_store))
893 gtk_tree_store_sort_iter_changed (tree_store, iter, old_column, TRUE);
902 if (G_NODE (iter->user_data)->data == NULL)
904 G_NODE (iter->user_data)->data = list = _gtk_tree_data_list_alloc ();
909 list = prev->next = _gtk_tree_data_list_alloc ();
915 list->next = _gtk_tree_data_list_alloc ();
922 _gtk_tree_data_list_value_to_node (list, &real_value);
924 _gtk_tree_data_list_value_to_node (list, value);
928 g_value_unset (&real_value);
930 if (sort && GTK_TREE_STORE_IS_SORTED (tree_store))
931 gtk_tree_store_sort_iter_changed (tree_store, iter, old_column, TRUE);
937 * gtk_tree_store_set_value:
938 * @tree_store: a #GtkTreeStore
939 * @iter: A valid #GtkTreeIter for the row being modified
940 * @column: column number to modify
941 * @value: new value for the cell
943 * Sets the data in the cell specified by @iter and @column.
944 * The type of @value must be convertible to the type of the
949 gtk_tree_store_set_value (GtkTreeStore *tree_store,
954 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
955 g_return_if_fail (VALID_ITER (iter, tree_store));
956 g_return_if_fail (column >= 0 && column < tree_store->priv->n_columns);
957 g_return_if_fail (G_IS_VALUE (value));
959 if (gtk_tree_store_real_set_value (tree_store, iter, column, value, TRUE))
963 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
964 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
965 gtk_tree_path_free (path);
969 static GtkTreeIterCompareFunc
970 gtk_tree_store_get_compare_func (GtkTreeStore *tree_store)
972 GtkTreeStorePrivate *priv = tree_store->priv;
973 GtkTreeIterCompareFunc func = NULL;
975 if (GTK_TREE_STORE_IS_SORTED (tree_store))
977 if (priv->sort_column_id != -1)
979 GtkTreeDataSortHeader *header;
980 header = _gtk_tree_data_list_get_header (priv->sort_list,
981 priv->sort_column_id);
982 g_return_val_if_fail (header != NULL, NULL);
983 g_return_val_if_fail (header->func != NULL, NULL);
988 func = priv->default_sort_func;
996 gtk_tree_store_set_vector_internal (GtkTreeStore *tree_store,
998 gboolean *emit_signal,
999 gboolean *maybe_need_sort,
1004 GtkTreeStorePrivate *priv = tree_store->priv;
1006 GtkTreeIterCompareFunc func = NULL;
1008 func = gtk_tree_store_get_compare_func (tree_store);
1009 if (func != _gtk_tree_data_list_compare_func)
1010 *maybe_need_sort = TRUE;
1012 for (i = 0; i < n_values; i++)
1014 *emit_signal = gtk_tree_store_real_set_value (tree_store, iter,
1015 columns[i], &values[i],
1016 FALSE) || *emit_signal;
1018 if (func == _gtk_tree_data_list_compare_func &&
1019 columns[i] == priv->sort_column_id)
1020 *maybe_need_sort = TRUE;
1025 gtk_tree_store_set_valist_internal (GtkTreeStore *tree_store,
1027 gboolean *emit_signal,
1028 gboolean *maybe_need_sort,
1031 GtkTreeStorePrivate *priv = tree_store->priv;
1033 GtkTreeIterCompareFunc func = NULL;
1035 column = va_arg (var_args, gint);
1037 func = gtk_tree_store_get_compare_func (tree_store);
1038 if (func != _gtk_tree_data_list_compare_func)
1039 *maybe_need_sort = TRUE;
1041 while (column != -1)
1043 GValue value = G_VALUE_INIT;
1044 gchar *error = NULL;
1046 if (column < 0 || column >= priv->n_columns)
1048 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
1052 G_VALUE_COLLECT_INIT (&value, priv->column_headers[column],
1053 var_args, 0, &error);
1056 g_warning ("%s: %s", G_STRLOC, error);
1059 /* we purposely leak the value here, it might not be
1060 * in a sane state if an error condition occoured
1065 *emit_signal = gtk_tree_store_real_set_value (tree_store,
1069 FALSE) || *emit_signal;
1071 if (func == _gtk_tree_data_list_compare_func &&
1072 column == priv->sort_column_id)
1073 *maybe_need_sort = TRUE;
1075 g_value_unset (&value);
1077 column = va_arg (var_args, gint);
1082 * gtk_tree_store_set_valuesv:
1083 * @tree_store: A #GtkTreeStore
1084 * @iter: A valid #GtkTreeIter for the row being modified
1085 * @columns: (array length=n_values): an array of column numbers
1086 * @values: (array length=n_values): an array of GValues
1087 * @n_values: the length of the @columns and @values arrays
1089 * A variant of gtk_tree_store_set_valist() which takes
1090 * the columns and values as two arrays, instead of varargs. This
1091 * function is mainly intended for language bindings or in case
1092 * the number of columns to change is not known until run-time.
1095 * Rename to: gtk_tree_store_set
1098 gtk_tree_store_set_valuesv (GtkTreeStore *tree_store,
1104 GtkTreeStorePrivate *priv = tree_store->priv;
1105 gboolean emit_signal = FALSE;
1106 gboolean maybe_need_sort = FALSE;
1108 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1109 g_return_if_fail (VALID_ITER (iter, tree_store));
1111 gtk_tree_store_set_vector_internal (tree_store, iter,
1114 columns, values, n_values);
1116 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1117 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, TRUE);
1123 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1124 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
1125 gtk_tree_path_free (path);
1130 * gtk_tree_store_set_valist:
1131 * @tree_store: A #GtkTreeStore
1132 * @iter: A valid #GtkTreeIter for the row being modified
1133 * @var_args: <type>va_list</type> of column/value pairs
1135 * See gtk_tree_store_set(); this version takes a <type>va_list</type> for
1136 * use by language bindings.
1140 gtk_tree_store_set_valist (GtkTreeStore *tree_store,
1144 GtkTreeStorePrivate *priv = tree_store->priv;
1145 gboolean emit_signal = FALSE;
1146 gboolean maybe_need_sort = FALSE;
1148 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1149 g_return_if_fail (VALID_ITER (iter, tree_store));
1151 gtk_tree_store_set_valist_internal (tree_store, iter,
1156 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1157 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, TRUE);
1163 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1164 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, iter);
1165 gtk_tree_path_free (path);
1170 * gtk_tree_store_set:
1171 * @tree_store: A #GtkTreeStore
1172 * @iter: A valid #GtkTreeIter for the row being modified
1173 * @...: pairs of column number and value, terminated with -1
1175 * Sets the value of one or more cells in the row referenced by @iter.
1176 * The variable argument list should contain integer column numbers,
1177 * each column number followed by the value to be set.
1178 * The list is terminated by a -1. For example, to set column 0 with type
1179 * %G_TYPE_STRING to "Foo", you would write
1180 * <literal>gtk_tree_store_set (store, iter, 0, "Foo", -1)</literal>.
1182 * The value will be referenced by the store if it is a %G_TYPE_OBJECT, and it
1183 * will be copied if it is a %G_TYPE_STRING or %G_TYPE_BOXED.
1186 gtk_tree_store_set (GtkTreeStore *tree_store,
1192 va_start (var_args, iter);
1193 gtk_tree_store_set_valist (tree_store, iter, var_args);
1198 * gtk_tree_store_remove:
1199 * @tree_store: A #GtkTreeStore
1200 * @iter: A valid #GtkTreeIter
1202 * Removes @iter from @tree_store. After being removed, @iter is set to the
1203 * next valid row at that level, or invalidated if it previously pointed to the
1206 * Return value: %TRUE if @iter is still valid, %FALSE if not.
1209 gtk_tree_store_remove (GtkTreeStore *tree_store,
1212 GtkTreeStorePrivate *priv = tree_store->priv;
1214 GtkTreeIter new_iter = {0,};
1218 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1219 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1221 parent = G_NODE (iter->user_data)->parent;
1223 g_assert (parent != NULL);
1224 next_node = G_NODE (iter->user_data)->next;
1226 if (G_NODE (iter->user_data)->data)
1227 g_node_traverse (G_NODE (iter->user_data), G_POST_ORDER, G_TRAVERSE_ALL,
1228 -1, node_free, priv->column_headers);
1230 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1231 g_node_destroy (G_NODE (iter->user_data));
1233 gtk_tree_model_row_deleted (GTK_TREE_MODEL (tree_store), path);
1235 if (parent != G_NODE (priv->root))
1238 if (parent->children == NULL)
1240 gtk_tree_path_up (path);
1242 new_iter.stamp = priv->stamp;
1243 new_iter.user_data = parent;
1244 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &new_iter);
1247 gtk_tree_path_free (path);
1249 /* revalidate iter */
1250 if (next_node != NULL)
1252 iter->stamp = priv->stamp;
1253 iter->user_data = next_node;
1259 iter->user_data = NULL;
1266 * gtk_tree_store_insert:
1267 * @tree_store: A #GtkTreeStore
1268 * @iter: (out): An unset #GtkTreeIter to set to the new row
1269 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1270 * @position: position to insert the new row
1272 * Creates a new row at @position. If parent is non-%NULL, then the row will be
1273 * made a child of @parent. Otherwise, the row will be created at the toplevel.
1274 * If @position is larger than the number of rows at that level, then the new
1275 * row will be inserted to the end of the list. @iter will be changed to point
1276 * to this new row. The row will be empty after this function is called. To
1277 * fill in values, you need to call gtk_tree_store_set() or
1278 * gtk_tree_store_set_value().
1282 gtk_tree_store_insert (GtkTreeStore *tree_store,
1284 GtkTreeIter *parent,
1287 GtkTreeStorePrivate *priv = tree_store->priv;
1292 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1293 g_return_if_fail (iter != NULL);
1295 g_return_if_fail (VALID_ITER (parent, tree_store));
1298 parent_node = parent->user_data;
1300 parent_node = priv->root;
1302 priv->columns_dirty = TRUE;
1304 new_node = g_node_new (NULL);
1306 iter->stamp = priv->stamp;
1307 iter->user_data = new_node;
1308 g_node_insert (parent_node, position, new_node);
1310 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1311 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1313 if (parent_node != priv->root)
1315 if (new_node->prev == NULL && new_node->next == NULL)
1317 gtk_tree_path_up (path);
1318 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1322 gtk_tree_path_free (path);
1324 validate_tree ((GtkTreeStore*)tree_store);
1328 * gtk_tree_store_insert_before:
1329 * @tree_store: A #GtkTreeStore
1330 * @iter: (out): An unset #GtkTreeIter to set to the new row
1331 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1332 * @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
1334 * Inserts a new row before @sibling. If @sibling is %NULL, then the row will
1335 * be appended to @parent 's children. If @parent and @sibling are %NULL, then
1336 * the row will be appended to the toplevel. If both @sibling and @parent are
1337 * set, then @parent must be the parent of @sibling. When @sibling is set,
1338 * @parent is optional.
1340 * @iter will be changed to point to this new row. The row will be empty after
1341 * this function is called. To fill in values, you need to call
1342 * gtk_tree_store_set() or gtk_tree_store_set_value().
1346 gtk_tree_store_insert_before (GtkTreeStore *tree_store,
1348 GtkTreeIter *parent,
1349 GtkTreeIter *sibling)
1351 GtkTreeStorePrivate *priv = tree_store->priv;
1353 GNode *parent_node = NULL;
1356 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1357 g_return_if_fail (iter != NULL);
1359 g_return_if_fail (VALID_ITER (parent, tree_store));
1360 if (sibling != NULL)
1361 g_return_if_fail (VALID_ITER (sibling, tree_store));
1363 if (parent == NULL && sibling == NULL)
1364 parent_node = priv->root;
1365 else if (parent == NULL)
1366 parent_node = G_NODE (sibling->user_data)->parent;
1367 else if (sibling == NULL)
1368 parent_node = G_NODE (parent->user_data);
1371 g_return_if_fail (G_NODE (sibling->user_data)->parent == G_NODE (parent->user_data));
1372 parent_node = G_NODE (parent->user_data);
1375 priv->columns_dirty = TRUE;
1377 new_node = g_node_new (NULL);
1379 g_node_insert_before (parent_node,
1380 sibling ? G_NODE (sibling->user_data) : NULL,
1383 iter->stamp = priv->stamp;
1384 iter->user_data = new_node;
1386 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1387 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1389 if (parent_node != priv->root)
1391 if (new_node->prev == NULL && new_node->next == NULL)
1393 GtkTreeIter parent_iter;
1395 parent_iter.stamp = priv->stamp;
1396 parent_iter.user_data = parent_node;
1398 gtk_tree_path_up (path);
1399 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &parent_iter);
1403 gtk_tree_path_free (path);
1405 validate_tree (tree_store);
1409 * gtk_tree_store_insert_after:
1410 * @tree_store: A #GtkTreeStore
1411 * @iter: (out): An unset #GtkTreeIter to set to the new row
1412 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1413 * @sibling: (allow-none): A valid #GtkTreeIter, or %NULL
1415 * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
1416 * prepended to @parent 's children. If @parent and @sibling are %NULL, then
1417 * the row will be prepended to the toplevel. If both @sibling and @parent are
1418 * set, then @parent must be the parent of @sibling. When @sibling is set,
1419 * @parent is optional.
1421 * @iter will be changed to point to this new row. The row will be empty after
1422 * this function is called. To fill in values, you need to call
1423 * gtk_tree_store_set() or gtk_tree_store_set_value().
1427 gtk_tree_store_insert_after (GtkTreeStore *tree_store,
1429 GtkTreeIter *parent,
1430 GtkTreeIter *sibling)
1432 GtkTreeStorePrivate *priv = tree_store->priv;
1437 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1438 g_return_if_fail (iter != NULL);
1440 g_return_if_fail (VALID_ITER (parent, tree_store));
1441 if (sibling != NULL)
1442 g_return_if_fail (VALID_ITER (sibling, tree_store));
1444 if (parent == NULL && sibling == NULL)
1445 parent_node = priv->root;
1446 else if (parent == NULL)
1447 parent_node = G_NODE (sibling->user_data)->parent;
1448 else if (sibling == NULL)
1449 parent_node = G_NODE (parent->user_data);
1452 g_return_if_fail (G_NODE (sibling->user_data)->parent ==
1453 G_NODE (parent->user_data));
1454 parent_node = G_NODE (parent->user_data);
1457 priv->columns_dirty = TRUE;
1459 new_node = g_node_new (NULL);
1461 g_node_insert_after (parent_node,
1462 sibling ? G_NODE (sibling->user_data) : NULL,
1465 iter->stamp = priv->stamp;
1466 iter->user_data = new_node;
1468 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1469 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1471 if (parent_node != priv->root)
1473 if (new_node->prev == NULL && new_node->next == NULL)
1475 GtkTreeIter parent_iter;
1477 parent_iter.stamp = priv->stamp;
1478 parent_iter.user_data = parent_node;
1480 gtk_tree_path_up (path);
1481 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, &parent_iter);
1485 gtk_tree_path_free (path);
1487 validate_tree (tree_store);
1491 * gtk_tree_store_insert_with_values:
1492 * @tree_store: A #GtkTreeStore
1493 * @iter: (out) (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
1494 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1495 * @position: position to insert the new row
1496 * @...: pairs of column number and value, terminated with -1
1498 * Creates a new row at @position. @iter will be changed to point to this
1499 * new row. If @position is larger than the number of rows on the list, then
1500 * the new row will be appended to the list. The row will be filled with
1501 * the values given to this function.
1504 * <literal>gtk_tree_store_insert_with_values (tree_store, iter, position, ...)</literal>
1505 * has the same effect as calling
1507 * gtk_tree_store_insert (tree_store, iter, position);
1508 * gtk_tree_store_set (tree_store, iter, ...);
1510 * with the different that the former will only emit a row_inserted signal,
1511 * while the latter will emit row_inserted, row_changed and if the tree store
1512 * is sorted, rows_reordered. Since emitting the rows_reordered signal
1513 * repeatedly can affect the performance of the program,
1514 * gtk_tree_store_insert_with_values() should generally be preferred when
1515 * inserting rows in a sorted tree store.
1520 gtk_tree_store_insert_with_values (GtkTreeStore *tree_store,
1522 GtkTreeIter *parent,
1526 GtkTreeStorePrivate *priv = tree_store->priv;
1530 GtkTreeIter tmp_iter;
1532 gboolean changed = FALSE;
1533 gboolean maybe_need_sort = FALSE;
1535 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1541 g_return_if_fail (VALID_ITER (parent, tree_store));
1544 parent_node = parent->user_data;
1546 parent_node = priv->root;
1548 priv->columns_dirty = TRUE;
1550 new_node = g_node_new (NULL);
1552 iter->stamp = priv->stamp;
1553 iter->user_data = new_node;
1554 g_node_insert (parent_node, position, new_node);
1556 va_start (var_args, position);
1557 gtk_tree_store_set_valist_internal (tree_store, iter,
1558 &changed, &maybe_need_sort,
1562 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1563 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, FALSE);
1565 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1566 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1568 if (parent_node != priv->root)
1570 if (new_node->prev == NULL && new_node->next == NULL)
1572 gtk_tree_path_up (path);
1573 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1577 gtk_tree_path_free (path);
1579 validate_tree ((GtkTreeStore *)tree_store);
1583 * gtk_tree_store_insert_with_valuesv:
1584 * @tree_store: A #GtkTreeStore
1585 * @iter: (out) (allow-none): An unset #GtkTreeIter to set the new row, or %NULL.
1586 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1587 * @position: position to insert the new row
1588 * @columns: (array length=n_values): an array of column numbers
1589 * @values: (array length=n_values): an array of GValues
1590 * @n_values: the length of the @columns and @values arrays
1592 * A variant of gtk_tree_store_insert_with_values() which takes
1593 * the columns and values as two arrays, instead of varargs. This
1594 * function is mainly intended for language bindings.
1597 * Rename to: gtk_tree_store_insert_with_values
1600 gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store,
1602 GtkTreeIter *parent,
1608 GtkTreeStorePrivate *priv = tree_store->priv;
1612 GtkTreeIter tmp_iter;
1613 gboolean changed = FALSE;
1614 gboolean maybe_need_sort = FALSE;
1616 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1622 g_return_if_fail (VALID_ITER (parent, tree_store));
1625 parent_node = parent->user_data;
1627 parent_node = priv->root;
1629 priv->columns_dirty = TRUE;
1631 new_node = g_node_new (NULL);
1633 iter->stamp = priv->stamp;
1634 iter->user_data = new_node;
1635 g_node_insert (parent_node, position, new_node);
1637 gtk_tree_store_set_vector_internal (tree_store, iter,
1638 &changed, &maybe_need_sort,
1639 columns, values, n_values);
1641 if (maybe_need_sort && GTK_TREE_STORE_IS_SORTED (tree_store))
1642 gtk_tree_store_sort_iter_changed (tree_store, iter, priv->sort_column_id, FALSE);
1644 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1645 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1647 if (parent_node != priv->root)
1649 if (new_node->prev == NULL && new_node->next == NULL)
1651 gtk_tree_path_up (path);
1652 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1656 gtk_tree_path_free (path);
1658 validate_tree ((GtkTreeStore *)tree_store);
1662 * gtk_tree_store_prepend:
1663 * @tree_store: A #GtkTreeStore
1664 * @iter: (out): An unset #GtkTreeIter to set to the prepended row
1665 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1667 * Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
1668 * the new row before the first child of @parent, otherwise it will prepend a row
1669 * to the top level. @iter will be changed to point to this new row. The row
1670 * will be empty after this function is called. To fill in values, you need to
1671 * call gtk_tree_store_set() or gtk_tree_store_set_value().
1674 gtk_tree_store_prepend (GtkTreeStore *tree_store,
1676 GtkTreeIter *parent)
1678 GtkTreeStorePrivate *priv = tree_store->priv;
1681 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1682 g_return_if_fail (iter != NULL);
1684 g_return_if_fail (VALID_ITER (parent, tree_store));
1686 priv->columns_dirty = TRUE;
1689 parent_node = priv->root;
1691 parent_node = parent->user_data;
1693 if (parent_node->children == NULL)
1697 iter->stamp = priv->stamp;
1698 iter->user_data = g_node_new (NULL);
1700 g_node_prepend (parent_node, G_NODE (iter->user_data));
1702 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1703 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1705 if (parent_node != priv->root)
1707 gtk_tree_path_up (path);
1708 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1710 gtk_tree_path_free (path);
1714 gtk_tree_store_insert_after (tree_store, iter, parent, NULL);
1717 validate_tree (tree_store);
1721 * gtk_tree_store_append:
1722 * @tree_store: A #GtkTreeStore
1723 * @iter: (out): An unset #GtkTreeIter to set to the appended row
1724 * @parent: (allow-none): A valid #GtkTreeIter, or %NULL
1726 * Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
1727 * new row after the last child of @parent, otherwise it will append a row to
1728 * the top level. @iter will be changed to point to this new row. The row will
1729 * be empty after this function is called. To fill in values, you need to call
1730 * gtk_tree_store_set() or gtk_tree_store_set_value().
1733 gtk_tree_store_append (GtkTreeStore *tree_store,
1735 GtkTreeIter *parent)
1737 GtkTreeStorePrivate *priv = tree_store->priv;
1740 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1741 g_return_if_fail (iter != NULL);
1743 g_return_if_fail (VALID_ITER (parent, tree_store));
1746 parent_node = priv->root;
1748 parent_node = parent->user_data;
1750 priv->columns_dirty = TRUE;
1752 if (parent_node->children == NULL)
1756 iter->stamp = priv->stamp;
1757 iter->user_data = g_node_new (NULL);
1759 g_node_append (parent_node, G_NODE (iter->user_data));
1761 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
1762 gtk_tree_model_row_inserted (GTK_TREE_MODEL (tree_store), path, iter);
1764 if (parent_node != priv->root)
1766 gtk_tree_path_up (path);
1767 gtk_tree_model_row_has_child_toggled (GTK_TREE_MODEL (tree_store), path, parent);
1769 gtk_tree_path_free (path);
1773 gtk_tree_store_insert_before (tree_store, iter, parent, NULL);
1776 validate_tree (tree_store);
1780 * gtk_tree_store_is_ancestor:
1781 * @tree_store: A #GtkTreeStore
1782 * @iter: A valid #GtkTreeIter
1783 * @descendant: A valid #GtkTreeIter
1785 * Returns %TRUE if @iter is an ancestor of @descendant. That is, @iter is the
1786 * parent (or grandparent or great-grandparent) of @descendant.
1788 * Return value: %TRUE, if @iter is an ancestor of @descendant
1791 gtk_tree_store_is_ancestor (GtkTreeStore *tree_store,
1793 GtkTreeIter *descendant)
1795 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1796 g_return_val_if_fail (VALID_ITER (iter, tree_store), FALSE);
1797 g_return_val_if_fail (VALID_ITER (descendant, tree_store), FALSE);
1799 return g_node_is_ancestor (G_NODE (iter->user_data),
1800 G_NODE (descendant->user_data));
1805 * gtk_tree_store_iter_depth:
1806 * @tree_store: A #GtkTreeStore
1807 * @iter: A valid #GtkTreeIter
1809 * Returns the depth of @iter. This will be 0 for anything on the root level, 1
1810 * for anything down a level, etc.
1812 * Return value: The depth of @iter
1815 gtk_tree_store_iter_depth (GtkTreeStore *tree_store,
1818 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), 0);
1819 g_return_val_if_fail (VALID_ITER (iter, tree_store), 0);
1821 return g_node_depth (G_NODE (iter->user_data)) - 2;
1824 /* simple ripoff from g_node_traverse_post_order */
1826 gtk_tree_store_clear_traverse (GNode *node,
1827 GtkTreeStore *store)
1835 child = node->children;
1838 register GNode *current;
1841 child = current->next;
1842 if (gtk_tree_store_clear_traverse (current, store))
1848 iter.stamp = store->priv->stamp;
1849 iter.user_data = node;
1851 gtk_tree_store_remove (store, &iter);
1854 else if (node->parent)
1856 iter.stamp = store->priv->stamp;
1857 iter.user_data = node;
1859 gtk_tree_store_remove (store, &iter);
1866 gtk_tree_store_increment_stamp (GtkTreeStore *tree_store)
1868 GtkTreeStorePrivate *priv = tree_store->priv;
1873 while (priv->stamp == 0);
1877 * gtk_tree_store_clear:
1878 * @tree_store: a #GtkTreeStore
1880 * Removes all rows from @tree_store
1883 gtk_tree_store_clear (GtkTreeStore *tree_store)
1885 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
1887 gtk_tree_store_clear_traverse (tree_store->priv->root, tree_store);
1888 gtk_tree_store_increment_stamp (tree_store);
1892 gtk_tree_store_iter_is_valid_helper (GtkTreeIter *iter,
1901 if (node == iter->user_data)
1905 if (gtk_tree_store_iter_is_valid_helper (iter, node->children))
1916 * gtk_tree_store_iter_is_valid:
1917 * @tree_store: A #GtkTreeStore.
1918 * @iter: A #GtkTreeIter.
1920 * WARNING: This function is slow. Only use it for debugging and/or testing
1923 * Checks if the given iter is a valid iter for this #GtkTreeStore.
1925 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
1930 gtk_tree_store_iter_is_valid (GtkTreeStore *tree_store,
1933 g_return_val_if_fail (GTK_IS_TREE_STORE (tree_store), FALSE);
1934 g_return_val_if_fail (iter != NULL, FALSE);
1936 if (!VALID_ITER (iter, tree_store))
1939 return gtk_tree_store_iter_is_valid_helper (iter, tree_store->priv->root);
1945 static gboolean real_gtk_tree_store_row_draggable (GtkTreeDragSource *drag_source,
1952 gtk_tree_store_drag_data_delete (GtkTreeDragSource *drag_source,
1957 if (gtk_tree_store_get_iter (GTK_TREE_MODEL (drag_source),
1961 gtk_tree_store_remove (GTK_TREE_STORE (drag_source),
1972 gtk_tree_store_drag_data_get (GtkTreeDragSource *drag_source,
1974 GtkSelectionData *selection_data)
1976 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1977 * target, because the default handler does it for us, but
1978 * we do anyway for the convenience of someone maybe overriding the
1982 if (gtk_tree_set_row_drag_data (selection_data,
1983 GTK_TREE_MODEL (drag_source),
1990 /* FIXME handle text targets at least. */
1997 copy_node_data (GtkTreeStore *tree_store,
1998 GtkTreeIter *src_iter,
1999 GtkTreeIter *dest_iter)
2001 GtkTreeDataList *dl = G_NODE (src_iter->user_data)->data;
2002 GtkTreeDataList *copy_head = NULL;
2003 GtkTreeDataList *copy_prev = NULL;
2004 GtkTreeDataList *copy_iter = NULL;
2011 copy_iter = _gtk_tree_data_list_node_copy (dl, tree_store->priv->column_headers[col]);
2013 if (copy_head == NULL)
2014 copy_head = copy_iter;
2017 copy_prev->next = copy_iter;
2019 copy_prev = copy_iter;
2025 G_NODE (dest_iter->user_data)->data = copy_head;
2027 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), dest_iter);
2028 gtk_tree_model_row_changed (GTK_TREE_MODEL (tree_store), path, dest_iter);
2029 gtk_tree_path_free (path);
2033 recursive_node_copy (GtkTreeStore *tree_store,
2034 GtkTreeIter *src_iter,
2035 GtkTreeIter *dest_iter)
2038 GtkTreeModel *model;
2040 model = GTK_TREE_MODEL (tree_store);
2042 copy_node_data (tree_store, src_iter, dest_iter);
2044 if (gtk_tree_store_iter_children (model,
2048 /* Need to create children and recurse. Note our
2049 * dependence on persistent iterators here.
2055 /* Gee, a really slow algorithm... ;-) FIXME */
2056 gtk_tree_store_append (tree_store,
2060 recursive_node_copy (tree_store, &child, ©);
2062 while (gtk_tree_store_iter_next (model, &child));
2067 gtk_tree_store_drag_data_received (GtkTreeDragDest *drag_dest,
2069 GtkSelectionData *selection_data)
2071 GtkTreeModel *tree_model;
2072 GtkTreeStore *tree_store;
2073 GtkTreeModel *src_model = NULL;
2074 GtkTreePath *src_path = NULL;
2075 gboolean retval = FALSE;
2077 tree_model = GTK_TREE_MODEL (drag_dest);
2078 tree_store = GTK_TREE_STORE (drag_dest);
2080 validate_tree (tree_store);
2082 if (gtk_tree_get_row_drag_data (selection_data,
2085 src_model == tree_model)
2087 /* Copy the given row to a new position */
2088 GtkTreeIter src_iter;
2089 GtkTreeIter dest_iter;
2092 if (!gtk_tree_store_get_iter (src_model,
2099 /* Get the path to insert _after_ (dest is the path to insert _before_) */
2100 prev = gtk_tree_path_copy (dest);
2102 if (!gtk_tree_path_prev (prev))
2104 GtkTreeIter dest_parent;
2105 GtkTreePath *parent;
2106 GtkTreeIter *dest_parent_p;
2108 /* dest was the first spot at the current depth; which means
2109 * we are supposed to prepend.
2112 /* Get the parent, NULL if parent is the root */
2113 dest_parent_p = NULL;
2114 parent = gtk_tree_path_copy (dest);
2115 if (gtk_tree_path_up (parent) &&
2116 gtk_tree_path_get_depth (parent) > 0)
2118 gtk_tree_store_get_iter (tree_model,
2121 dest_parent_p = &dest_parent;
2123 gtk_tree_path_free (parent);
2126 gtk_tree_store_prepend (tree_store,
2134 if (gtk_tree_store_get_iter (tree_model, &dest_iter, prev))
2136 GtkTreeIter tmp_iter = dest_iter;
2138 gtk_tree_store_insert_after (tree_store, &dest_iter, NULL,
2145 gtk_tree_path_free (prev);
2147 /* If we succeeded in creating dest_iter, walk src_iter tree branch,
2148 * duplicating it below dest_iter.
2153 recursive_node_copy (tree_store,
2160 /* FIXME maybe add some data targets eventually, or handle text
2161 * targets in the simple case.
2169 gtk_tree_path_free (src_path);
2175 gtk_tree_store_row_drop_possible (GtkTreeDragDest *drag_dest,
2176 GtkTreePath *dest_path,
2177 GtkSelectionData *selection_data)
2179 GtkTreeModel *src_model = NULL;
2180 GtkTreePath *src_path = NULL;
2181 GtkTreePath *tmp = NULL;
2182 gboolean retval = FALSE;
2184 /* don't accept drops if the tree has been sorted */
2185 if (GTK_TREE_STORE_IS_SORTED (drag_dest))
2188 if (!gtk_tree_get_row_drag_data (selection_data,
2193 /* can only drag to ourselves */
2194 if (src_model != GTK_TREE_MODEL (drag_dest))
2197 /* Can't drop into ourself. */
2198 if (gtk_tree_path_is_ancestor (src_path,
2202 /* Can't drop if dest_path's parent doesn't exist */
2206 if (gtk_tree_path_get_depth (dest_path) > 1)
2208 tmp = gtk_tree_path_copy (dest_path);
2209 gtk_tree_path_up (tmp);
2211 if (!gtk_tree_store_get_iter (GTK_TREE_MODEL (drag_dest),
2217 /* Can otherwise drop anywhere. */
2223 gtk_tree_path_free (src_path);
2225 gtk_tree_path_free (tmp);
2230 /* Sorting and reordering */
2231 typedef struct _SortTuple
2239 gtk_tree_store_reorder_func (gconstpointer a,
2243 SortTuple *a_reorder;
2244 SortTuple *b_reorder;
2246 a_reorder = (SortTuple *)a;
2247 b_reorder = (SortTuple *)b;
2249 if (a_reorder->offset < b_reorder->offset)
2251 if (a_reorder->offset > b_reorder->offset)
2258 * gtk_tree_store_reorder: (skip)
2259 * @tree_store: A #GtkTreeStore.
2260 * @parent: A #GtkTreeIter.
2261 * @new_order: (array): an array of integers mapping the new position of each child
2262 * to its old position before the re-ordering,
2263 * i.e. @new_order<literal>[newpos] = oldpos</literal>.
2265 * Reorders the children of @parent in @tree_store to follow the order
2266 * indicated by @new_order. Note that this function only works with
2272 gtk_tree_store_reorder (GtkTreeStore *tree_store,
2273 GtkTreeIter *parent,
2277 GNode *level, *node;
2279 SortTuple *sort_array;
2281 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
2282 g_return_if_fail (!GTK_TREE_STORE_IS_SORTED (tree_store));
2283 g_return_if_fail (parent == NULL || VALID_ITER (parent, tree_store));
2284 g_return_if_fail (new_order != NULL);
2287 level = G_NODE (tree_store->priv->root)->children;
2289 level = G_NODE (parent->user_data)->children;
2299 /* set up sortarray */
2300 sort_array = g_new (SortTuple, length);
2303 for (i = 0; i < length; i++)
2305 sort_array[new_order[i]].offset = i;
2306 sort_array[i].node = node;
2311 g_qsort_with_data (sort_array,
2314 gtk_tree_store_reorder_func,
2318 for (i = 0; i < length - 1; i++)
2320 sort_array[i].node->next = sort_array[i+1].node;
2321 sort_array[i+1].node->prev = sort_array[i].node;
2324 sort_array[length-1].node->next = NULL;
2325 sort_array[0].node->prev = NULL;
2327 G_NODE (parent->user_data)->children = sort_array[0].node;
2329 G_NODE (tree_store->priv->root)->children = sort_array[0].node;
2333 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), parent);
2335 path = gtk_tree_path_new ();
2336 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store), path,
2338 gtk_tree_path_free (path);
2339 g_free (sort_array);
2343 * gtk_tree_store_swap:
2344 * @tree_store: A #GtkTreeStore.
2345 * @a: A #GtkTreeIter.
2346 * @b: Another #GtkTreeIter.
2348 * Swaps @a and @b in the same level of @tree_store. Note that this function
2349 * only works with unsorted stores.
2354 gtk_tree_store_swap (GtkTreeStore *tree_store,
2358 GNode *tmp, *node_a, *node_b, *parent_node;
2359 GNode *a_prev, *a_next, *b_prev, *b_next;
2360 gint i, a_count, b_count, length, *order;
2361 GtkTreePath *path_a, *path_b;
2364 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
2365 g_return_if_fail (VALID_ITER (a, tree_store));
2366 g_return_if_fail (VALID_ITER (b, tree_store));
2368 node_a = G_NODE (a->user_data);
2369 node_b = G_NODE (b->user_data);
2371 /* basic sanity checking */
2372 if (node_a == node_b)
2375 path_a = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), a);
2376 path_b = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), b);
2378 g_return_if_fail (path_a && path_b);
2380 gtk_tree_path_up (path_a);
2381 gtk_tree_path_up (path_b);
2383 if (gtk_tree_path_get_depth (path_a) == 0
2384 || gtk_tree_path_get_depth (path_b) == 0)
2386 if (gtk_tree_path_get_depth (path_a) != gtk_tree_path_get_depth (path_b))
2388 gtk_tree_path_free (path_a);
2389 gtk_tree_path_free (path_b);
2391 g_warning ("Given children are not in the same level\n");
2394 parent_node = G_NODE (tree_store->priv->root);
2398 if (gtk_tree_path_compare (path_a, path_b))
2400 gtk_tree_path_free (path_a);
2401 gtk_tree_path_free (path_b);
2403 g_warning ("Given children don't have a common parent\n");
2406 gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store), &parent,
2408 parent_node = G_NODE (parent.user_data);
2410 gtk_tree_path_free (path_b);
2412 /* old links which we have to keep around */
2413 a_prev = node_a->prev;
2414 a_next = node_a->next;
2416 b_prev = node_b->prev;
2417 b_next = node_b->next;
2419 /* fix up links if the nodes are next to eachother */
2420 if (a_prev == node_b)
2422 if (a_next == node_b)
2425 if (b_prev == node_a)
2427 if (b_next == node_a)
2430 /* counting nodes */
2431 tmp = parent_node->children;
2432 i = a_count = b_count = 0;
2445 /* hacking the tree */
2447 parent_node->children = node_b;
2449 a_prev->next = node_b;
2452 a_next->prev = node_b;
2455 parent_node->children = node_a;
2457 b_prev->next = node_a;
2460 b_next->prev = node_a;
2462 node_a->prev = b_prev;
2463 node_a->next = b_next;
2465 node_b->prev = a_prev;
2466 node_b->next = a_next;
2469 order = g_new (gint, length);
2470 for (i = 0; i < length; i++)
2473 else if (i == b_count)
2478 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store), path_a,
2479 parent_node == tree_store->priv->root
2480 ? NULL : &parent, order);
2481 gtk_tree_path_free (path_a);
2485 /* WARNING: this function is *incredibly* fragile. Please smashtest after
2486 * making changes here.
2490 gtk_tree_store_move (GtkTreeStore *tree_store,
2492 GtkTreeIter *position,
2495 GNode *parent, *node, *a, *b, *tmp, *tmp_a, *tmp_b;
2496 gint old_pos, new_pos, length, i, *order;
2497 GtkTreePath *path = NULL, *tmppath, *pos_path = NULL;
2498 GtkTreeIter parent_iter, dst_a, dst_b;
2500 gboolean handle_b = TRUE;
2502 g_return_if_fail (GTK_IS_TREE_STORE (tree_store));
2503 g_return_if_fail (!GTK_TREE_STORE_IS_SORTED (tree_store));
2504 g_return_if_fail (VALID_ITER (iter, tree_store));
2506 g_return_if_fail (VALID_ITER (position, tree_store));
2513 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
2514 pos_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store),
2518 * moving the iter before path or "path + 1" doesn't make sense
2520 * moving the iter before path or "path - 1" doesn't make sense
2522 if (!gtk_tree_path_compare (path, pos_path))
2523 goto free_paths_and_out;
2526 gtk_tree_path_next (path);
2528 gtk_tree_path_prev (path);
2530 if (!gtk_tree_path_compare (path, pos_path))
2531 goto free_paths_and_out;
2534 gtk_tree_path_prev (path);
2536 gtk_tree_path_next (path);
2538 if (gtk_tree_path_get_depth (path) != gtk_tree_path_get_depth (pos_path))
2540 g_warning ("Given children are not in the same level\n");
2542 goto free_paths_and_out;
2545 tmppath = gtk_tree_path_copy (pos_path);
2546 gtk_tree_path_up (path);
2547 gtk_tree_path_up (tmppath);
2549 if (gtk_tree_path_get_depth (path) > 0 &&
2550 gtk_tree_path_compare (path, tmppath))
2552 g_warning ("Given children are not in the same level\n");
2554 gtk_tree_path_free (tmppath);
2555 goto free_paths_and_out;
2558 gtk_tree_path_free (tmppath);
2563 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), iter);
2564 gtk_tree_path_up (path);
2567 depth = gtk_tree_path_get_depth (path);
2571 gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store),
2572 &parent_iter, path);
2574 parent = G_NODE (parent_iter.user_data);
2577 parent = G_NODE (tree_store->priv->root);
2579 /* yes, I know that this can be done shorter, but I'm doing it this way
2580 * so the code is also maintainable
2583 if (before && position)
2585 b = G_NODE (position->user_data);
2587 if (gtk_tree_path_get_indices (pos_path)[gtk_tree_path_get_depth (pos_path) - 1] > 0)
2589 gtk_tree_path_prev (pos_path);
2590 if (gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store),
2592 a = G_NODE (dst_a.user_data);
2595 gtk_tree_path_next (pos_path);
2598 /* if b is NULL, a is NULL too -- we are at the beginning of the list
2599 * yes and we leak memory here ...
2601 g_return_if_fail (b);
2603 else if (before && !position)
2605 /* move before without position is appending */
2612 a = G_NODE (position->user_data);
2618 gtk_tree_path_next (pos_path);
2619 if (gtk_tree_store_get_iter (GTK_TREE_MODEL (tree_store), &dst_b, pos_path))
2620 b = G_NODE (dst_b.user_data);
2623 gtk_tree_path_prev (pos_path);
2627 /* move after without position is prepending */
2629 gtk_tree_store_iter_children (GTK_TREE_MODEL (tree_store), &dst_b,
2632 gtk_tree_store_iter_children (GTK_TREE_MODEL (tree_store), &dst_b,
2635 b = G_NODE (dst_b.user_data);
2638 /* if a is NULL, b is NULL too -- we are at the end of the list
2639 * yes and we leak memory here ...
2642 g_return_if_fail (a);
2645 /* counting nodes */
2646 tmp = parent->children;
2648 length = old_pos = 0;
2651 if (tmp == iter->user_data)
2658 /* remove node from list */
2659 node = G_NODE (iter->user_data);
2664 tmp_a->next = tmp_b;
2666 parent->children = tmp_b;
2669 tmp_b->prev = tmp_a;
2671 /* and reinsert the node */
2680 else if (!a && !before)
2682 tmp = parent->children;
2685 parent->children = node;
2693 else if (!a && before)
2697 node->parent = NULL;
2698 node->next = node->prev = NULL;
2700 /* before with sibling = NULL appends */
2701 g_node_insert_before (parent, NULL, node);
2705 node->parent = NULL;
2706 node->next = node->prev = NULL;
2708 /* after with sibling = NULL prepends */
2709 g_node_insert_after (parent, NULL, node);
2725 else if (!(!a && before)) /* !a && before is completely handled above */
2731 new_pos = gtk_tree_path_get_indices (pos_path)[gtk_tree_path_get_depth (pos_path)-1];
2735 new_pos = gtk_tree_store_iter_n_children (GTK_TREE_MODEL (tree_store),
2738 new_pos = gtk_tree_store_iter_n_children (GTK_TREE_MODEL (tree_store),
2744 if (new_pos > old_pos)
2746 if (before && position)
2751 if (!before && position)
2755 order = g_new (gint, length);
2756 if (new_pos > old_pos)
2758 for (i = 0; i < length; i++)
2761 else if (i >= old_pos && i < new_pos)
2763 else if (i == new_pos)
2770 for (i = 0; i < length; i++)
2773 else if (i > new_pos && i <= old_pos)
2781 tmppath = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store),
2783 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2784 tmppath, &parent_iter, order);
2788 tmppath = gtk_tree_path_new ();
2789 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2790 tmppath, NULL, order);
2793 gtk_tree_path_free (tmppath);
2794 gtk_tree_path_free (path);
2796 gtk_tree_path_free (pos_path);
2802 gtk_tree_path_free (path);
2803 gtk_tree_path_free (pos_path);
2807 * gtk_tree_store_move_before:
2808 * @tree_store: A #GtkTreeStore.
2809 * @iter: A #GtkTreeIter.
2810 * @position: (allow-none): A #GtkTreeIter or %NULL.
2812 * Moves @iter in @tree_store to the position before @position. @iter and
2813 * @position should be in the same level. Note that this function only
2814 * works with unsorted stores. If @position is %NULL, @iter will be
2815 * moved to the end of the level.
2820 gtk_tree_store_move_before (GtkTreeStore *tree_store,
2822 GtkTreeIter *position)
2824 gtk_tree_store_move (tree_store, iter, position, TRUE);
2828 * gtk_tree_store_move_after:
2829 * @tree_store: A #GtkTreeStore.
2830 * @iter: A #GtkTreeIter.
2831 * @position: (allow-none): A #GtkTreeIter.
2833 * Moves @iter in @tree_store to the position after @position. @iter and
2834 * @position should be in the same level. Note that this function only
2835 * works with unsorted stores. If @position is %NULL, @iter will be moved
2836 * to the start of the level.
2841 gtk_tree_store_move_after (GtkTreeStore *tree_store,
2843 GtkTreeIter *position)
2845 gtk_tree_store_move (tree_store, iter, position, FALSE);
2850 gtk_tree_store_compare_func (gconstpointer a,
2854 GtkTreeStore *tree_store = user_data;
2855 GtkTreeStorePrivate *priv = tree_store->priv;
2858 GtkTreeIterCompareFunc func;
2865 if (priv->sort_column_id != -1)
2867 GtkTreeDataSortHeader *header;
2869 header = _gtk_tree_data_list_get_header (priv->sort_list,
2870 priv->sort_column_id);
2871 g_return_val_if_fail (header != NULL, 0);
2872 g_return_val_if_fail (header->func != NULL, 0);
2874 func = header->func;
2875 data = header->data;
2879 g_return_val_if_fail (priv->default_sort_func != NULL, 0);
2880 func = priv->default_sort_func;
2881 data = priv->default_sort_data;
2884 node_a = ((SortTuple *) a)->node;
2885 node_b = ((SortTuple *) b)->node;
2887 iter_a.stamp = priv->stamp;
2888 iter_a.user_data = node_a;
2889 iter_b.stamp = priv->stamp;
2890 iter_b.user_data = node_b;
2892 retval = (* func) (GTK_TREE_MODEL (user_data), &iter_a, &iter_b, data);
2894 if (priv->order == GTK_SORT_DESCENDING)
2898 else if (retval < 0)
2905 gtk_tree_store_sort_helper (GtkTreeStore *tree_store,
2918 node = parent->children;
2919 if (node == NULL || node->next == NULL)
2921 if (recurse && node && node->children)
2922 gtk_tree_store_sort_helper (tree_store, node, TRUE);
2928 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
2931 sort_array = g_array_sized_new (FALSE, FALSE, sizeof (SortTuple), list_length);
2934 for (tmp_node = node; tmp_node; tmp_node = tmp_node->next)
2939 tuple.node = tmp_node;
2940 g_array_append_val (sort_array, tuple);
2944 /* Sort the array */
2945 g_array_sort_with_data (sort_array, gtk_tree_store_compare_func, tree_store);
2947 for (i = 0; i < list_length - 1; i++)
2949 g_array_index (sort_array, SortTuple, i).node->next =
2950 g_array_index (sort_array, SortTuple, i + 1).node;
2951 g_array_index (sort_array, SortTuple, i + 1).node->prev =
2952 g_array_index (sort_array, SortTuple, i).node;
2954 g_array_index (sort_array, SortTuple, list_length - 1).node->next = NULL;
2955 g_array_index (sort_array, SortTuple, 0).node->prev = NULL;
2956 parent->children = g_array_index (sort_array, SortTuple, 0).node;
2958 /* Let the world know about our new order */
2959 new_order = g_new (gint, list_length);
2960 for (i = 0; i < list_length; i++)
2961 new_order[i] = g_array_index (sort_array, SortTuple, i).offset;
2963 iter.stamp = tree_store->priv->stamp;
2964 iter.user_data = parent;
2965 path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &iter);
2966 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
2967 path, &iter, new_order);
2968 gtk_tree_path_free (path);
2970 g_array_free (sort_array, TRUE);
2974 for (tmp_node = parent->children; tmp_node; tmp_node = tmp_node->next)
2976 if (tmp_node->children)
2977 gtk_tree_store_sort_helper (tree_store, tmp_node, TRUE);
2983 gtk_tree_store_sort (GtkTreeStore *tree_store)
2985 GtkTreeStorePrivate *priv = tree_store->priv;
2987 if (!GTK_TREE_STORE_IS_SORTED (tree_store))
2990 if (priv->sort_column_id != -1)
2992 GtkTreeDataSortHeader *header = NULL;
2994 header = _gtk_tree_data_list_get_header (priv->sort_list,
2995 priv->sort_column_id);
2997 /* We want to make sure that we have a function */
2998 g_return_if_fail (header != NULL);
2999 g_return_if_fail (header->func != NULL);
3003 g_return_if_fail (priv->default_sort_func != NULL);
3006 gtk_tree_store_sort_helper (tree_store, G_NODE (priv->root), TRUE);
3010 gtk_tree_store_sort_iter_changed (GtkTreeStore *tree_store,
3013 gboolean emit_signal)
3015 GtkTreeStorePrivate *priv = tree_store->priv;
3019 GtkTreePath *tmp_path;
3020 GtkTreeIter tmp_iter;
3028 GtkTreeIterCompareFunc func;
3031 g_return_if_fail (G_NODE (iter->user_data)->parent != NULL);
3033 tmp_iter.stamp = priv->stamp;
3034 if (priv->sort_column_id != -1)
3036 GtkTreeDataSortHeader *header;
3037 header = _gtk_tree_data_list_get_header (priv->sort_list,
3038 priv->sort_column_id);
3039 g_return_if_fail (header != NULL);
3040 g_return_if_fail (header->func != NULL);
3041 func = header->func;
3042 data = header->data;
3046 g_return_if_fail (priv->default_sort_func != NULL);
3047 func = priv->default_sort_func;
3048 data = priv->default_sort_data;
3051 /* If it's the built in function, we don't sort. */
3052 if (func == _gtk_tree_data_list_compare_func &&
3053 priv->sort_column_id != column)
3057 node = G_NODE (iter->user_data)->parent->children;
3058 /* First we find the iter, its prev, and its next */
3061 if (node == G_NODE (iter->user_data))
3066 g_assert (node != NULL);
3071 /* Check the common case, where we don't need to sort it moved. */
3074 tmp_iter.user_data = prev;
3075 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
3080 tmp_iter.user_data = next;
3081 cmp_b = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
3084 if (priv->order == GTK_SORT_DESCENDING)
3097 if (prev == NULL && cmp_b <= 0)
3099 else if (next == NULL && cmp_a <= 0)
3101 else if (prev != NULL && next != NULL &&
3102 cmp_a <= 0 && cmp_b <= 0)
3105 /* We actually need to sort it */
3106 /* First, remove the old link. */
3111 node->parent->children = next;
3119 /* FIXME: as an optimization, we can potentially start at next */
3121 node = node->parent->children;
3123 tmp_iter.user_data = node;
3124 if (priv->order == GTK_SORT_DESCENDING)
3125 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
3127 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
3129 while ((node->next) && (cmp_a > 0))
3134 tmp_iter.user_data = node;
3135 if (priv->order == GTK_SORT_DESCENDING)
3136 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), &tmp_iter, iter, data);
3138 cmp_a = (* func) (GTK_TREE_MODEL (tree_store), iter, &tmp_iter, data);
3141 if ((!node->next) && (cmp_a > 0))
3144 node->next = G_NODE (iter->user_data);
3145 node->next->prev = node;
3149 prev->next = G_NODE (iter->user_data);
3150 prev->next->prev = prev;
3151 G_NODE (iter->user_data)->next = node;
3152 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
3156 G_NODE (iter->user_data)->next = G_NODE (iter->user_data)->parent->children;
3157 G_NODE (iter->user_data)->next->prev = G_NODE (iter->user_data);
3158 G_NODE (iter->user_data)->parent->children = G_NODE (iter->user_data);
3164 /* Emit the reordered signal. */
3165 length = g_node_n_children (node->parent);
3166 new_order = g_new (int, length);
3167 if (old_location < new_location)
3168 for (i = 0; i < length; i++)
3170 if (i < old_location ||
3173 else if (i >= old_location &&
3175 new_order[i] = i + 1;
3176 else if (i == new_location)
3177 new_order[i] = old_location;
3180 for (i = 0; i < length; i++)
3182 if (i < new_location ||
3185 else if (i > new_location &&
3187 new_order[i] = i - 1;
3188 else if (i == new_location)
3189 new_order[i] = old_location;
3192 tmp_iter.user_data = node->parent;
3193 tmp_path = gtk_tree_store_get_path (GTK_TREE_MODEL (tree_store), &tmp_iter);
3195 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (tree_store),
3196 tmp_path, &tmp_iter,
3199 gtk_tree_path_free (tmp_path);
3205 gtk_tree_store_get_sort_column_id (GtkTreeSortable *sortable,
3206 gint *sort_column_id,
3209 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3210 GtkTreeStorePrivate *priv = tree_store->priv;
3213 * sort_column_id = priv->sort_column_id;
3215 * order = priv->order;
3217 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
3218 priv->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
3225 gtk_tree_store_set_sort_column_id (GtkTreeSortable *sortable,
3226 gint sort_column_id,
3229 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3230 GtkTreeStorePrivate *priv = tree_store->priv;
3232 if ((priv->sort_column_id == sort_column_id) &&
3233 (priv->order == order))
3236 if (sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
3238 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
3240 GtkTreeDataSortHeader *header = NULL;
3242 header = _gtk_tree_data_list_get_header (priv->sort_list,
3245 /* We want to make sure that we have a function */
3246 g_return_if_fail (header != NULL);
3247 g_return_if_fail (header->func != NULL);
3251 g_return_if_fail (priv->default_sort_func != NULL);
3255 priv->sort_column_id = sort_column_id;
3256 priv->order = order;
3258 gtk_tree_sortable_sort_column_changed (sortable);
3260 gtk_tree_store_sort (tree_store);
3264 gtk_tree_store_set_sort_func (GtkTreeSortable *sortable,
3265 gint sort_column_id,
3266 GtkTreeIterCompareFunc func,
3268 GDestroyNotify destroy)
3270 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3271 GtkTreeStorePrivate *priv = tree_store->priv;
3273 priv->sort_list = _gtk_tree_data_list_set_header (priv->sort_list,
3275 func, data, destroy);
3277 if (priv->sort_column_id == sort_column_id)
3278 gtk_tree_store_sort (tree_store);
3282 gtk_tree_store_set_default_sort_func (GtkTreeSortable *sortable,
3283 GtkTreeIterCompareFunc func,
3285 GDestroyNotify destroy)
3287 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3288 GtkTreeStorePrivate *priv = tree_store->priv;
3290 if (priv->default_sort_destroy)
3292 GDestroyNotify d = priv->default_sort_destroy;
3294 priv->default_sort_destroy = NULL;
3295 d (priv->default_sort_data);
3298 priv->default_sort_func = func;
3299 priv->default_sort_data = data;
3300 priv->default_sort_destroy = destroy;
3302 if (priv->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
3303 gtk_tree_store_sort (tree_store);
3307 gtk_tree_store_has_default_sort_func (GtkTreeSortable *sortable)
3309 GtkTreeStore *tree_store = (GtkTreeStore *) sortable;
3311 return (tree_store->priv->default_sort_func != NULL);
3315 validate_gnode (GNode* node)
3319 iter = node->children;
3320 while (iter != NULL)
3322 g_assert (iter->parent == node);
3324 g_assert (iter->prev->next == iter);
3325 validate_gnode (iter);
3330 /* GtkBuildable custom tag implementation
3333 * <column type="..."/>
3334 * <column type="..."/>
3338 GtkBuilder *builder;
3341 } GSListSubParserData;
3344 tree_model_start_element (GMarkupParseContext *context,
3345 const gchar *element_name,
3346 const gchar **names,
3347 const gchar **values,
3352 GSListSubParserData *data = (GSListSubParserData*)user_data;
3354 for (i = 0; names[i]; i++)
3356 if (strcmp (names[i], "type") == 0)
3357 data->items = g_slist_prepend (data->items, g_strdup (values[i]));
3362 tree_model_end_element (GMarkupParseContext *context,
3363 const gchar *element_name,
3367 GSListSubParserData *data = (GSListSubParserData*)user_data;
3369 g_assert(data->builder);
3371 if (strcmp (element_name, "columns") == 0)
3378 data = (GSListSubParserData*)user_data;
3379 data->items = g_slist_reverse (data->items);
3380 types = g_new0 (GType, g_slist_length (data->items));
3382 for (l = data->items, i = 0; l; l = l->next, i++)
3384 type = gtk_builder_get_type_from_name (data->builder, l->data);
3385 if (type == G_TYPE_INVALID)
3387 g_warning ("Unknown type %s specified in treemodel %s",
3388 (const gchar*)l->data,
3389 gtk_buildable_get_name (GTK_BUILDABLE (data->object)));
3397 gtk_tree_store_set_column_types (GTK_TREE_STORE (data->object), i, types);
3403 static const GMarkupParser tree_model_parser =
3405 tree_model_start_element,
3406 tree_model_end_element
3411 gtk_tree_store_buildable_custom_tag_start (GtkBuildable *buildable,
3412 GtkBuilder *builder,
3414 const gchar *tagname,
3415 GMarkupParser *parser,
3418 GSListSubParserData *parser_data;
3423 if (strcmp (tagname, "columns") == 0)
3425 parser_data = g_slice_new0 (GSListSubParserData);
3426 parser_data->builder = builder;
3427 parser_data->items = NULL;
3428 parser_data->object = G_OBJECT (buildable);
3430 *parser = tree_model_parser;
3431 *data = parser_data;
3439 gtk_tree_store_buildable_custom_finished (GtkBuildable *buildable,
3440 GtkBuilder *builder,
3442 const gchar *tagname,
3445 GSListSubParserData *data;
3447 if (strcmp (tagname, "columns"))
3450 data = (GSListSubParserData*)user_data;
3452 g_slist_free (data->items);
3453 g_slice_free (GSListSubParserData, data);