2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
18 #ifndef __GTK_TREE_MODEL_H__
19 #define __GTK_TREE_MODEL_H__
21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22 #error "Only <gtk/gtk.h> can be included directly."
25 #include <glib-object.h>
29 #define GTK_TYPE_TREE_MODEL (gtk_tree_model_get_type ())
30 #define GTK_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
31 #define GTK_IS_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
32 #define GTK_TREE_MODEL_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelIface))
34 #define GTK_TYPE_TREE_ITER (gtk_tree_iter_get_type ())
35 #define GTK_TYPE_TREE_PATH (gtk_tree_path_get_type ())
36 #define GTK_TYPE_TREE_ROW_REFERENCE (gtk_tree_row_reference_get_type ())
38 typedef struct _GtkTreeIter GtkTreeIter;
39 typedef struct _GtkTreePath GtkTreePath;
40 typedef struct _GtkTreeRowReference GtkTreeRowReference;
41 typedef struct _GtkTreeModel GtkTreeModel; /* Dummy typedef */
42 typedef struct _GtkTreeModelIface GtkTreeModelIface;
45 * GtkTreeModelForeachFunc:
46 * @model: the #GtkTreeModel being iterated
47 * @path: the current #GtkTreePath
48 * @iter: the current #GtkTreeIter
49 * @data: The user data passed to gtk_tree_model_foreach()
51 * Type of the callback passed to gtk_tree_model_foreach() to
52 * iterate over the rows in a tree model.
54 * Return value: %TRUE to stop iterating, %FALSE to continue
57 typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
61 * @GTK_TREE_MODEL_ITERS_PERSIST: iterators survive all signals
63 * @GTK_TREE_MODEL_LIST_ONLY: the model is a list only, and never
66 * These flags indicate various properties of a #GtkTreeModel.
68 * They are returned by gtk_tree_model_get_flags(), and must be
69 * static for the lifetime of the object. A more complete description
70 * of #GTK_TREE_MODEL_ITERS_PERSIST can be found in the overview of
75 GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
76 GTK_TREE_MODEL_LIST_ONLY = 1 << 1
81 * @stamp: a unique stamp to catch invalid iterators
82 * @user_data: model-specific data
83 * @user_data2: model-specific data
84 * @user_data3: model-specific data
86 * The <structname>GtkTreeIter</structname> is the primary structure
87 * for accessing a #GtkTreeModel. Models are expected to put a unique
88 * integer in the <structfield>stamp</structfield> member, and put
89 * model-specific data in the three <structfield>user_data</structfield>
100 struct _GtkTreeModelIface
102 GTypeInterface g_iface;
105 void (* row_changed) (GtkTreeModel *tree_model,
108 void (* row_inserted) (GtkTreeModel *tree_model,
111 void (* row_has_child_toggled) (GtkTreeModel *tree_model,
114 void (* row_deleted) (GtkTreeModel *tree_model,
116 void (* rows_reordered) (GtkTreeModel *tree_model,
122 GtkTreeModelFlags (* get_flags) (GtkTreeModel *tree_model);
124 gint (* get_n_columns) (GtkTreeModel *tree_model);
125 GType (* get_column_type) (GtkTreeModel *tree_model,
127 gboolean (* get_iter) (GtkTreeModel *tree_model,
130 GtkTreePath *(* get_path) (GtkTreeModel *tree_model,
132 void (* get_value) (GtkTreeModel *tree_model,
136 gboolean (* iter_next) (GtkTreeModel *tree_model,
138 gboolean (* iter_previous) (GtkTreeModel *tree_model,
140 gboolean (* iter_children) (GtkTreeModel *tree_model,
142 GtkTreeIter *parent);
143 gboolean (* iter_has_child) (GtkTreeModel *tree_model,
145 gint (* iter_n_children) (GtkTreeModel *tree_model,
147 gboolean (* iter_nth_child) (GtkTreeModel *tree_model,
151 gboolean (* iter_parent) (GtkTreeModel *tree_model,
154 void (* ref_node) (GtkTreeModel *tree_model,
156 void (* unref_node) (GtkTreeModel *tree_model,
161 /* GtkTreePath operations */
162 GtkTreePath *gtk_tree_path_new (void);
163 GtkTreePath *gtk_tree_path_new_from_string (const gchar *path);
164 GtkTreePath *gtk_tree_path_new_from_indices (gint first_index,
166 gchar *gtk_tree_path_to_string (GtkTreePath *path);
167 GtkTreePath *gtk_tree_path_new_first (void);
168 void gtk_tree_path_append_index (GtkTreePath *path,
170 void gtk_tree_path_prepend_index (GtkTreePath *path,
172 gint gtk_tree_path_get_depth (GtkTreePath *path);
173 gint *gtk_tree_path_get_indices (GtkTreePath *path);
175 gint *gtk_tree_path_get_indices_with_depth (GtkTreePath *path,
178 void gtk_tree_path_free (GtkTreePath *path);
179 GtkTreePath *gtk_tree_path_copy (const GtkTreePath *path);
180 GType gtk_tree_path_get_type (void) G_GNUC_CONST;
181 gint gtk_tree_path_compare (const GtkTreePath *a,
182 const GtkTreePath *b);
183 void gtk_tree_path_next (GtkTreePath *path);
184 gboolean gtk_tree_path_prev (GtkTreePath *path);
185 gboolean gtk_tree_path_up (GtkTreePath *path);
186 void gtk_tree_path_down (GtkTreePath *path);
188 gboolean gtk_tree_path_is_ancestor (GtkTreePath *path,
189 GtkTreePath *descendant);
190 gboolean gtk_tree_path_is_descendant (GtkTreePath *path,
191 GtkTreePath *ancestor);
194 * GtkTreeRowReference:
196 * A GtkTreeRowReference tracks model changes so that it always refers to the
197 * same row (a #GtkTreePath refers to a position, not a fixed row). Create a
198 * new GtkTreeRowReference with gtk_tree_row_reference_new().
201 GType gtk_tree_row_reference_get_type (void) G_GNUC_CONST;
202 GtkTreeRowReference *gtk_tree_row_reference_new (GtkTreeModel *model,
204 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject *proxy,
207 GtkTreePath *gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);
208 GtkTreeModel *gtk_tree_row_reference_get_model (GtkTreeRowReference *reference);
209 gboolean gtk_tree_row_reference_valid (GtkTreeRowReference *reference);
210 GtkTreeRowReference *gtk_tree_row_reference_copy (GtkTreeRowReference *reference);
211 void gtk_tree_row_reference_free (GtkTreeRowReference *reference);
212 /* These two functions are only needed if you created the row reference with a
214 void gtk_tree_row_reference_inserted (GObject *proxy,
216 void gtk_tree_row_reference_deleted (GObject *proxy,
218 void gtk_tree_row_reference_reordered (GObject *proxy,
223 /* GtkTreeIter operations */
224 GtkTreeIter * gtk_tree_iter_copy (GtkTreeIter *iter);
225 void gtk_tree_iter_free (GtkTreeIter *iter);
226 GType gtk_tree_iter_get_type (void) G_GNUC_CONST;
228 GType gtk_tree_model_get_type (void) G_GNUC_CONST;
229 GtkTreeModelFlags gtk_tree_model_get_flags (GtkTreeModel *tree_model);
230 gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);
231 GType gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
235 /* Iterator movement */
236 gboolean gtk_tree_model_get_iter (GtkTreeModel *tree_model,
239 gboolean gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
241 const gchar *path_string);
242 gchar * gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
244 gboolean gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
246 GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model,
248 void gtk_tree_model_get_value (GtkTreeModel *tree_model,
252 gboolean gtk_tree_model_iter_previous (GtkTreeModel *tree_model,
254 gboolean gtk_tree_model_iter_next (GtkTreeModel *tree_model,
256 gboolean gtk_tree_model_iter_children (GtkTreeModel *tree_model,
258 GtkTreeIter *parent);
259 gboolean gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
261 gint gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
263 gboolean gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
267 gboolean gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
270 void gtk_tree_model_ref_node (GtkTreeModel *tree_model,
272 void gtk_tree_model_unref_node (GtkTreeModel *tree_model,
274 void gtk_tree_model_get (GtkTreeModel *tree_model,
277 void gtk_tree_model_get_valist (GtkTreeModel *tree_model,
282 void gtk_tree_model_foreach (GtkTreeModel *model,
283 GtkTreeModelForeachFunc func,
287 void gtk_tree_model_row_changed (GtkTreeModel *tree_model,
290 void gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
293 void gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
296 void gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
298 void gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
305 #endif /* __GTK_TREE_MODEL_H__ */