aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/table/e-tree.h
blob: 60d39d8464f1c2344fed9da2d1ecb0bb91f7c550 (plain) (blame)
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
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
#ifndef _E_TREE_H_
#define _E_TREE_H_

#include <gtk/gtktable.h>
#include <gnome-xml/tree.h>

#include <gal/widgets/e-printable.h>

#include <gal/e-table/e-table-extras.h>
#include <gal/e-table/e-table-specification.h>
#include <gal/e-table/e-table-state.h>
#include <gal/e-table/e-tree-model.h>

BEGIN_GNOME_DECLS

#define E_TREE_TYPE        (e_tree_get_type ())
#define E_TREE(o)          (GTK_CHECK_CAST ((o), E_TREE_TYPE, ETree))
#define E_TREE_CLASS(k)    (GTK_CHECK_CLASS_CAST((k), E_TREE_TYPE, ETreeClass))
#define E_IS_TREE(o)       (GTK_CHECK_TYPE ((o), E_TREE_TYPE))
#define E_IS_TREE_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_TREE_TYPE))

typedef struct _ETreeDragSourceSite ETreeDragSourceSite;
typedef struct ETreePriv ETreePriv;

typedef struct {
    GtkTable parent;

    ETreePriv *priv;
} ETree;

typedef struct {
    GtkTableClass parent_class;

    void        (*cursor_change)      (ETree *et, int row, ETreePath path);
    void        (*cursor_activated)   (ETree *et, int row, ETreePath path);
    void        (*selection_change)   (ETree *et);
    void        (*double_click)       (ETree *et, int row, ETreePath path, int col, GdkEvent *event);
    gint        (*right_click)        (ETree *et, int row, ETreePath path, int col, GdkEvent *event);
    gint        (*click)              (ETree *et, int row, ETreePath path, int col, GdkEvent *event);
    gint        (*key_press)          (ETree *et, int row, ETreePath path, int col, GdkEvent *event);

    void  (*set_scroll_adjustments)   (ETree     *tree,
                       GtkAdjustment *hadjustment,
                       GtkAdjustment *vadjustment);

    /* Source side drag signals */
    void (* tree_drag_begin)               (ETree          *tree,
                            int                 row,
                            ETreePath           path,
                            int                 col,
                            GdkDragContext     *context);
    void (* tree_drag_end)             (ETree          *tree,
                        int                 row,
                        ETreePath           path,
                        int                 col,
                        GdkDragContext     *context);
    void (* tree_drag_data_get)             (ETree             *tree,
                         int                 row,
                         ETreePath           path,
                         int                 col,
                         GdkDragContext     *context,
                         GtkSelectionData   *selection_data,
                         guint               info,
                         guint               time);
    void (* tree_drag_data_delete)          (ETree         *tree,
                         int                 row,
                         ETreePath           path,
                         int                 col,
                         GdkDragContext     *context);
    
    /* Target side drag signals */     
    void (* tree_drag_leave)               (ETree          *tree,
                            int                 row,
                            ETreePath           path,
                            int                 col,
                            GdkDragContext     *context,
                            guint               time);
    gboolean (* tree_drag_motion)           (ETree         *tree,
                         int                 row,
                         ETreePath           path,
                         int                 col,
                         GdkDragContext     *context,
                         gint                x,
                         gint                y,
                         guint               time);
    gboolean (* tree_drag_drop)             (ETree         *tree,
                         int                 row,
                         ETreePath           path,
                         int                 col,
                         GdkDragContext     *context,
                         gint                x,
                         gint                y,
                         guint               time);
    void (* tree_drag_data_received)        (ETree             *tree,
                         int                 row,
                         ETreePath           path,
                         int                 col,
                         GdkDragContext     *context,
                         gint                x,
                         gint                y,
                         GtkSelectionData   *selection_data,
                         guint               info,
                         guint               time);
} ETreeClass;

GtkType         e_tree_get_type                  (void);

ETree         *e_tree_construct                 (ETree               *e_tree,
                         ETreeModel          *etm,
                         ETableExtras         *ete,
                         const char           *spec,
                         const char           *state);
GtkWidget      *e_tree_new                       (ETreeModel          *etm,
                          ETableExtras         *ete,
                          const char           *spec,
                          const char           *state);

/* Create an ETree using files. */
ETree         *e_tree_construct_from_spec_file  (ETree               *e_tree,
                         ETreeModel          *etm,
                         ETableExtras         *ete,
                         const char           *spec_fn,
                         const char           *state_fn);
GtkWidget      *e_tree_new_from_spec_file        (ETreeModel          *etm,
                          ETableExtras         *ete,
                          const char           *spec_fn,
                          const char           *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);

/* note that it is more efficient to provide the state at creation time */
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_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);
gint            e_tree_selected_count            (ETree               *e_tree);
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,
                          int x, int y,
                          int *row_return, int *col_return);

/* Drag & drop stuff. */
/* Target */
void            e_tree_drag_get_data             (ETree               *tree,
                          int                   row,
                          int                   col,
                          GdkDragContext       *context,
                          GdkAtom               target,
                          guint32               time);
void            e_tree_drag_highlight            (ETree               *tree,
                          int                   row,
                          int                   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,
                          int                   row,
                          int                   col,
                          GtkTargetList        *targets,
                          GdkDragAction         actions,
                          gint                  button,
                          GdkEvent             *event);

/* selection stuff */
void            e_tree_select_all                (ETree               *tree);
void            e_tree_invert_selection          (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, int row);
int          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, char *filename);
void         e_tree_load_expanded_state (ETree *et, char *filename);

int          e_tree_row_count           (ETree *et);

END_GNOME_DECLS

#endif /* _E_TREE_H_ */