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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
/*
* 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/>
*
*
* Authors:
* Chris Lahey <clahey@ximian.com>
*
* Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
*
*/
#if !defined (__E_UTIL_H_INSIDE__) && !defined (LIBEUTIL_COMPILATION)
#error "Only <e-util/e-util.h> should be included directly."
#endif
#ifndef _E_TREE_H_
#define _E_TREE_H_
#include <gtk/gtk.h>
#include <libxml/tree.h>
#include <libgnomecanvas/libgnomecanvas.h>
#include <e-util/e-printable.h>
#include <e-util/e-table-extras.h>
#include <e-util/e-table-item.h>
#include <e-util/e-table-specification.h>
#include <e-util/e-table-state.h>
#include <e-util/e-tree-model.h>
#include <e-util/e-tree-table-adapter.h>
#define E_TREE_USE_TREE_SELECTION
#ifdef E_TREE_USE_TREE_SELECTION
#include <e-util/e-tree-selection-model.h>
#endif
/* Standard GObject macros */
#define E_TYPE_TREE \
(e_tree_get_type ())
#define E_TREE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST \
((obj), E_TYPE_TREE, ETree))
#define E_TREE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_CAST \
((cls), E_TYPE_TREE, ETreeClass))
#define E_IS_TREE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE \
((obj), E_TYPE_TREE))
#define E_IS_TREE_CLASS(cls) \
(G_TYPE_CHECK_CLASS_TYPE \
((cls), E_TYPE_TREE))
#define E_TREE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS \
((obj), E_TYPE_TREE))
G_BEGIN_DECLS
typedef struct _ETreeDragSourceSite ETreeDragSourceSite;
typedef struct _ETree ETree;
typedef struct _ETreeClass ETreeClass;
typedef struct _ETreePrivate ETreePrivate;
struct _ETree {
GtkTable parent;
ETreePrivate *priv;
};
struct _ETreeClass {
GtkTableClass parent_class;
void (*cursor_change) (ETree *et,
gint row,
ETreePath path);
void (*cursor_activated) (ETree *et,
gint row,
ETreePath path);
void (*selection_change) (ETree *et);
void (*double_click) (ETree *et,
gint row,
ETreePath path,
gint col,
GdkEvent *event);
gboolean (*right_click) (ETree *et,
gint row,
ETreePath path,
gint col,
GdkEvent *event);
gboolean (*click) (ETree *et,
gint row,
ETreePath path,
gint col,
GdkEvent *event);
gboolean (*key_press) (ETree *et,
gint row,
ETreePath path,
gint col,
GdkEvent *event);
gboolean (*start_drag) (ETree *et,
gint row,
ETreePath path,
gint col,
GdkEvent *event);
void (*state_change) (ETree *et);
gboolean (*white_space_event) (ETree *et,
GdkEvent *event);
/* Source side drag signals */
void (*tree_drag_begin) (ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context);
void (*tree_drag_end) (ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context);
void (*tree_drag_data_get) (ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context,
GtkSelectionData *selection_data,
guint info,
guint time);
void (*tree_drag_data_delete)
(ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context);
/* Target side drag signals */
void (*tree_drag_leave) (ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context,
guint time);
gboolean (*tree_drag_motion) (ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context,
gint x,
gint y,
guint time);
gboolean (*tree_drag_drop) (ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context,
gint x,
gint y,
guint time);
void (*tree_drag_data_received)
(ETree *tree,
gint row,
ETreePath path,
gint col,
GdkDragContext *context,
gint x,
gint y,
GtkSelectionData *selection_data,
guint info,
guint time);
};
GType e_tree_get_type (void) G_GNUC_CONST;
gboolean e_tree_construct (ETree *e_tree,
ETreeModel *etm,
ETableExtras *ete,
const gchar *spec,
const gchar *state);
GtkWidget * e_tree_new (ETreeModel *etm,
ETableExtras *ete,
const gchar *spec,
const gchar *state);
/* Create an ETree using files. */
gboolean e_tree_construct_from_spec_file (ETree *e_tree,
ETreeModel *etm,
ETableExtras *ete,
const gchar *spec_fn,
const gchar *state_fn);
GtkWidget * e_tree_new_from_spec_file (ETreeModel *etm,
ETableExtras *ete,
const gchar *spec_fn,
const gchar *state_fn);
/* To save the state */
gchar * e_tree_get_state (ETree *e_tree);
void e_tree_save_state (ETree *e_tree,
const gchar *filename);
ETableState * e_tree_get_state_object (ETree *e_tree);
ETableSpecification *
e_tree_get_spec (ETree *e_tree);
/* note that it is more efficient to provide the state at creation time */
void e_tree_set_search_column (ETree *e_tree,
gint col);
void e_tree_set_state (ETree *e_tree,
const gchar *state);
void e_tree_set_state_object (ETree *e_tree,
ETableState *state);
void e_tree_load_state (ETree *e_tree,
const gchar *filename);
void e_tree_show_cursor_after_reflow (ETree *e_tree);
void e_tree_set_cursor (ETree *e_tree,
ETreePath path);
/* NULL means we don't have the cursor. */
ETreePath e_tree_get_cursor (ETree *e_tree);
void e_tree_selected_row_foreach (ETree *e_tree,
EForeachFunc callback,
gpointer closure);
#ifdef E_TREE_USE_TREE_SELECTION
void e_tree_selected_path_foreach (ETree *e_tree,
ETreeForeachFunc callback,
gpointer closure);
void e_tree_path_foreach (ETree *e_tree,
ETreeForeachFunc callback,
gpointer closure);
#endif
EPrintable *e_tree_get_printable (ETree *e_tree);
gint e_tree_get_next_row (ETree *e_tree,
gint model_row);
gint e_tree_get_prev_row (ETree *e_tree,
gint model_row);
gint e_tree_model_to_view_row (ETree *e_tree,
gint model_row);
gint e_tree_view_to_model_row (ETree *e_tree,
gint view_row);
void e_tree_get_cell_at (ETree *tree,
gint x,
gint y,
gint *row_return,
gint *col_return);
void e_tree_get_cell_geometry (ETree *tree,
gint row,
gint col,
gint *x_return,
gint *y_return,
gint *width_return,
gint *height_return);
/* Useful accessors */
ETreeModel * e_tree_get_model (ETree *et);
ESelectionModel *
e_tree_get_selection_model (ETree *et);
ETreeTableAdapter *
e_tree_get_table_adapter (ETree *et);
/* Drag & drop stuff. */
/* Target */
void e_tree_drag_get_data (ETree *tree,
gint row,
gint col,
GdkDragContext *context,
GdkAtom target,
guint32 time);
void e_tree_drag_highlight (ETree *tree,
gint row,
gint col); /* col == -1 to highlight entire row. */
void e_tree_drag_unhighlight (ETree *tree);
void e_tree_drag_dest_set (ETree *tree,
GtkDestDefaults flags,
const GtkTargetEntry *targets,
gint n_targets,
GdkDragAction actions);
void e_tree_drag_dest_set_proxy (ETree *tree,
GdkWindow *proxy_window,
GdkDragProtocol protocol,
gboolean use_coordinates);
/* There probably should be functions for setting the targets
* as a GtkTargetList
*/
void e_tree_drag_dest_unset (GtkWidget *widget);
/* Source side */
void e_tree_drag_source_set (ETree *tree,
GdkModifierType start_button_mask,
const GtkTargetEntry *targets,
gint n_targets,
GdkDragAction actions);
void e_tree_drag_source_unset (ETree *tree);
/* There probably should be functions for setting the targets
* as a GtkTargetList
*/
GdkDragContext *e_tree_drag_begin (ETree *tree,
gint row,
gint col,
GtkTargetList *targets,
GdkDragAction actions,
gint button,
GdkEvent *event);
gboolean e_tree_is_dragging (ETree *tree);
/* Adapter functions */
gboolean e_tree_node_is_expanded (ETree *et,
ETreePath path);
void e_tree_node_set_expanded (ETree *et,
ETreePath path,
gboolean expanded);
void e_tree_node_set_expanded_recurse
(ETree *et,
ETreePath path,
gboolean expanded);
void e_tree_root_node_set_visible (ETree *et,
gboolean visible);
ETreePath e_tree_node_at_row (ETree *et,
gint row);
gint e_tree_row_of_node (ETree *et,
ETreePath path);
gboolean e_tree_root_node_is_visible (ETree *et);
void e_tree_show_node (ETree *et,
ETreePath path);
void e_tree_save_expanded_state (ETree *et,
gchar *filename);
void e_tree_load_expanded_state (ETree *et,
gchar *filename);
xmlDoc * e_tree_save_expanded_state_xml (ETree *et);
void e_tree_load_expanded_state_xml (ETree *et,
xmlDoc *doc);
gint e_tree_row_count (ETree *et);
GtkWidget * e_tree_get_tooltip (ETree *et);
void e_tree_force_expanded_state (ETree *et,
gint state);
typedef enum {
E_TREE_FIND_NEXT_BACKWARD = 0,
E_TREE_FIND_NEXT_FORWARD = 1 << 0,
E_TREE_FIND_NEXT_WRAP = 1 << 1
} ETreeFindNextParams;
gboolean e_tree_find_next (ETree *et,
ETreeFindNextParams params,
ETreePathFunc func,
gpointer data);
/* This function is only needed in single_selection_mode. */
void e_tree_right_click_up (ETree *et);
ETableItem * e_tree_get_item (ETree *et);
GnomeCanvasItem *
e_tree_get_header_item (ETree *et);
void e_tree_set_info_message (ETree *tree,
const gchar *info_message);
void e_tree_freeze_state_change (ETree *table);
void e_tree_thaw_state_change (ETree *table);
G_END_DECLS
#endif /* _E_TREE_H_ */
|
