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 #endif /* __cplusplus */
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) ((GtkTreeModelIface *)g_type_interface_peek (((GTypeInstance *)GTK_TREE_MODEL (obj))->g_class, GTK_TYPE_TREE_MODEL))
34 typedef struct _GtkTreeIter GtkTreeIter;
35 typedef struct _GtkTreePath GtkTreePath;
36 typedef struct _GtkTreeRowReference GtkTreeRowReference;
37 typedef struct _GtkTreeModel GtkTreeModel; /* Dummy typedef */
38 typedef struct _GtkTreeModelIface GtkTreeModelIface;
39 typedef gboolean (* GtkTreeModelForeachFunc) (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter, gpointer data);
44 GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0,
45 GTK_TREE_MODEL_LIST_ONLY = 1 << 1,
56 struct _GtkTreeModelIface
58 GTypeInterface g_iface;
61 void (* row_changed) (GtkTreeModel *tree_model,
64 void (* row_inserted) (GtkTreeModel *tree_model,
67 void (* row_has_child_toggled) (GtkTreeModel *tree_model,
70 void (* row_deleted) (GtkTreeModel *tree_model,
72 void (* rows_reordered) (GtkTreeModel *tree_model,
78 GtkTreeModelFlags (* get_flags) (GtkTreeModel *tree_model);
80 gint (* get_n_columns) (GtkTreeModel *tree_model);
81 GType (* get_column_type) (GtkTreeModel *tree_model,
83 gboolean (* get_iter) (GtkTreeModel *tree_model,
86 GtkTreePath *(* get_path) (GtkTreeModel *tree_model,
88 void (* get_value) (GtkTreeModel *tree_model,
92 gboolean (* iter_next) (GtkTreeModel *tree_model,
94 gboolean (* iter_children) (GtkTreeModel *tree_model,
97 gboolean (* iter_has_child) (GtkTreeModel *tree_model,
99 gint (* iter_n_children) (GtkTreeModel *tree_model,
101 gboolean (* iter_nth_child) (GtkTreeModel *tree_model,
105 gboolean (* iter_parent) (GtkTreeModel *tree_model,
108 void (* ref_node) (GtkTreeModel *tree_model,
110 void (* unref_node) (GtkTreeModel *tree_model,
115 /* GtkTreePath operations */
116 GtkTreePath *gtk_tree_path_new (void);
117 GtkTreePath *gtk_tree_path_new_from_string (const gchar *path);
118 gchar *gtk_tree_path_to_string (GtkTreePath *path);
119 GtkTreePath *gtk_tree_path_new_root (void);
120 void gtk_tree_path_append_index (GtkTreePath *path,
122 void gtk_tree_path_prepend_index (GtkTreePath *path,
124 gint gtk_tree_path_get_depth (GtkTreePath *path);
125 gint *gtk_tree_path_get_indices (GtkTreePath *path);
126 void gtk_tree_path_free (GtkTreePath *path);
127 GtkTreePath *gtk_tree_path_copy (GtkTreePath *path);
128 gint gtk_tree_path_compare (const GtkTreePath *a,
129 const GtkTreePath *b);
130 void gtk_tree_path_next (GtkTreePath *path);
131 gboolean gtk_tree_path_prev (GtkTreePath *path);
132 gboolean gtk_tree_path_up (GtkTreePath *path);
133 void gtk_tree_path_down (GtkTreePath *path);
135 gboolean gtk_tree_path_is_ancestor (GtkTreePath *path,
136 GtkTreePath *descendant);
137 gboolean gtk_tree_path_is_descendant (GtkTreePath *path,
138 GtkTreePath *ancestor);
140 /* Row reference (an object that tracks model changes so it refers to the same
141 * row always; a path refers to a position, not a fixed row). You almost always
142 * want to call gtk_tree_row_reference_new.
145 GtkTreeRowReference *gtk_tree_row_reference_new (GtkTreeModel *model,
147 GtkTreeRowReference *gtk_tree_row_reference_new_proxy (GObject *proxy,
150 GtkTreePath *gtk_tree_row_reference_get_path (GtkTreeRowReference *reference);
151 gboolean gtk_tree_row_reference_valid (GtkTreeRowReference *reference);
152 void gtk_tree_row_reference_free (GtkTreeRowReference *reference);
153 /* These two functions are only needed if you created the row reference with a
155 void gtk_tree_row_reference_inserted (GObject *proxy,
157 void gtk_tree_row_reference_deleted (GObject *proxy,
159 void gtk_tree_row_reference_reordered (GObject *proxy,
164 /* GtkTreeIter operations */
165 GtkTreeIter * gtk_tree_iter_copy (GtkTreeIter *iter);
166 void gtk_tree_iter_free (GtkTreeIter *iter);
168 GtkType gtk_tree_model_get_type (void) G_GNUC_CONST;
169 GtkTreeModelFlags gtk_tree_model_get_flags (GtkTreeModel *tree_model);
170 gint gtk_tree_model_get_n_columns (GtkTreeModel *tree_model);
171 GType gtk_tree_model_get_column_type (GtkTreeModel *tree_model,
175 /* Iterator movement */
176 gboolean gtk_tree_model_get_iter (GtkTreeModel *tree_model,
179 gboolean gtk_tree_model_get_iter_root (GtkTreeModel *tree_model,
181 GtkTreePath * gtk_tree_model_get_path (GtkTreeModel *tree_model,
183 void gtk_tree_model_get_value (GtkTreeModel *tree_model,
187 gboolean gtk_tree_model_iter_next (GtkTreeModel *tree_model,
189 gboolean gtk_tree_model_iter_children (GtkTreeModel *tree_model,
191 GtkTreeIter *parent);
192 gboolean gtk_tree_model_iter_has_child (GtkTreeModel *tree_model,
194 gint gtk_tree_model_iter_n_children (GtkTreeModel *tree_model,
196 gboolean gtk_tree_model_iter_nth_child (GtkTreeModel *tree_model,
200 gboolean gtk_tree_model_iter_parent (GtkTreeModel *tree_model,
203 void gtk_tree_model_ref_node (GtkTreeModel *tree_model,
205 void gtk_tree_model_unref_node (GtkTreeModel *tree_model,
207 void gtk_tree_model_get (GtkTreeModel *tree_model,
210 void gtk_tree_model_get_valist (GtkTreeModel *tree_model,
215 void gtk_tree_model_foreach (GtkTreeModel *model,
216 GtkTreeModelForeachFunc func,
221 void gtk_tree_model_row_changed (GtkTreeModel *tree_model,
224 void gtk_tree_model_row_inserted (GtkTreeModel *tree_model,
227 void gtk_tree_model_row_has_child_toggled (GtkTreeModel *tree_model,
230 void gtk_tree_model_row_deleted (GtkTreeModel *tree_model,
232 void gtk_tree_model_rows_reordered (GtkTreeModel *tree_model,
242 #endif /* __cplusplus */
245 #endif /* __GTK_TREE_MODEL_H__ */