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 #ifndef __GTK_TREE_MODEL_H__
21 #define __GTK_TREE_MODEL_H__
23 #include <gtk/gtkobject.h>
27 #define GTK_TYPE_TREE_MODEL (gtk_tree_model_get_type ())
28 #define GTK_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
29 #define GTK_IS_TREE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
30 #define GTK_TREE_MODEL_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelIface))
32 typedef struct _GtkTreeIter GtkTreeIter;
33 typedef struct _GtkTreePath GtkTreePath;
34 typedef struct _GtkTreeRowReference GtkTreeRowReference;
35 typedef struct _GtkTreeModel GtkTreeModel; /* Dummy typedef */
36 typedef struct _GtkTreeModelIface GtkTreeModelIface;
37 typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
42 GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
43 GTK_TREE_MODEL_LIST_ONLY = 1 << 1
54 struct _GtkTreeModelIface
56 GTypeInterface g_iface;
59 void (* row_changed) (GtkTreeModel *tree_model,
62 void (* row_inserted) (GtkTreeModel *tree_model,
65 void (* row_has_child_toggled) (GtkTreeModel *tree_model,
68 void (* row_deleted) (GtkTreeModel *tree_model,
70 void (* rows_reordered) (GtkTreeModel *tree_model,
76 GtkTreeModelFlags (* get_flags) (GtkTreeModel *tree_model);
78 gint (* get_n_columns) (GtkTreeModel *tree_model);
79 GType (* get_column_type) (GtkTreeModel *tree_model,
81 gboolean (* get_iter) (GtkTreeModel *tree_model,
84 GtkTreePath *(* get_path) (GtkTreeModel *tree_model,
86 void (* get_value) (GtkTreeModel *tree_model,
90 gboolean (* iter_next) (GtkTreeModel *tree_model,
92 gboolean (* iter_children) (GtkTreeModel *tree_model,
95 gboolean (* iter_has_child) (GtkTreeModel *tree_model,
97 gint (* iter_n_children) (GtkTreeModel *tree_model,
99 gboolean (* iter_nth_child) (GtkTreeModel *tree_model,
103 gboolean (* iter_parent) (GtkTreeModel *tree_model,
106 void (* ref_node) (GtkTreeModel *tree_model,
108 void (* unref_node) (GtkTreeModel *tree_model,
113 /* GtkTreePath operations */
114 GtkTreePath *gtk_tree_path_new (void);
115 GtkTreePath *gtk_tree_path_new_from_string (const gchar *path);
116 gchar *gtk_tree_path_to_string (GtkTreePath *path);
117 #define gtk_tree_path_new_root gtk_tree_path_new_first
118 GtkTreePath *gtk_tree_path_new_first (void);
119 void gtk_tree_path_append_index (GtkTreePath *path,
121 void gtk_tree_path_prepend_index (GtkTreePath *path,
123 gint gtk_tree_path_get_depth (GtkTreePath *path);
124 gint *gtk_tree_path_get_indices (GtkTreePath *path);
125 void gtk_tree_path_free (GtkTreePath *path);
126 GtkTreePath *gtk_tree_path_copy (GtkTreePath *path);
127 gint gtk_tree_path_compare (const GtkTreePath *a,
128 const GtkTreePath *b);
129 void gtk_tree_path_next (GtkTreePath *path);
130 gboolean gtk_tree_path_prev (GtkTreePath *path);
131 gboolean gtk_tree_path_up (GtkTreePath *path);
132 void gtk_tree_path_down (GtkTreePath *path);
134 gboolean gtk_tree_path_is_ancestor (GtkTreePath *path,
135 GtkTreePath *descendant);
136 gboolean gtk_tree_path_is_descendant (GtkTreePath *path,
137 GtkTreePath *ancestor);
139 /* Row reference (an object that tracks model changes so it refers to the same
140 * row always; a path refers to a position, not a fixed row). You almost always
141 * want to call gtk_tree_row_reference_new.
144 GtkTreeRowReference *gtk_tree_row_reference_new (GtkTreeModel *model,
146 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject *proxy,
149 GtkTreePath *gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);
150 gboolean gtk_tree_row_reference_valid (GtkTreeRowReference *reference);
151 void gtk_tree_row_reference_free (GtkTreeRowReference *reference);
152 /* These two functions are only needed if you created the row reference with a
154 void gtk_tree_row_reference_inserted (GObject *proxy,
156 void gtk_tree_row_reference_deleted (GObject *proxy,
158 void gtk_tree_row_reference_reordered (GObject *proxy,
163 /* GtkTreeIter operations */
164 GtkTreeIter * gtk_tree_iter_copy (GtkTreeIter *iter);
165 void gtk_tree_iter_free (GtkTreeIter *iter);
167 GtkType gtk_tree_model_get_type (void) G_GNUC_CONST;
168 GtkTreeModelFlags gtk_tree_model_get_flags (GtkTreeModel *tree_model);
169 gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);
170 GType gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
174 /* Iterator movement */
175 gboolean gtk_tree_model_get_iter (GtkTreeModel *tree_model,
178 gboolean gtk_tree_model_get_iter_from_string (GtkTreeModel *tree_model,
180 const gchar *path_string);
181 #define gtk_tree_model_get_iter_root(tree_model, iter) gtk_tree_model_get_iter_first(tree_model, iter)
182 gboolean gtk_tree_model_get_iter_first (GtkTreeModel *tree_model,
184 GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model,
186 void gtk_tree_model_get_value (GtkTreeModel *tree_model,
190 gboolean gtk_tree_model_iter_next (GtkTreeModel *tree_model,
192 gboolean gtk_tree_model_iter_children (GtkTreeModel *tree_model,
194 GtkTreeIter *parent);
195 gboolean gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
197 gint gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
199 gboolean gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
203 gboolean gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
206 void gtk_tree_model_ref_node (GtkTreeModel *tree_model,
208 void gtk_tree_model_unref_node (GtkTreeModel *tree_model,
210 void gtk_tree_model_get (GtkTreeModel *tree_model,
213 void gtk_tree_model_get_valist (GtkTreeModel *tree_model,
218 void gtk_tree_model_foreach (GtkTreeModel *model,
219 GtkTreeModelForeachFunc func,
224 void gtk_tree_model_row_changed (GtkTreeModel *tree_model,
227 void gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
230 void gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
233 void gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
235 void gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
245 #endif /* __GTK_TREE_MODEL_H__ */