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.
24 #include <gobject/gvaluecollector.h>
25 #include "gtktreemodel.h"
26 #include "gtkliststore.h"
27 #include "gtktreedatalist.h"
28 #include "gtktreednd.h"
30 #include "gtkbuildable.h"
31 #include "gtkbuilderprivate.h"
34 #define GTK_LIST_STORE_IS_SORTED(list) (((GtkListStore*)(list))->sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
35 #define VALID_ITER(iter, list_store) ((iter)!= NULL && (iter)->user_data != NULL && list_store->stamp == (iter)->stamp && !g_sequence_iter_is_end ((iter)->user_data) && g_sequence_iter_get_sequence ((iter)->user_data) == list_store->seq)
37 static void gtk_list_store_tree_model_init (GtkTreeModelIface *iface);
38 static void gtk_list_store_drag_source_init(GtkTreeDragSourceIface *iface);
39 static void gtk_list_store_drag_dest_init (GtkTreeDragDestIface *iface);
40 static void gtk_list_store_sortable_init (GtkTreeSortableIface *iface);
41 static void gtk_list_store_buildable_init (GtkBuildableIface *iface);
42 static void gtk_list_store_finalize (GObject *object);
43 static GtkTreeModelFlags gtk_list_store_get_flags (GtkTreeModel *tree_model);
44 static gint gtk_list_store_get_n_columns (GtkTreeModel *tree_model);
45 static GType gtk_list_store_get_column_type (GtkTreeModel *tree_model,
47 static gboolean gtk_list_store_get_iter (GtkTreeModel *tree_model,
50 static GtkTreePath *gtk_list_store_get_path (GtkTreeModel *tree_model,
52 static void gtk_list_store_get_value (GtkTreeModel *tree_model,
56 static gboolean gtk_list_store_iter_next (GtkTreeModel *tree_model,
58 static gboolean gtk_list_store_iter_children (GtkTreeModel *tree_model,
61 static gboolean gtk_list_store_iter_has_child (GtkTreeModel *tree_model,
63 static gint gtk_list_store_iter_n_children (GtkTreeModel *tree_model,
65 static gboolean gtk_list_store_iter_nth_child (GtkTreeModel *tree_model,
69 static gboolean gtk_list_store_iter_parent (GtkTreeModel *tree_model,
74 static void gtk_list_store_set_n_columns (GtkListStore *list_store,
76 static void gtk_list_store_set_column_type (GtkListStore *list_store,
80 static void gtk_list_store_increment_stamp (GtkListStore *list_store);
84 static gboolean real_gtk_list_store_row_draggable (GtkTreeDragSource *drag_source,
86 static gboolean gtk_list_store_drag_data_delete (GtkTreeDragSource *drag_source,
88 static gboolean gtk_list_store_drag_data_get (GtkTreeDragSource *drag_source,
90 GtkSelectionData *selection_data);
91 static gboolean gtk_list_store_drag_data_received (GtkTreeDragDest *drag_dest,
93 GtkSelectionData *selection_data);
94 static gboolean gtk_list_store_row_drop_possible (GtkTreeDragDest *drag_dest,
95 GtkTreePath *dest_path,
96 GtkSelectionData *selection_data);
100 static void gtk_list_store_sort (GtkListStore *list_store);
101 static void gtk_list_store_sort_iter_changed (GtkListStore *list_store,
104 static gboolean gtk_list_store_get_sort_column_id (GtkTreeSortable *sortable,
105 gint *sort_column_id,
107 static void gtk_list_store_set_sort_column_id (GtkTreeSortable *sortable,
110 static void gtk_list_store_set_sort_func (GtkTreeSortable *sortable,
112 GtkTreeIterCompareFunc func,
114 GDestroyNotify destroy);
115 static void gtk_list_store_set_default_sort_func (GtkTreeSortable *sortable,
116 GtkTreeIterCompareFunc func,
118 GDestroyNotify destroy);
119 static gboolean gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable);
123 static gboolean gtk_list_store_buildable_custom_tag_start (GtkBuildable *buildable,
126 const gchar *tagname,
127 GMarkupParser *parser,
129 static void gtk_list_store_buildable_custom_tag_end (GtkBuildable *buildable,
132 const gchar *tagname,
135 G_DEFINE_TYPE_WITH_CODE (GtkListStore, gtk_list_store, G_TYPE_OBJECT,
136 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_MODEL,
137 gtk_list_store_tree_model_init)
138 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_SOURCE,
139 gtk_list_store_drag_source_init)
140 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_DRAG_DEST,
141 gtk_list_store_drag_dest_init)
142 G_IMPLEMENT_INTERFACE (GTK_TYPE_TREE_SORTABLE,
143 gtk_list_store_sortable_init)
144 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
145 gtk_list_store_buildable_init))
149 gtk_list_store_class_init (GtkListStoreClass *class)
151 GObjectClass *object_class;
153 object_class = (GObjectClass*) class;
155 object_class->finalize = gtk_list_store_finalize;
159 gtk_list_store_tree_model_init (GtkTreeModelIface *iface)
161 iface->get_flags = gtk_list_store_get_flags;
162 iface->get_n_columns = gtk_list_store_get_n_columns;
163 iface->get_column_type = gtk_list_store_get_column_type;
164 iface->get_iter = gtk_list_store_get_iter;
165 iface->get_path = gtk_list_store_get_path;
166 iface->get_value = gtk_list_store_get_value;
167 iface->iter_next = gtk_list_store_iter_next;
168 iface->iter_children = gtk_list_store_iter_children;
169 iface->iter_has_child = gtk_list_store_iter_has_child;
170 iface->iter_n_children = gtk_list_store_iter_n_children;
171 iface->iter_nth_child = gtk_list_store_iter_nth_child;
172 iface->iter_parent = gtk_list_store_iter_parent;
176 gtk_list_store_drag_source_init (GtkTreeDragSourceIface *iface)
178 iface->row_draggable = real_gtk_list_store_row_draggable;
179 iface->drag_data_delete = gtk_list_store_drag_data_delete;
180 iface->drag_data_get = gtk_list_store_drag_data_get;
184 gtk_list_store_drag_dest_init (GtkTreeDragDestIface *iface)
186 iface->drag_data_received = gtk_list_store_drag_data_received;
187 iface->row_drop_possible = gtk_list_store_row_drop_possible;
191 gtk_list_store_sortable_init (GtkTreeSortableIface *iface)
193 iface->get_sort_column_id = gtk_list_store_get_sort_column_id;
194 iface->set_sort_column_id = gtk_list_store_set_sort_column_id;
195 iface->set_sort_func = gtk_list_store_set_sort_func;
196 iface->set_default_sort_func = gtk_list_store_set_default_sort_func;
197 iface->has_default_sort_func = gtk_list_store_has_default_sort_func;
201 gtk_list_store_buildable_init (GtkBuildableIface *iface)
203 iface->custom_tag_start = gtk_list_store_buildable_custom_tag_start;
204 iface->custom_tag_end = gtk_list_store_buildable_custom_tag_end;
208 gtk_list_store_init (GtkListStore *list_store)
210 list_store->seq = g_sequence_new (NULL);
211 list_store->sort_list = NULL;
212 list_store->stamp = g_random_int ();
213 list_store->sort_column_id = -2;
214 list_store->columns_dirty = FALSE;
215 list_store->length = 0;
219 * gtk_list_store_new:
220 * @n_columns: number of columns in the list store
221 * @Varargs: all #GType types for the columns, from first to last
223 * Creates a new list store as with @n_columns columns each of the types passed
224 * in. Note that only types derived from standard GObject fundamental types
227 * As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
228 * GDK_TYPE_PIXBUF);</literal> will create a new #GtkListStore with three columns, of type
229 * int, string and #GdkPixbuf respectively.
231 * Return value: a new #GtkListStore
234 gtk_list_store_new (gint n_columns,
237 GtkListStore *retval;
241 g_return_val_if_fail (n_columns > 0, NULL);
243 retval = g_object_new (GTK_TYPE_LIST_STORE, NULL);
244 gtk_list_store_set_n_columns (retval, n_columns);
246 va_start (args, n_columns);
248 for (i = 0; i < n_columns; i++)
250 GType type = va_arg (args, GType);
251 if (! _gtk_tree_data_list_check_type (type))
253 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (type));
254 g_object_unref (retval);
258 gtk_list_store_set_column_type (retval, i, type);
268 * gtk_list_store_newv:
269 * @n_columns: number of columns in the list store
270 * @types: an array of #GType types for the columns, from first to last
272 * Non-vararg creation function. Used primarily by language bindings.
274 * Return value: a new #GtkListStore
277 gtk_list_store_newv (gint n_columns,
280 GtkListStore *retval;
283 g_return_val_if_fail (n_columns > 0, NULL);
285 retval = g_object_new (GTK_TYPE_LIST_STORE, NULL);
286 gtk_list_store_set_n_columns (retval, n_columns);
288 for (i = 0; i < n_columns; i++)
290 if (! _gtk_tree_data_list_check_type (types[i]))
292 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (types[i]));
293 g_object_unref (retval);
297 gtk_list_store_set_column_type (retval, i, types[i]);
304 * gtk_list_store_set_column_types:
305 * @list_store: A #GtkListStore
306 * @n_columns: Number of columns for the list store
307 * @types: An array length n of #GTypes
309 * This function is meant primarily for #GObjects that inherit from #GtkListStore,
310 * and should only be used when constructing a new #GtkListStore. It will not
311 * function after a row has been added, or a method on the #GtkTreeModel
312 * interface is called.
315 gtk_list_store_set_column_types (GtkListStore *list_store,
321 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
322 g_return_if_fail (list_store->columns_dirty == 0);
324 gtk_list_store_set_n_columns (list_store, n_columns);
325 for (i = 0; i < n_columns; i++)
327 if (! _gtk_tree_data_list_check_type (types[i]))
329 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (types[i]));
332 gtk_list_store_set_column_type (list_store, i, types[i]);
337 gtk_list_store_set_n_columns (GtkListStore *list_store,
342 if (list_store->n_columns == n_columns)
345 new_columns = g_new0 (GType, n_columns);
346 if (list_store->column_headers)
348 /* copy the old header orders over */
349 if (n_columns >= list_store->n_columns)
350 memcpy (new_columns, list_store->column_headers, list_store->n_columns * sizeof (gchar *));
352 memcpy (new_columns, list_store->column_headers, n_columns * sizeof (GType));
354 g_free (list_store->column_headers);
357 if (list_store->sort_list)
358 _gtk_tree_data_list_header_free (list_store->sort_list);
360 list_store->sort_list = _gtk_tree_data_list_header_new (n_columns, list_store->column_headers);
362 list_store->column_headers = new_columns;
363 list_store->n_columns = n_columns;
367 gtk_list_store_set_column_type (GtkListStore *list_store,
371 if (!_gtk_tree_data_list_check_type (type))
373 g_warning ("%s: Invalid type %s\n", G_STRLOC, g_type_name (type));
377 list_store->column_headers[column] = type;
381 gtk_list_store_finalize (GObject *object)
383 GtkListStore *list_store = GTK_LIST_STORE (object);
385 g_sequence_foreach (list_store->seq,
386 (GFunc) _gtk_tree_data_list_free, list_store->column_headers);
388 g_sequence_free (list_store->seq);
390 _gtk_tree_data_list_header_free (list_store->sort_list);
391 g_free (list_store->column_headers);
393 if (list_store->default_sort_destroy)
395 GDestroyNotify d = list_store->default_sort_destroy;
397 list_store->default_sort_destroy = NULL;
398 d (list_store->default_sort_data);
399 list_store->default_sort_data = NULL;
403 (* G_OBJECT_CLASS (gtk_list_store_parent_class)->finalize) (object);
406 /* Fulfill the GtkTreeModel requirements */
407 static GtkTreeModelFlags
408 gtk_list_store_get_flags (GtkTreeModel *tree_model)
410 return GTK_TREE_MODEL_ITERS_PERSIST | GTK_TREE_MODEL_LIST_ONLY;
414 gtk_list_store_get_n_columns (GtkTreeModel *tree_model)
416 GtkListStore *list_store = (GtkListStore *) tree_model;
418 list_store->columns_dirty = TRUE;
420 return list_store->n_columns;
424 gtk_list_store_get_column_type (GtkTreeModel *tree_model,
427 GtkListStore *list_store = (GtkListStore *) tree_model;
429 g_return_val_if_fail (index < GTK_LIST_STORE (tree_model)->n_columns,
432 list_store->columns_dirty = TRUE;
434 return list_store->column_headers[index];
438 gtk_list_store_get_iter (GtkTreeModel *tree_model,
442 GtkListStore *list_store = (GtkListStore *) tree_model;
446 list_store->columns_dirty = TRUE;
448 seq = list_store->seq;
450 i = gtk_tree_path_get_indices (path)[0];
452 if (i >= g_sequence_get_length (seq))
455 iter->stamp = list_store->stamp;
456 iter->user_data = g_sequence_get_iter_at_pos (seq, i);
462 gtk_list_store_get_path (GtkTreeModel *tree_model,
467 g_return_val_if_fail (iter->stamp == GTK_LIST_STORE (tree_model)->stamp, NULL);
469 if (g_sequence_iter_is_end (iter->user_data))
472 path = gtk_tree_path_new ();
473 gtk_tree_path_append_index (path, g_sequence_iter_get_position (iter->user_data));
479 gtk_list_store_get_value (GtkTreeModel *tree_model,
484 GtkListStore *list_store = (GtkListStore *) tree_model;
485 GtkTreeDataList *list;
486 gint tmp_column = column;
488 g_return_if_fail (column < list_store->n_columns);
489 g_return_if_fail (VALID_ITER (iter, list_store));
491 list = g_sequence_get (iter->user_data);
493 while (tmp_column-- > 0 && list)
497 g_value_init (value, list_store->column_headers[column]);
499 _gtk_tree_data_list_node_to_value (list,
500 list_store->column_headers[column],
505 gtk_list_store_iter_next (GtkTreeModel *tree_model,
508 g_return_val_if_fail (GTK_LIST_STORE (tree_model)->stamp == iter->stamp, FALSE);
509 iter->user_data = g_sequence_iter_next (iter->user_data);
511 return !g_sequence_iter_is_end (iter->user_data);
515 gtk_list_store_iter_children (GtkTreeModel *tree_model,
519 GtkListStore *list_store = (GtkListStore *) tree_model;
521 /* this is a list, nodes have no children */
525 if (g_sequence_get_length (list_store->seq) > 0)
527 iter->stamp = list_store->stamp;
528 iter->user_data = g_sequence_get_begin_iter (list_store->seq);
536 gtk_list_store_iter_has_child (GtkTreeModel *tree_model,
543 gtk_list_store_iter_n_children (GtkTreeModel *tree_model,
546 GtkListStore *list_store = (GtkListStore *) tree_model;
549 return g_sequence_get_length (list_store->seq);
551 g_return_val_if_fail (list_store->stamp == iter->stamp, -1);
557 gtk_list_store_iter_nth_child (GtkTreeModel *tree_model,
562 GtkListStore *list_store = (GtkListStore *) tree_model;
563 GSequenceIter *child;
568 child = g_sequence_get_iter_at_pos (list_store->seq, n);
570 if (g_sequence_iter_is_end (child))
573 iter->stamp = list_store->stamp;
574 iter->user_data = child;
580 gtk_list_store_iter_parent (GtkTreeModel *tree_model,
588 gtk_list_store_real_set_value (GtkListStore *list_store,
594 GtkTreeDataList *list;
595 GtkTreeDataList *prev;
596 gint old_column = column;
597 GValue real_value = {0, };
598 gboolean converted = FALSE;
599 gboolean retval = FALSE;
601 if (! g_type_is_a (G_VALUE_TYPE (value), list_store->column_headers[column]))
603 if (! (g_value_type_compatible (G_VALUE_TYPE (value), list_store->column_headers[column]) &&
604 g_value_type_compatible (list_store->column_headers[column], G_VALUE_TYPE (value))))
606 g_warning ("%s: Unable to convert from %s to %s\n",
608 g_type_name (G_VALUE_TYPE (value)),
609 g_type_name (list_store->column_headers[column]));
612 if (!g_value_transform (value, &real_value))
614 g_warning ("%s: Unable to make conversion from %s to %s\n",
616 g_type_name (G_VALUE_TYPE (value)),
617 g_type_name (list_store->column_headers[column]));
618 g_value_unset (&real_value);
624 prev = list = g_sequence_get (iter->user_data);
631 _gtk_tree_data_list_value_to_node (list, &real_value);
633 _gtk_tree_data_list_value_to_node (list, value);
636 g_value_unset (&real_value);
637 if (sort && GTK_LIST_STORE_IS_SORTED (list_store))
638 gtk_list_store_sort_iter_changed (list_store, iter, old_column);
647 if (g_sequence_get (iter->user_data) == NULL)
649 list = _gtk_tree_data_list_alloc();
650 g_sequence_set (iter->user_data, list);
655 list = prev->next = _gtk_tree_data_list_alloc ();
661 list->next = _gtk_tree_data_list_alloc ();
668 _gtk_tree_data_list_value_to_node (list, &real_value);
670 _gtk_tree_data_list_value_to_node (list, value);
674 g_value_unset (&real_value);
676 if (sort && GTK_LIST_STORE_IS_SORTED (list_store))
677 gtk_list_store_sort_iter_changed (list_store, iter, old_column);
684 * gtk_list_store_set_value:
685 * @list_store: A #GtkListStore
686 * @iter: A valid #GtkTreeIter for the row being modified
687 * @column: column number to modify
688 * @value: new value for the cell
690 * Sets the data in the cell specified by @iter and @column.
691 * The type of @value must be convertible to the type of the
696 gtk_list_store_set_value (GtkListStore *list_store,
701 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
702 g_return_if_fail (VALID_ITER (iter, list_store));
703 g_return_if_fail (column >= 0 && column < list_store->n_columns);
704 g_return_if_fail (G_IS_VALUE (value));
706 if (gtk_list_store_real_set_value (list_store, iter, column, value, TRUE))
710 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
711 gtk_tree_model_row_changed (GTK_TREE_MODEL (list_store), path, iter);
712 gtk_tree_path_free (path);
716 static GtkTreeIterCompareFunc
717 gtk_list_store_get_compare_func (GtkListStore *list_store)
719 GtkTreeIterCompareFunc func = NULL;
721 if (GTK_LIST_STORE_IS_SORTED (list_store))
723 if (list_store->sort_column_id != -1)
725 GtkTreeDataSortHeader *header;
726 header = _gtk_tree_data_list_get_header (list_store->sort_list,
727 list_store->sort_column_id);
728 g_return_val_if_fail (header != NULL, NULL);
729 g_return_val_if_fail (header->func != NULL, NULL);
734 func = list_store->default_sort_func;
742 gtk_list_store_set_vector_internal (GtkListStore *list_store,
744 gboolean *emit_signal,
745 gboolean *maybe_need_sort,
751 GtkTreeIterCompareFunc func = NULL;
753 func = gtk_list_store_get_compare_func (list_store);
754 if (func != _gtk_tree_data_list_compare_func)
755 *maybe_need_sort = TRUE;
757 for (i = 0; i < n_values; i++)
759 *emit_signal = gtk_list_store_real_set_value (list_store,
763 FALSE) || *emit_signal;
765 if (func == _gtk_tree_data_list_compare_func &&
766 columns[i] == list_store->sort_column_id)
767 *maybe_need_sort = TRUE;
772 gtk_list_store_set_valist_internal (GtkListStore *list_store,
774 gboolean *emit_signal,
775 gboolean *maybe_need_sort,
779 GtkTreeIterCompareFunc func = NULL;
781 column = va_arg (var_args, gint);
783 func = gtk_list_store_get_compare_func (list_store);
784 if (func != _gtk_tree_data_list_compare_func)
785 *maybe_need_sort = TRUE;
789 GValue value = { 0, };
792 if (column < 0 || column >= list_store->n_columns)
794 g_warning ("%s: Invalid column number %d added to iter (remember to end your list of columns with a -1)", G_STRLOC, column);
797 g_value_init (&value, list_store->column_headers[column]);
799 G_VALUE_COLLECT (&value, var_args, 0, &error);
802 g_warning ("%s: %s", G_STRLOC, error);
805 /* we purposely leak the value here, it might not be
806 * in a sane state if an error condition occoured
811 /* FIXME: instead of calling this n times, refactor with above */
812 *emit_signal = gtk_list_store_real_set_value (list_store,
816 FALSE) || *emit_signal;
818 if (func == _gtk_tree_data_list_compare_func &&
819 column == list_store->sort_column_id)
820 *maybe_need_sort = TRUE;
822 g_value_unset (&value);
824 column = va_arg (var_args, gint);
829 * gtk_list_store_set_valuesv:
830 * @list_store: A #GtkListStore
831 * @iter: A valid #GtkTreeIter for the row being modified
832 * @columns: an array of column numbers
833 * @values: an array of GValues
834 * @n_values: the length of the @columns and @values arrays
836 * A variant of gtk_list_store_set_valist() which
837 * takes the columns and values as two arrays, instead of
838 * varargs. This function is mainly intended for
839 * language-bindings and in case the number of columns to
840 * change is not known until run-time.
845 gtk_list_store_set_valuesv (GtkListStore *list_store,
851 gboolean emit_signal = FALSE;
852 gboolean maybe_need_sort = FALSE;
854 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
855 g_return_if_fail (VALID_ITER (iter, list_store));
857 gtk_list_store_set_vector_internal (list_store, iter,
860 columns, values, n_values);
862 if (maybe_need_sort && GTK_LIST_STORE_IS_SORTED (list_store))
863 gtk_list_store_sort_iter_changed (list_store, iter, list_store->sort_column_id);
869 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
870 gtk_tree_model_row_changed (GTK_TREE_MODEL (list_store), path, iter);
871 gtk_tree_path_free (path);
876 * gtk_list_store_set_valist:
877 * @list_store: A #GtkListStore
878 * @iter: A valid #GtkTreeIter for the row being modified
879 * @var_args: va_list of column/value pairs
881 * See gtk_list_store_set(); this version takes a va_list for use by language
886 gtk_list_store_set_valist (GtkListStore *list_store,
890 gboolean emit_signal = FALSE;
891 gboolean maybe_need_sort = FALSE;
893 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
894 g_return_if_fail (VALID_ITER (iter, list_store));
896 gtk_list_store_set_valist_internal (list_store, iter,
901 if (maybe_need_sort && GTK_LIST_STORE_IS_SORTED (list_store))
902 gtk_list_store_sort_iter_changed (list_store, iter, list_store->sort_column_id);
908 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
909 gtk_tree_model_row_changed (GTK_TREE_MODEL (list_store), path, iter);
910 gtk_tree_path_free (path);
915 * gtk_list_store_set:
916 * @list_store: a #GtkListStore
917 * @iter: row iterator
918 * @Varargs: pairs of column number and value, terminated with -1
920 * Sets the value of one or more cells in the row referenced by @iter.
921 * The variable argument list should contain integer column numbers,
922 * each column number followed by the value to be set.
923 * The list is terminated by a -1. For example, to set column 0 with type
924 * %G_TYPE_STRING to "Foo", you would write <literal>gtk_list_store_set (store, iter,
925 * 0, "Foo", -1)</literal>.
928 gtk_list_store_set (GtkListStore *list_store,
934 va_start (var_args, iter);
935 gtk_list_store_set_valist (list_store, iter, var_args);
940 * gtk_list_store_remove:
941 * @list_store: A #GtkListStore
942 * @iter: A valid #GtkTreeIter
944 * Removes the given row from the list store. After being removed,
945 * @iter is set to be the next valid row, or invalidated if it pointed
946 * to the last row in @list_store.
948 * Return value: %TRUE if @iter is valid, %FALSE if not.
951 gtk_list_store_remove (GtkListStore *list_store,
955 GSequenceIter *ptr, *next;
957 g_return_val_if_fail (GTK_IS_LIST_STORE (list_store), FALSE);
958 g_return_val_if_fail (VALID_ITER (iter, list_store), FALSE);
960 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
962 ptr = iter->user_data;
963 next = g_sequence_iter_next (ptr);
965 _gtk_tree_data_list_free (g_sequence_get (ptr), list_store->column_headers);
966 g_sequence_remove (iter->user_data);
968 list_store->length--;
970 gtk_tree_model_row_deleted (GTK_TREE_MODEL (list_store), path);
971 gtk_tree_path_free (path);
973 if (g_sequence_iter_is_end (next))
980 iter->stamp = list_store->stamp;
981 iter->user_data = next;
987 * gtk_list_store_insert:
988 * @list_store: A #GtkListStore
989 * @iter: An unset #GtkTreeIter to set to the new row
990 * @position: position to insert the new row
992 * Creates a new row at @position. @iter will be changed to point to this new
993 * row. If @position is larger than the number of rows on the list, then the
994 * new row will be appended to the list. The row will be empty after this
995 * function is called. To fill in values, you need to call
996 * gtk_list_store_set() or gtk_list_store_set_value().
1000 gtk_list_store_insert (GtkListStore *list_store,
1009 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
1010 g_return_if_fail (iter != NULL);
1011 g_return_if_fail (position >= 0);
1013 list_store->columns_dirty = TRUE;
1015 seq = list_store->seq;
1017 length = g_sequence_get_length (seq);
1018 if (position > length)
1021 ptr = g_sequence_get_iter_at_pos (seq, position);
1022 ptr = g_sequence_insert_before (ptr, NULL);
1024 iter->stamp = list_store->stamp;
1025 iter->user_data = ptr;
1027 g_assert (VALID_ITER (iter, list_store));
1029 list_store->length++;
1031 path = gtk_tree_path_new ();
1032 gtk_tree_path_append_index (path, position);
1033 gtk_tree_model_row_inserted (GTK_TREE_MODEL (list_store), path, iter);
1034 gtk_tree_path_free (path);
1038 * gtk_list_store_insert_before:
1039 * @list_store: A #GtkListStore
1040 * @iter: An unset #GtkTreeIter to set to the new row
1041 * @sibling: A valid #GtkTreeIter, or %NULL
1043 * Inserts a new row before @sibling. If @sibling is %NULL, then the row will
1044 * be appended to the end of the list. @iter will be changed to point to this
1045 * new row. The row will be empty after this function is called. To fill in
1046 * values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
1050 gtk_list_store_insert_before (GtkListStore *list_store,
1052 GtkTreeIter *sibling)
1054 GSequenceIter *after;
1056 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
1057 g_return_if_fail (iter != NULL);
1059 g_return_if_fail (VALID_ITER (sibling, list_store));
1062 after = g_sequence_get_end_iter (list_store->seq);
1064 after = sibling->user_data;
1066 gtk_list_store_insert (list_store, iter, g_sequence_iter_get_position (after));
1070 * gtk_list_store_insert_after:
1071 * @list_store: A #GtkListStore
1072 * @iter: An unset #GtkTreeIter to set to the new row
1073 * @sibling: A valid #GtkTreeIter, or %NULL
1075 * Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
1076 * prepended to the beginning of the list. @iter will be changed to point to
1077 * this new row. The row will be empty after this function is called. To fill
1078 * in values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
1082 gtk_list_store_insert_after (GtkListStore *list_store,
1084 GtkTreeIter *sibling)
1086 GSequenceIter *after;
1088 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
1089 g_return_if_fail (iter != NULL);
1091 g_return_if_fail (VALID_ITER (sibling, list_store));
1094 after = g_sequence_get_begin_iter (list_store->seq);
1096 after = g_sequence_iter_next (sibling->user_data);
1098 gtk_list_store_insert (list_store, iter, g_sequence_iter_get_position (after));
1102 * gtk_list_store_prepend:
1103 * @list_store: A #GtkListStore
1104 * @iter: An unset #GtkTreeIter to set to the prepend row
1106 * Prepends a new row to @list_store. @iter will be changed to point to this new
1107 * row. The row will be empty after this function is called. To fill in
1108 * values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
1112 gtk_list_store_prepend (GtkListStore *list_store,
1115 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
1116 g_return_if_fail (iter != NULL);
1118 gtk_list_store_insert (list_store, iter, 0);
1122 * gtk_list_store_append:
1123 * @list_store: A #GtkListStore
1124 * @iter: An unset #GtkTreeIter to set to the appended row
1126 * Appends a new row to @list_store. @iter will be changed to point to this new
1127 * row. The row will be empty after this function is called. To fill in
1128 * values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
1132 gtk_list_store_append (GtkListStore *list_store,
1135 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
1136 g_return_if_fail (iter != NULL);
1138 gtk_list_store_insert (list_store, iter, g_sequence_get_length (list_store->seq));
1142 gtk_list_store_increment_stamp (GtkListStore *list_store)
1146 list_store->stamp++;
1148 while (list_store->stamp == 0);
1152 * gtk_list_store_clear:
1153 * @list_store: a #GtkListStore.
1155 * Removes all rows from the list store.
1159 gtk_list_store_clear (GtkListStore *list_store)
1162 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
1164 while (g_sequence_get_length (list_store->seq) > 0)
1166 iter.stamp = list_store->stamp;
1167 iter.user_data = g_sequence_get_begin_iter (list_store->seq);
1168 gtk_list_store_remove (list_store, &iter);
1171 gtk_list_store_increment_stamp (list_store);
1175 * gtk_list_store_iter_is_valid:
1176 * @list_store: A #GtkListStore.
1177 * @iter: A #GtkTreeIter.
1179 * <warning>This function is slow. Only use it for debugging and/or testing
1180 * purposes.</warning>
1182 * Checks if the given iter is a valid iter for this #GtkListStore.
1184 * Return value: %TRUE if the iter is valid, %FALSE if the iter is invalid.
1189 gtk_list_store_iter_is_valid (GtkListStore *list_store,
1192 g_return_val_if_fail (GTK_IS_LIST_STORE (list_store), FALSE);
1193 g_return_val_if_fail (iter != NULL, FALSE);
1195 if (!VALID_ITER (iter, list_store))
1198 if (g_sequence_iter_get_sequence (iter->user_data) != list_store->seq)
1204 static gboolean real_gtk_list_store_row_draggable (GtkTreeDragSource *drag_source,
1211 gtk_list_store_drag_data_delete (GtkTreeDragSource *drag_source,
1216 if (gtk_list_store_get_iter (GTK_TREE_MODEL (drag_source),
1220 gtk_list_store_remove (GTK_LIST_STORE (drag_source), &iter);
1227 gtk_list_store_drag_data_get (GtkTreeDragSource *drag_source,
1229 GtkSelectionData *selection_data)
1231 /* Note that we don't need to handle the GTK_TREE_MODEL_ROW
1232 * target, because the default handler does it for us, but
1233 * we do anyway for the convenience of someone maybe overriding the
1237 if (gtk_tree_set_row_drag_data (selection_data,
1238 GTK_TREE_MODEL (drag_source),
1245 /* FIXME handle text targets at least. */
1252 gtk_list_store_drag_data_received (GtkTreeDragDest *drag_dest,
1254 GtkSelectionData *selection_data)
1256 GtkTreeModel *tree_model;
1257 GtkListStore *list_store;
1258 GtkTreeModel *src_model = NULL;
1259 GtkTreePath *src_path = NULL;
1260 gboolean retval = FALSE;
1262 tree_model = GTK_TREE_MODEL (drag_dest);
1263 list_store = GTK_LIST_STORE (drag_dest);
1265 if (gtk_tree_get_row_drag_data (selection_data,
1268 src_model == tree_model)
1270 /* Copy the given row to a new position */
1271 GtkTreeIter src_iter;
1272 GtkTreeIter dest_iter;
1275 if (!gtk_list_store_get_iter (src_model,
1282 /* Get the path to insert _after_ (dest is the path to insert _before_) */
1283 prev = gtk_tree_path_copy (dest);
1285 if (!gtk_tree_path_prev (prev))
1287 /* dest was the first spot in the list; which means we are supposed
1290 gtk_list_store_prepend (list_store, &dest_iter);
1296 if (gtk_list_store_get_iter (tree_model, &dest_iter, prev))
1298 GtkTreeIter tmp_iter = dest_iter;
1300 gtk_list_store_insert_after (list_store, &dest_iter, &tmp_iter);
1306 gtk_tree_path_free (prev);
1308 /* If we succeeded in creating dest_iter, copy data from src
1312 GtkTreeDataList *dl = g_sequence_get (src_iter.user_data);
1313 GtkTreeDataList *copy_head = NULL;
1314 GtkTreeDataList *copy_prev = NULL;
1315 GtkTreeDataList *copy_iter = NULL;
1322 copy_iter = _gtk_tree_data_list_node_copy (dl,
1323 list_store->column_headers[col]);
1325 if (copy_head == NULL)
1326 copy_head = copy_iter;
1329 copy_prev->next = copy_iter;
1331 copy_prev = copy_iter;
1337 dest_iter.stamp = list_store->stamp;
1338 g_sequence_set (dest_iter.user_data, copy_head);
1340 path = gtk_list_store_get_path (tree_model, &dest_iter);
1341 gtk_tree_model_row_changed (tree_model, path, &dest_iter);
1342 gtk_tree_path_free (path);
1347 /* FIXME maybe add some data targets eventually, or handle text
1348 * targets in the simple case.
1355 gtk_tree_path_free (src_path);
1361 gtk_list_store_row_drop_possible (GtkTreeDragDest *drag_dest,
1362 GtkTreePath *dest_path,
1363 GtkSelectionData *selection_data)
1366 GtkTreeModel *src_model = NULL;
1367 GtkTreePath *src_path = NULL;
1368 gboolean retval = FALSE;
1370 /* don't accept drops if the list has been sorted */
1371 if (GTK_LIST_STORE_IS_SORTED (drag_dest))
1374 if (!gtk_tree_get_row_drag_data (selection_data,
1379 if (src_model != GTK_TREE_MODEL (drag_dest))
1382 if (gtk_tree_path_get_depth (dest_path) != 1)
1385 /* can drop before any existing node, or before one past any existing. */
1387 indices = gtk_tree_path_get_indices (dest_path);
1389 if (indices[0] <= g_sequence_get_length (GTK_LIST_STORE (drag_dest)->seq))
1394 gtk_tree_path_free (src_path);
1399 /* Sorting and reordering */
1403 gtk_list_store_reorder_func (GSequenceIter *a,
1407 GHashTable *new_positions = user_data;
1408 gint apos = GPOINTER_TO_INT (g_hash_table_lookup (new_positions, a));
1409 gint bpos = GPOINTER_TO_INT (g_hash_table_lookup (new_positions, b));
1419 * gtk_list_store_reorder:
1420 * @store: A #GtkListStore.
1421 * @new_order: an array of integers mapping the new position of each child
1422 * to its old position before the re-ordering,
1423 * i.e. @new_order<literal>[newpos] = oldpos</literal>.
1425 * Reorders @store to follow the order indicated by @new_order. Note that
1426 * this function only works with unsorted stores.
1431 gtk_list_store_reorder (GtkListStore *store,
1436 GHashTable *new_positions;
1440 g_return_if_fail (GTK_IS_LIST_STORE (store));
1441 g_return_if_fail (!GTK_LIST_STORE_IS_SORTED (store));
1442 g_return_if_fail (new_order != NULL);
1444 order = g_new (gint, g_sequence_get_length (store->seq));
1445 for (i = 0; i < g_sequence_get_length (store->seq); i++)
1446 order[new_order[i]] = i;
1448 new_positions = g_hash_table_new (g_direct_hash, g_direct_equal);
1450 ptr = g_sequence_get_begin_iter (store->seq);
1452 while (!g_sequence_iter_is_end (ptr))
1454 g_hash_table_insert (new_positions, ptr, GINT_TO_POINTER (order[i++]));
1456 ptr = g_sequence_iter_next (ptr);
1460 g_sequence_sort_iter (store->seq, gtk_list_store_reorder_func, new_positions);
1462 g_hash_table_destroy (new_positions);
1465 path = gtk_tree_path_new ();
1466 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (store),
1467 path, NULL, new_order);
1468 gtk_tree_path_free (path);
1472 save_positions (GSequence *seq)
1474 GHashTable *positions = g_hash_table_new (g_direct_hash, g_direct_equal);
1477 ptr = g_sequence_get_begin_iter (seq);
1478 while (!g_sequence_iter_is_end (ptr))
1480 g_hash_table_insert (positions, ptr,
1481 GINT_TO_POINTER (g_sequence_iter_get_position (ptr)));
1482 ptr = g_sequence_iter_next (ptr);
1489 generate_order (GSequence *seq,
1490 GHashTable *old_positions)
1493 int *order = g_new (int, g_sequence_get_length (seq));
1497 ptr = g_sequence_get_begin_iter (seq);
1498 while (!g_sequence_iter_is_end (ptr))
1500 int old_pos = GPOINTER_TO_INT (g_hash_table_lookup (old_positions, ptr));
1501 order[i++] = old_pos;
1502 ptr = g_sequence_iter_next (ptr);
1505 g_hash_table_destroy (old_positions);
1511 * gtk_list_store_swap:
1512 * @store: A #GtkListStore.
1513 * @a: A #GtkTreeIter.
1514 * @b: Another #GtkTreeIter.
1516 * Swaps @a and @b in @store. Note that this function only works with
1522 gtk_list_store_swap (GtkListStore *store,
1526 GHashTable *old_positions;
1530 g_return_if_fail (GTK_IS_LIST_STORE (store));
1531 g_return_if_fail (!GTK_LIST_STORE_IS_SORTED (store));
1532 g_return_if_fail (VALID_ITER (a, store));
1533 g_return_if_fail (VALID_ITER (b, store));
1535 if (a->user_data == b->user_data)
1538 old_positions = save_positions (store->seq);
1540 g_sequence_swap (a->user_data, b->user_data);
1542 order = generate_order (store->seq, old_positions);
1543 path = gtk_tree_path_new ();
1545 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (store),
1548 gtk_tree_path_free (path);
1553 gtk_list_store_move_to (GtkListStore *store,
1557 GHashTable *old_positions;
1561 old_positions = save_positions (store->seq);
1563 g_sequence_move (iter->user_data, g_sequence_get_iter_at_pos (store->seq, new_pos));
1565 order = generate_order (store->seq, old_positions);
1567 path = gtk_tree_path_new ();
1568 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (store),
1570 gtk_tree_path_free (path);
1575 * gtk_list_store_move_before:
1576 * @store: A #GtkListStore.
1577 * @iter: A #GtkTreeIter.
1578 * @position: A #GtkTreeIter, or %NULL.
1580 * Moves @iter in @store to the position before @position. Note that this
1581 * function only works with unsorted stores. If @position is %NULL, @iter
1582 * will be moved to the end of the list.
1587 gtk_list_store_move_before (GtkListStore *store,
1589 GtkTreeIter *position)
1593 g_return_if_fail (GTK_IS_LIST_STORE (store));
1594 g_return_if_fail (!GTK_LIST_STORE_IS_SORTED (store));
1595 g_return_if_fail (VALID_ITER (iter, store));
1597 g_return_if_fail (VALID_ITER (position, store));
1600 pos = g_sequence_iter_get_position (position->user_data);
1604 gtk_list_store_move_to (store, iter, pos);
1608 * gtk_list_store_move_after:
1609 * @store: A #GtkListStore.
1610 * @iter: A #GtkTreeIter.
1611 * @position: A #GtkTreeIter or %NULL.
1613 * Moves @iter in @store to the position after @position. Note that this
1614 * function only works with unsorted stores. If @position is %NULL, @iter
1615 * will be moved to the start of the list.
1620 gtk_list_store_move_after (GtkListStore *store,
1622 GtkTreeIter *position)
1626 g_return_if_fail (GTK_IS_LIST_STORE (store));
1627 g_return_if_fail (!GTK_LIST_STORE_IS_SORTED (store));
1628 g_return_if_fail (VALID_ITER (iter, store));
1630 g_return_if_fail (VALID_ITER (position, store));
1633 pos = g_sequence_iter_get_position (position->user_data) + 1;
1637 gtk_list_store_move_to (store, iter, pos);
1642 gtk_list_store_compare_func (GSequenceIter *a,
1646 GtkListStore *list_store = user_data;
1650 GtkTreeIterCompareFunc func;
1653 if (list_store->sort_column_id != -1)
1655 GtkTreeDataSortHeader *header;
1657 header = _gtk_tree_data_list_get_header (list_store->sort_list,
1658 list_store->sort_column_id);
1659 g_return_val_if_fail (header != NULL, 0);
1660 g_return_val_if_fail (header->func != NULL, 0);
1662 func = header->func;
1663 data = header->data;
1667 g_return_val_if_fail (list_store->default_sort_func != NULL, 0);
1668 func = list_store->default_sort_func;
1669 data = list_store->default_sort_data;
1672 iter_a.stamp = list_store->stamp;
1673 iter_a.user_data = (gpointer)a;
1674 iter_b.stamp = list_store->stamp;
1675 iter_b.user_data = (gpointer)b;
1677 g_assert (VALID_ITER (&iter_a, list_store));
1678 g_assert (VALID_ITER (&iter_b, list_store));
1680 retval = (* func) (GTK_TREE_MODEL (list_store), &iter_a, &iter_b, data);
1682 if (list_store->order == GTK_SORT_DESCENDING)
1686 else if (retval < 0)
1694 gtk_list_store_sort (GtkListStore *list_store)
1698 GHashTable *old_positions;
1700 if (!GTK_LIST_STORE_IS_SORTED (list_store) ||
1701 g_sequence_get_length (list_store->seq) <= 1)
1704 old_positions = save_positions (list_store->seq);
1706 g_sequence_sort_iter (list_store->seq, gtk_list_store_compare_func, list_store);
1708 /* Let the world know about our new order */
1709 new_order = generate_order (list_store->seq, old_positions);
1711 path = gtk_tree_path_new ();
1712 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (list_store),
1713 path, NULL, new_order);
1714 gtk_tree_path_free (path);
1719 iter_is_sorted (GtkListStore *list_store,
1724 if (!g_sequence_iter_is_begin (iter->user_data))
1726 cmp = g_sequence_iter_prev (iter->user_data);
1727 if (gtk_list_store_compare_func (cmp, iter->user_data, list_store) > 0)
1731 cmp = g_sequence_iter_next (iter->user_data);
1732 if (!g_sequence_iter_is_end (cmp))
1734 if (gtk_list_store_compare_func (iter->user_data, cmp, list_store) > 0)
1742 gtk_list_store_sort_iter_changed (GtkListStore *list_store,
1749 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
1750 gtk_tree_model_row_changed (GTK_TREE_MODEL (list_store), path, iter);
1751 gtk_tree_path_free (path);
1753 if (!iter_is_sorted (list_store, iter))
1755 GHashTable *old_positions;
1758 old_positions = save_positions (list_store->seq);
1759 g_sequence_sort_changed_iter (iter->user_data,
1760 gtk_list_store_compare_func,
1762 order = generate_order (list_store->seq, old_positions);
1763 path = gtk_tree_path_new ();
1764 gtk_tree_model_rows_reordered (GTK_TREE_MODEL (list_store),
1766 gtk_tree_path_free (path);
1772 gtk_list_store_get_sort_column_id (GtkTreeSortable *sortable,
1773 gint *sort_column_id,
1776 GtkListStore *list_store = (GtkListStore *) sortable;
1779 * sort_column_id = list_store->sort_column_id;
1781 * order = list_store->order;
1783 if (list_store->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID ||
1784 list_store->sort_column_id == GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1791 gtk_list_store_set_sort_column_id (GtkTreeSortable *sortable,
1792 gint sort_column_id,
1795 GtkListStore *list_store = (GtkListStore *) sortable;
1797 if ((list_store->sort_column_id == sort_column_id) &&
1798 (list_store->order == order))
1801 if (sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
1803 if (sort_column_id != GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1805 GtkTreeDataSortHeader *header = NULL;
1807 header = _gtk_tree_data_list_get_header (list_store->sort_list,
1810 /* We want to make sure that we have a function */
1811 g_return_if_fail (header != NULL);
1812 g_return_if_fail (header->func != NULL);
1816 g_return_if_fail (list_store->default_sort_func != NULL);
1821 list_store->sort_column_id = sort_column_id;
1822 list_store->order = order;
1824 gtk_tree_sortable_sort_column_changed (sortable);
1826 gtk_list_store_sort (list_store);
1830 gtk_list_store_set_sort_func (GtkTreeSortable *sortable,
1831 gint sort_column_id,
1832 GtkTreeIterCompareFunc func,
1834 GDestroyNotify destroy)
1836 GtkListStore *list_store = (GtkListStore *) sortable;
1838 list_store->sort_list = _gtk_tree_data_list_set_header (list_store->sort_list,
1840 func, data, destroy);
1842 if (list_store->sort_column_id == sort_column_id)
1843 gtk_list_store_sort (list_store);
1847 gtk_list_store_set_default_sort_func (GtkTreeSortable *sortable,
1848 GtkTreeIterCompareFunc func,
1850 GDestroyNotify destroy)
1852 GtkListStore *list_store = (GtkListStore *) sortable;
1854 if (list_store->default_sort_destroy)
1856 GDestroyNotify d = list_store->default_sort_destroy;
1858 list_store->default_sort_destroy = NULL;
1859 d (list_store->default_sort_data);
1862 list_store->default_sort_func = func;
1863 list_store->default_sort_data = data;
1864 list_store->default_sort_destroy = destroy;
1866 if (list_store->sort_column_id == GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID)
1867 gtk_list_store_sort (list_store);
1871 gtk_list_store_has_default_sort_func (GtkTreeSortable *sortable)
1873 GtkListStore *list_store = (GtkListStore *) sortable;
1875 return (list_store->default_sort_func != NULL);
1880 * gtk_list_store_insert_with_values:
1881 * @list_store: A #GtkListStore
1882 * @iter: An unset #GtkTreeIter to set to the new row, or %NULL.
1883 * @position: position to insert the new row
1884 * @Varargs: pairs of column number and value, terminated with -1
1886 * Creates a new row at @position. @iter will be changed to point to this new
1887 * row. If @position is larger than the number of rows on the list, then the
1888 * new row will be appended to the list. The row will be filled with the
1889 * values given to this function.
1892 * <literal>gtk_list_store_insert_with_values(list_store, iter, position...)</literal>
1893 * has the same effect as calling
1895 * gtk_list_store_insert (list_store, iter, position);
1896 * gtk_list_store_set (list_store, iter, ...);
1898 * with the difference that the former will only emit a row_inserted signal,
1899 * while the latter will emit row_inserted, row_changed and, if the list store
1900 * is sorted, rows_reordered. Since emitting the rows_reordered signal
1901 * repeatedly can affect the performance of the program,
1902 * gtk_list_store_insert_with_values() should generally be preferred when
1903 * inserting rows in a sorted list store.
1908 gtk_list_store_insert_with_values (GtkListStore *list_store,
1916 GtkTreeIter tmp_iter;
1918 gboolean changed = FALSE;
1919 gboolean maybe_need_sort = FALSE;
1922 /* FIXME: refactor to reduce overlap with gtk_list_store_set() */
1923 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
1928 list_store->columns_dirty = TRUE;
1930 seq = list_store->seq;
1932 length = g_sequence_get_length (seq);
1933 if (position > length)
1936 ptr = g_sequence_get_iter_at_pos (seq, position);
1937 ptr = g_sequence_insert_before (ptr, NULL);
1939 iter->stamp = list_store->stamp;
1940 iter->user_data = ptr;
1942 g_assert (VALID_ITER (iter, list_store));
1944 list_store->length++;
1946 va_start (var_args, position);
1947 gtk_list_store_set_valist_internal (list_store, iter,
1948 &changed, &maybe_need_sort,
1952 /* Don't emit rows_reordered here */
1953 if (maybe_need_sort && GTK_LIST_STORE_IS_SORTED (list_store))
1954 g_sequence_sort_changed_iter (iter->user_data,
1955 gtk_list_store_compare_func,
1958 /* Just emit row_inserted */
1959 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
1960 gtk_tree_model_row_inserted (GTK_TREE_MODEL (list_store), path, iter);
1961 gtk_tree_path_free (path);
1966 * gtk_list_store_insert_with_valuesv:
1967 * @list_store: A #GtkListStore
1968 * @iter: An unset #GtkTreeIter to set to the new row, or %NULL.
1969 * @position: position to insert the new row
1970 * @columns: an array of column numbers
1971 * @values: an array of GValues
1972 * @n_values: the length of the @columns and @values arrays
1974 * A variant of gtk_list_store_insert_with_values() which
1975 * takes the columns and values as two arrays, instead of
1976 * varargs. This function is mainly intended for
1977 * language-bindings.
1982 gtk_list_store_insert_with_valuesv (GtkListStore *list_store,
1992 GtkTreeIter tmp_iter;
1994 gboolean changed = FALSE;
1995 gboolean maybe_need_sort = FALSE;
1997 /* FIXME refactor to reduce overlap with
1998 * gtk_list_store_insert_with_values()
2000 g_return_if_fail (GTK_IS_LIST_STORE (list_store));
2005 list_store->columns_dirty = TRUE;
2007 seq = list_store->seq;
2009 length = g_sequence_get_length (seq);
2010 if (position > length)
2013 ptr = g_sequence_get_iter_at_pos (seq, position);
2014 ptr = g_sequence_insert_before (ptr, NULL);
2016 iter->stamp = list_store->stamp;
2017 iter->user_data = ptr;
2019 g_assert (VALID_ITER (iter, list_store));
2021 list_store->length++;
2023 gtk_list_store_set_vector_internal (list_store, iter,
2024 &changed, &maybe_need_sort,
2025 columns, values, n_values);
2027 /* Don't emit rows_reordered here */
2028 if (maybe_need_sort && GTK_LIST_STORE_IS_SORTED (list_store))
2029 g_sequence_sort_changed_iter (iter->user_data,
2030 gtk_list_store_compare_func,
2033 /* Just emit row_inserted */
2034 path = gtk_list_store_get_path (GTK_TREE_MODEL (list_store), iter);
2035 gtk_tree_model_row_inserted (GTK_TREE_MODEL (list_store), path, iter);
2036 gtk_tree_path_free (path);
2039 /* GtkBuildable custom tag implementation
2042 * <column type="..."/>
2043 * <column type="..."/>
2047 gboolean translatable;
2053 GtkBuilder *builder;
2055 GSList *column_type_names;
2056 GType *column_types;
2065 const gchar *domain;
2069 list_store_start_element (GMarkupParseContext *context,
2070 const gchar *element_name,
2071 const gchar **names,
2072 const gchar **values,
2077 SubParserData *data = (SubParserData*)user_data;
2079 if (strcmp (element_name, "col") == 0)
2082 gchar *context = NULL;
2083 gboolean translatable = FALSE;
2086 if (data->row_column >= data->n_columns)
2088 g_set_error (error, data->error_quark, 0,
2089 "Too many columns, maximum is %d\n", data->n_columns - 1);
2093 for (i = 0; names[i]; i++)
2094 if (strcmp (names[i], "id") == 0)
2097 id = atoi (values[i]);
2100 g_set_error (error, data->error_quark, 0,
2101 "the id tag %s could not be converted to an integer",
2105 if (id < 0 || id >= data->n_columns)
2107 g_set_error (error, data->error_quark, 0,
2108 "id value %d out of range", id);
2112 else if (strcmp (names[i], "translatable") == 0)
2114 if (!_gtk_builder_boolean_from_string (values[i], &translatable,
2118 else if (strcmp (names[i], "comments") == 0)
2120 /* do nothing, comments are for translators */
2122 else if (strcmp (names[i], "context") == 0)
2124 context = g_strdup (values[i]);
2129 g_set_error (error, data->error_quark, 0,
2130 "<col> needs an id attribute");
2134 info = g_slice_new0 (ColInfo);
2135 info->translatable = translatable;
2136 info->context = context;
2139 data->colids[data->row_column] = id;
2140 data->columns[data->row_column] = info;
2142 data->is_data = TRUE;
2144 else if (strcmp (element_name, "row") == 0)
2146 else if (strcmp (element_name, "column") == 0)
2147 for (i = 0; names[i]; i++)
2148 if (strcmp (names[i], "type") == 0)
2149 data->column_type_names = g_slist_prepend (data->column_type_names,
2150 g_strdup (values[i]));
2151 else if (strcmp (element_name, "columns") == 0)
2153 else if (strcmp (element_name, "data") == 0)
2156 g_set_error (error, data->error_quark, 0,
2157 "Unknown start tag: %s", element_name);
2161 list_store_end_element (GMarkupParseContext *context,
2162 const gchar *element_name,
2166 SubParserData *data = (SubParserData*)user_data;
2168 g_assert (data->builder);
2170 if (strcmp (element_name, "row") == 0)
2175 gtk_list_store_insert_with_valuesv (GTK_LIST_STORE (data->object),
2181 for (i = 0; i < data->row_column; i++)
2183 ColInfo *info = data->columns[i];
2184 g_free (info->context);
2185 g_slice_free (ColInfo, info);
2186 data->columns[i] = NULL;
2187 g_value_unset (&data->values[i]);
2189 g_free (data->values);
2190 data->values = g_new0 (GValue, data->n_columns);
2192 data->row_column = 0;
2194 else if (strcmp (element_name, "columns") == 0)
2196 GType *column_types;
2201 data->column_type_names = g_slist_reverse (data->column_type_names);
2202 column_types = g_new0 (GType, g_slist_length (data->column_type_names));
2204 for (l = data->column_type_names, i = 0; l; l = l->next, i++)
2206 type = gtk_builder_get_type_from_name (data->builder, l->data);
2207 if (type == G_TYPE_INVALID)
2209 g_warning ("Unknown type %s specified in treemodel %s",
2210 (const gchar*)l->data,
2211 gtk_buildable_get_name (GTK_BUILDABLE (data->object)));
2214 column_types[i] = type;
2219 gtk_list_store_set_column_types (GTK_LIST_STORE (data->object), i,
2222 g_free (column_types);
2224 else if (strcmp (element_name, "col") == 0)
2225 data->is_data = FALSE;
2226 else if (strcmp (element_name, "data") == 0)
2228 else if (strcmp (element_name, "column") == 0)
2231 g_set_error (error, data->error_quark, 0,
2232 "Unknown end tag: %s", element_name);
2236 list_store_text (GMarkupParseContext *context,
2242 SubParserData *data = (SubParserData*)user_data;
2244 GError *tmp_error = NULL;
2251 i = data->row_column - 1;
2252 info = data->columns[i];
2254 string = g_strndup (text, text_len);
2255 if (info->translatable && text_len)
2259 /* FIXME: This will not use the domain set in the .ui file,
2260 * since the parser is not telling the builder about the domain.
2261 * However, it will work for gtk_builder_set_translation_domain() calls.
2263 translated = _gtk_builder_parser_translate (data->domain,
2267 string = translated;
2270 if (!gtk_builder_value_from_string_type (data->builder,
2271 data->column_types[info->id],
2279 "Could not convert '%s' to type %s: %s\n",
2280 text, g_type_name (data->column_types[info->id]),
2281 tmp_error->message);
2282 g_error_free (tmp_error);
2287 static const GMarkupParser list_store_parser =
2289 list_store_start_element,
2290 list_store_end_element,
2295 gtk_list_store_buildable_custom_tag_start (GtkBuildable *buildable,
2296 GtkBuilder *builder,
2298 const gchar *tagname,
2299 GMarkupParser *parser,
2302 SubParserData *parser_data;
2307 if (strcmp (tagname, "columns") == 0)
2310 parser_data = g_slice_new0 (SubParserData);
2311 parser_data->builder = builder;
2312 parser_data->object = G_OBJECT (buildable);
2313 parser_data->column_type_names = NULL;
2315 *parser = list_store_parser;
2316 *data = parser_data;
2319 else if (strcmp (tagname, "data") == 0)
2321 gint n_columns = gtk_list_store_get_n_columns (GTK_TREE_MODEL (buildable));
2323 g_error ("Cannot append data to an empty model");
2325 parser_data = g_slice_new0 (SubParserData);
2326 parser_data->builder = builder;
2327 parser_data->object = G_OBJECT (buildable);
2328 parser_data->values = g_new0 (GValue, n_columns);
2329 parser_data->colids = g_new0 (gint, n_columns);
2330 parser_data->columns = g_new0 (ColInfo*, n_columns);
2331 parser_data->column_types = GTK_LIST_STORE (buildable)->column_headers;
2332 parser_data->n_columns = n_columns;
2333 parser_data->last_row = 0;
2334 parser_data->error_quark = g_quark_from_static_string ("GtkListStore");
2335 parser_data->domain = gtk_builder_get_translation_domain (builder);
2337 *parser = list_store_parser;
2338 *data = parser_data;
2342 g_warning ("Unknown custom list store tag: %s", tagname);
2348 gtk_list_store_buildable_custom_tag_end (GtkBuildable *buildable,
2349 GtkBuilder *builder,
2351 const gchar *tagname,
2354 SubParserData *sub = (SubParserData*)data;
2356 if (strcmp (tagname, "columns") == 0)
2358 g_slist_free (sub->column_type_names);
2359 g_slice_free (SubParserData, sub);
2361 else if (strcmp (tagname, "data") == 0)
2364 for (i = 0; i < sub->n_columns; i++)
2366 ColInfo *info = sub->columns[i];
2369 g_free (info->context);
2370 g_slice_free (ColInfo, info);
2373 g_free (sub->colids);
2374 g_free (sub->columns);
2375 g_free (sub->values);
2376 g_slice_free (SubParserData, sub);
2379 g_warning ("Unknown custom list store tag: %s", tagname);
2382 #define __GTK_LIST_STORE_C__
2383 #include "gtkaliasdef.c"