summaryrefslogtreecommitdiff
path: root/gtk/gtktreemodel.h
blob: 74fd34da7e863853279dca0c2db0533f746d01ae (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/* gtktreemodel.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GTK_TREE_MODEL_H__
#define __GTK_TREE_MODEL_H__

#include <gtk/gtkobject.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define GTK_TYPE_TREE_MODEL            (gtk_tree_model_get_type ())
#define GTK_TREE_MODEL(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
#define GTK_IS_TREE_MODEL(obj)	       (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_MODEL))
#define GTK_TREE_MODEL_GET_IFACE(obj)  ((GtkTreeModelIface *)g_type_interface_peek (((GTypeInstance *)GTK_TREE_MODEL (obj))->g_class, GTK_TYPE_TREE_MODEL))
					

typedef struct _GtkTreeIter       GtkTreeIter;
typedef struct _GtkTreePath       GtkTreePath;
typedef struct _GtkTreeModel      GtkTreeModel; /* Dummy typedef */
typedef struct _GtkTreeModelIface GtkTreeModelIface;


typedef enum
{
  GTK_TREE_MODEL_ITERS_PERSIST = 1 << 0
} GtkTreeModelFlags;

struct _GtkTreeIter
{
  gint stamp;
  gpointer user_data;
  gpointer user_data2;
  gpointer user_data3;
};

struct _GtkTreeModelIface
{
  GTypeInterface g_iface;

  /* Signals */
  /* Currently unimplemented as interfaces do not support signals yet, so
   * objects implementing this interface need this.  Later, it will be moved
   * back here.
   */
  void         (* changed)           (GtkTreeModel *tree_model,
				      GtkTreePath  *path,
				      GtkTreeIter  *iter);
  void         (* inserted)          (GtkTreeModel *tree_model,
				      GtkTreePath  *path,
				      GtkTreeIter  *iter);
  void         (* child_toggled)     (GtkTreeModel *tree_model,
				      GtkTreePath  *path,
				      GtkTreeIter  *iter);
  void         (* deleted)           (GtkTreeModel *tree_model,
				      GtkTreePath  *path);
  void         (* reordered)         (GtkTreeModel *tree_model,
				      GtkTreePath  *path,
				      gint         *new_order);

  /* VTable - not signals */
  GtkTreeModelFlags (* get_flags)  (GtkTreeModel *tree_model);   

  gint         (* get_n_columns)   (GtkTreeModel *tree_model);
  GType        (* get_column_type) (GtkTreeModel *tree_model,
				    gint          index);
  gboolean     (* get_iter)        (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreePath  *path);
  GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  void         (* get_value)       (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    gint          column,
				    GValue       *value);
  gboolean     (* iter_next)       (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  gboolean     (* iter_children)   (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreeIter  *parent);
  gboolean     (* iter_has_child)  (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  gint         (* iter_n_children) (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  gboolean     (* iter_nth_child)  (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreeIter  *parent,
				    gint          n);
  gboolean     (* iter_parent)     (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter,
				    GtkTreeIter  *child);
  void         (* ref_iter)        (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
  void         (* unref_iter)      (GtkTreeModel *tree_model,
				    GtkTreeIter  *iter);
};


/* GtkTreePath operations */
GtkTreePath *gtk_tree_path_new              (void);
GtkTreePath *gtk_tree_path_new_from_string  (gchar             *path);
gchar       *gtk_tree_path_to_string        (GtkTreePath       *path);
GtkTreePath *gtk_tree_path_new_root         (void);
void         gtk_tree_path_append_index     (GtkTreePath       *path,
					     gint               index);
void         gtk_tree_path_prepend_index    (GtkTreePath       *path,
					     gint               index);
gint         gtk_tree_path_get_depth        (GtkTreePath       *path);
gint        *gtk_tree_path_get_indices      (GtkTreePath       *path);
void         gtk_tree_path_free             (GtkTreePath       *path);
GtkTreePath *gtk_tree_path_copy             (GtkTreePath       *path);
gint         gtk_tree_path_compare          (const GtkTreePath *a,
					     const GtkTreePath *b);
void         gtk_tree_path_next             (GtkTreePath       *path);
gboolean     gtk_tree_path_prev             (GtkTreePath       *path);
gboolean     gtk_tree_path_up               (GtkTreePath       *path);
void         gtk_tree_path_down             (GtkTreePath       *path);


/* GtkTreeIter operations */
GtkTreeIter *gtk_tree_iter_copy             (GtkTreeIter       *iter);
void         gtk_tree_iter_free             (GtkTreeIter       *iter);

/* GtkTreeModel stuff */
GtkType           gtk_tree_model_get_type   (void) G_GNUC_CONST;
GtkTreeModelFlags gtk_tree_model_get_flags  (GtkTreeModel      *tree_model);

/* Column information */
gint         gtk_tree_model_get_n_columns   (GtkTreeModel      *tree_model);
GType        gtk_tree_model_get_column_type (GtkTreeModel      *tree_model,
					     gint               index);


/* Iterator movement */
gboolean     gtk_tree_model_get_iter        (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter,
					     GtkTreePath       *path);
gboolean     gtk_tree_model_get_first       (GtkTreeModel      *tree_model,
                                             GtkTreeIter       *iter);
GtkTreePath *gtk_tree_model_get_path        (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter);
void         gtk_tree_model_get_value       (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter,
					     gint               column,
					     GValue            *value);
gboolean     gtk_tree_model_iter_next       (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter);
gboolean     gtk_tree_model_iter_children   (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter,
					     GtkTreeIter       *parent);
gboolean     gtk_tree_model_iter_has_child  (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter);
gint         gtk_tree_model_iter_n_children (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter);
gboolean     gtk_tree_model_iter_nth_child  (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter,
					     GtkTreeIter       *parent,
					     gint               n);
gboolean     gtk_tree_model_iter_parent     (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter,
					     GtkTreeIter       *child);
void         gtk_tree_model_ref_iter        (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter);
void         gtk_tree_model_unref_iter      (GtkTreeModel      *tree_model,
					     GtkTreeIter       *iter);

#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_TREE_MODEL_H__ */