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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
* e-tree-model.h
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) version 3.
*
* This program 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with the program; if not, see <http://www.gnu.org/licenses/>
*
*/
#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif
#ifndef E_TREE_MODEL_H
#define E_TREE_MODEL_H
#include <glib-object.h>
/* Standard GObject macros */
#define E_TYPE_TREE_MODEL \
(e_tree_model_get_type ())
#define E_TREE_MODEL(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_TREE_MODEL, ETreeModel))
#define E_IS_TREE_MODEL(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_TREE_MODEL))
#define E_TREE_MODEL_GET_INTERFACE(obj) \
(G_TYPE_INSTANCE_GET_INTERFACE \
((obj), E_TYPE_TREE_MODEL, ETreeModelInterface))
G_BEGIN_DECLS
typedef gpointer ETreePath;
typedef struct _ETreeModel ETreeModel;
typedef struct _ETreeModelInterface ETreeModelInterface;
typedef gboolean (*ETreePathFunc) (ETreeModel *tree_model,
ETreePath path,
gpointer data);
struct _ETreeModelInterface {
GTypeInterface parent_interface;
ETreePath (*get_root) (ETreeModel *tree_model);
ETreePath (*get_parent) (ETreeModel *tree_model,
ETreePath path);
ETreePath (*get_first_child) (ETreeModel *tree_model,
ETreePath path);
ETreePath (*get_next) (ETreeModel *tree_model,
ETreePath path);
gboolean (*is_root) (ETreeModel *tree_model,
ETreePath path);
gboolean (*is_expandable) (ETreeModel *tree_model,
ETreePath path);
guint (*get_n_nodes) (ETreeModel *tree_model);
guint (*get_n_children) (ETreeModel *tree_model,
ETreePath path);
guint (*depth) (ETreeModel *tree_model,
ETreePath path);
gboolean (*get_expanded_default) (ETreeModel *tree_model);
gint (*column_count) (ETreeModel *tree_model);
gchar * (*get_save_id) (ETreeModel *tree_model,
ETreePath path);
ETreePath (*get_node_by_id) (ETreeModel *tree_model,
const gchar *save_id);
/*
* ETable analogs
*/
gpointer (*sort_value_at) (ETreeModel *tree_model,
ETreePath path,
gint col);
gpointer (*value_at) (ETreeModel *tree_model,
ETreePath path,
gint col);
gpointer (*duplicate_value) (ETreeModel *tree_model,
gint col,
gconstpointer value);
void (*free_value) (ETreeModel *tree_model,
gint col,
gpointer value);
gpointer (*initialize_value) (ETreeModel *tree_model,
gint col);
gboolean (*value_is_empty) (ETreeModel *tree_model,
gint col,
gconstpointer value);
gchar * (*value_to_string) (ETreeModel *tree_model,
gint col,
gconstpointer value);
/*
* Signals
*/
/* During node_remove, the ETreePath of the child is removed
* from the tree but is still a valid ETreePath. At
* node_deleted, the ETreePath is no longer valid.
*/
void (*pre_change) (ETreeModel *tree_model);
void (*node_changed) (ETreeModel *tree_model,
ETreePath path);
void (*node_data_changed) (ETreeModel *tree_model,
ETreePath path);
void (*node_inserted) (ETreeModel *tree_model,
ETreePath parent,
ETreePath inserted_path);
void (*node_removed) (ETreeModel *tree_model,
ETreePath parent,
ETreePath removed_path,
gint old_position);
void (*node_deleted) (ETreeModel *tree_model,
ETreePath deleted_path);
void (*rebuilt) (ETreeModel *tree_model);
};
GType e_tree_model_get_type (void) G_GNUC_CONST;
/* tree traversal operations */
ETreePath e_tree_model_get_root (ETreeModel *tree_model);
ETreePath e_tree_model_node_get_parent (ETreeModel *tree_model,
ETreePath path);
ETreePath e_tree_model_node_get_first_child
(ETreeModel *tree_model,
ETreePath path);
ETreePath e_tree_model_node_get_next (ETreeModel *tree_model,
ETreePath path);
/* node accessors */
gboolean e_tree_model_node_is_root (ETreeModel *tree_model,
ETreePath path);
gboolean e_tree_model_node_is_expandable (ETreeModel *tree_model,
ETreePath path);
guint e_tree_model_node_get_n_nodes (ETreeModel *tree_model);
guint e_tree_model_node_get_n_children
(ETreeModel *tree_model,
ETreePath path);
guint e_tree_model_node_depth (ETreeModel *tree_model,
ETreePath path);
gboolean e_tree_model_get_expanded_default
(ETreeModel *tree_model);
gint e_tree_model_column_count (ETreeModel *tree_model);
gchar * e_tree_model_get_save_id (ETreeModel *tree_model,
ETreePath path);
ETreePath e_tree_model_get_node_by_id (ETreeModel *tree_model,
const gchar *save_id);
gpointer e_tree_model_sort_value_at (ETreeModel *tree_model,
ETreePath path,
gint col);
gpointer e_tree_model_value_at (ETreeModel *tree_model,
ETreePath path,
gint col);
gpointer e_tree_model_duplicate_value (ETreeModel *tree_model,
gint col,
gconstpointer value);
void e_tree_model_free_value (ETreeModel *tree_model,
gint col,
gpointer value);
gpointer e_tree_model_initialize_value (ETreeModel *tree_model,
gint col);
gboolean e_tree_model_value_is_empty (ETreeModel *tree_model,
gint col,
gconstpointer value);
gchar * e_tree_model_value_to_string (ETreeModel *tree_model,
gint col,
gconstpointer value);
/* depth first traversal of path's descendents, calling func on each one */
void e_tree_model_node_traverse (ETreeModel *tree_model,
ETreePath path,
ETreePathFunc func,
gpointer data);
ETreePath e_tree_model_node_find (ETreeModel *tree_model,
ETreePath path,
ETreePath end_path,
ETreePathFunc func,
gpointer data);
/*
** Routines for emitting signals on the ETreeModel
*/
void e_tree_model_pre_change (ETreeModel *tree_model);
void e_tree_model_rebuilt (ETreeModel *tree_model);
void e_tree_model_node_changed (ETreeModel *tree_model,
ETreePath path);
void e_tree_model_node_data_changed (ETreeModel *tree_model,
ETreePath path);
void e_tree_model_node_inserted (ETreeModel *tree_model,
ETreePath parent_path,
ETreePath inserted_path);
void e_tree_model_node_removed (ETreeModel *tree_model,
ETreePath parent_path,
ETreePath removed_path,
gint old_position);
void e_tree_model_node_deleted (ETreeModel *tree_model,
ETreePath deleted_path);
G_END_DECLS
#endif /* E_TREE_MODEL_H */
|
