2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_TREE_MODEL_H__
25 #define __GTK_TREE_MODEL_H__
27 #include <glib-object.h>
29 /* Not needed, retained for compatibility -Yosh */
30 #include <gtk/gtkobject.h>
34 #define GTK_TYPE_TREE_MODEL (gtk_tree_model_get_type ())
35 #define GTK_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
36 #define GTK_IS_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
37 #define GTK_TREE_MODEL_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelIface))
39 #define GTK_TYPE_TREE_ITER (gtk_tree_iter_get_type ())
40 #define GTK_TYPE_TREE_PATH (gtk_tree_path_get_type ())
41 #define GTK_TYPE_TREE_ROW_REFERENCE (gtk_tree_row_reference_get_type ())
43 typedef struct _GtkTreeIter GtkTreeIter;
44 typedef struct _GtkTreePath GtkTreePath;
45 typedef struct _GtkTreeRowReference GtkTreeRowReference;
46 typedef struct _GtkTreeModel GtkTreeModel; /* Dummy typedef */
47 typedef struct _GtkTreeModelIface GtkTreeModelIface;
48 typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
53 GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
54 GTK_TREE_MODEL_LIST_ONLY = 1 << 1
65 struct _GtkTreeModelIface
67 GTypeInterface g_iface;
70 void (* row_changed) (GtkTreeModel *tree_model,
73 void (* row_inserted) (GtkTreeModel *tree_model,
76 void (* row_has_child_toggled) (GtkTreeModel *tree_model,
79 void (* row_deleted) (GtkTreeModel *tree_model,
81 void (* rows_reordered) (GtkTreeModel *tree_model,
87 GtkTreeModelFlags (* get_flags) (GtkTreeModel *tree_model);
89 gint (* get_n_columns) (GtkTreeModel *tree_model);
90 GType (* get_column_type) (GtkTreeModel *tree_model,
92 gboolean (* get_iter) (GtkTreeModel *tree_model,
95 GtkTreePath *(* get_path) (GtkTreeModel *tree_model,
97 void (* get_value) (GtkTreeModel *tree_model,
101 gboolean (* iter_next) (GtkTreeModel *tree_model,
103 gboolean (* iter_children) (GtkTreeModel *tree_model,
105 GtkTreeIter *parent);
106 gboolean (* iter_has_child) (GtkTreeModel *tree_model,
108 gint (* iter_n_children) (GtkTreeModel *tree_model,
110 gboolean (* iter_nth_child) (GtkTreeModel *tree_model,
114 gboolean (* iter_parent) (GtkTreeModel *tree_model,
117 void (* ref_node) (GtkTreeModel *tree_model,
119 void (* unref_node) (GtkTreeModel *tree_model,
124 /* GtkTreePath operations */
125 GtkTreePath *gtk_tree_path_new (void);
126 GtkTreePath *gtk_tree_path_new_from_string (const gchar *path);
127 GtkTreePath *gtk_tree_path_new_from_indices (gint first_index,
129 gchar *gtk_tree_path_to_string (GtkTreePath *path);
130 GtkTreePath *gtk_tree_path_new_first (void);
131 void gtk_tree_path_append_index (GtkTreePath *path,
133 void gtk_tree_path_prepend_index (GtkTreePath *path,
135 gint gtk_tree_path_get_depth (GtkTreePath *path);
136 gint *gtk_tree_path_get_indices (GtkTreePath *path);
137 void gtk_tree_path_free (GtkTreePath *path);
138 GtkTreePath *gtk_tree_path_copy (const GtkTreePath *path);
139 GType gtk_tree_path_get_type (void) G_GNUC_CONST;
140 gint gtk_tree_path_compare (const GtkTreePath *a,
141 const GtkTreePath *b);
142 void gtk_tree_path_next (GtkTreePath *path);
143 gboolean gtk_tree_path_prev (GtkTreePath *path);
144 gboolean gtk_tree_path_up (GtkTreePath *path);
145 void gtk_tree_path_down (GtkTreePath *path);
147 gboolean gtk_tree_path_is_ancestor (GtkTreePath *path,
148 GtkTreePath *descendant);
149 gboolean gtk_tree_path_is_descendant (GtkTreePath *path,
150 GtkTreePath *ancestor);
152 #ifndef GTK_DISABLE_DEPRECATED
153 #define gtk_tree_path_new_root() gtk_tree_path_new_first()
154 #endif /* !GTK_DISABLE_DEPRECATED */
156 /* Row reference (an object that tracks model changes so it refers to the same
157 * row always; a path refers to a position, not a fixed row). You almost always
158 * want to call gtk_tree_row_reference_new.
161 GType gtk_tree_row_reference_get_type (void) G_GNUC_CONST;
162 GtkTreeRowReference *gtk_tree_row_reference_new (GtkTreeModel *model,
164 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject *proxy,
167 GtkTreePath *gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);
168 GtkTreeModel *gtk_tree_row_reference_get_model (GtkTreeRowReference *reference);
169 gboolean gtk_tree_row_reference_valid (GtkTreeRowReference *reference);
170 GtkTreeRowReference *gtk_tree_row_reference_copy (GtkTreeRowReference *reference);
171 void gtk_tree_row_reference_free (GtkTreeRowReference *reference);
172 /* These two functions are only needed if you created the row reference with a
174 void gtk_tree_row_reference_inserted (GObject *proxy,
176 void gtk_tree_row_reference_deleted (GObject *proxy,
178 void gtk_tree_row_reference_reordered (GObject *proxy,
183 /* GtkTreeIter operations */
184 GtkTreeIter * gtk_tree_iter_copy (GtkTreeIter *iter);
185 void gtk_tree_iter_free (GtkTreeIter *iter);
186 GType gtk_tree_iter_get_type (void) G_GNUC_CONST;
188 GType gtk_tree_model_get_type (void) G_GNUC_CONST;
189 GtkTreeModelFlags gtk_tree_model_get_flags (GtkTreeModel *tree_model);
190 gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);
191 GType gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
195 /* Iterator movement */
196 gboolean gtk_tree_model_get_iter (GtkTreeModel *tree_model,
199 gboolean gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
201 const gchar *path_string);
202 gchar * gtk_tree_model_get_string_from_iter (GtkTreeModel *tree_model,
204 gboolean gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
206 GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model,
208 void gtk_tree_model_get_value (GtkTreeModel *tree_model,
212 gboolean gtk_tree_model_iter_next (GtkTreeModel *tree_model,
214 gboolean gtk_tree_model_iter_children (GtkTreeModel *tree_model,
216 GtkTreeIter *parent);
217 gboolean gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
219 gint gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
221 gboolean gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
225 gboolean gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
228 void gtk_tree_model_ref_node (GtkTreeModel *tree_model,
230 void gtk_tree_model_unref_node (GtkTreeModel *tree_model,
232 void gtk_tree_model_get (GtkTreeModel *tree_model,
235 void gtk_tree_model_get_valist (GtkTreeModel *tree_model,
240 void gtk_tree_model_foreach (GtkTreeModel *model,
241 GtkTreeModelForeachFunc func,
245 #ifndef GTK_DISABLE_DEPRECATED
246 #define gtk_tree_model_get_iter_root(tree_model, iter) gtk_tree_model_get_iter_first(tree_model, iter)
247 #endif /* !GTK_DISABLE_DEPRECATED */
250 void gtk_tree_model_row_changed (GtkTreeModel *tree_model,
253 void gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
256 void gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
259 void gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
261 void gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
268 #endif /* __GTK_TREE_MODEL_H__ */