aboutsummaryrefslogtreecommitdiffstats
path: root/widgets/e-table/e-table.h
blob: 19dcbfecc8d63ba8ff410e3c3061cc470f8a6d75 (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
240
241
242
243
244
245
246
247
248
249
250
251
252
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
#ifndef _E_TABLE_H_
#define _E_TABLE_H_

#include <libgnomeui/gnome-canvas.h>
#include <gtk/gtktable.h>
#include <gnome-xml/tree.h>
#include "e-table-model.h"
#include "e-table-header.h"
#include "e-table-group.h"
#include "e-table-sort-info.h"
#include "e-table-item.h"
#include "e-table-selection-model.h"
#include "e-util/e-printable.h"

BEGIN_GNOME_DECLS

#define E_TABLE_TYPE        (e_table_get_type ())
#define E_TABLE(o)          (GTK_CHECK_CAST ((o), E_TABLE_TYPE, ETable))
#define E_TABLE_CLASS(k)    (GTK_CHECK_CLASS_CAST((k), E_TABLE_TYPE, ETableClass))
#define E_IS_TABLE(o)       (GTK_CHECK_TYPE ((o), E_TABLE_TYPE))
#define E_IS_TABLE_CLASS(k) (GTK_CHECK_CLASS_TYPE ((k), E_TABLE_TYPE))

typedef struct _ETableDragSourceSite ETableDragSourceSite;

typedef enum {
    E_TABLE_CURSOR_LOC_NONE = 0,
    E_TABLE_CURSOR_LOC_ETCTA = 1 << 0,
    E_TABLE_CURSOR_LOC_TABLE = 1 << 1,
} ETableCursorLoc;

typedef struct {
    GtkTable parent;

    ETableModel *model;

    ETableHeader *full_header, *header;

    GnomeCanvasItem *canvas_vbox;
    ETableGroup  *group;

    ETableSortInfo *sort_info;
    ETableSorter   *sorter;

    ETableSelectionModel *selection;
    ETableCursorLoc cursor_loc;

    int table_model_change_id;
    int table_row_change_id;
    int table_cell_change_id;
    int table_row_inserted_id;
    int table_row_deleted_id;

    int group_info_change_id;

    int reflow_idle_id;

    GnomeCanvas *header_canvas, *table_canvas;

    GnomeCanvasItem *header_item, *root;

    gint length_threshold;

    gint rebuild_idle_id;
    guint need_rebuild:1;

    /*
     * Configuration settings
     */
    guint draw_grid : 1;
    guint draw_focus : 1;
    guint row_selection_active : 1;
    
    char *click_to_add_message;
    GnomeCanvasItem *click_to_add;
    gboolean use_click_to_add;

    ETableCursorMode cursor_mode;

    int drag_get_data_row;
    int drag_get_data_col;

    int drop_row;
    int drop_col;

    int drag_row;
    int drag_col;
    ETableDragSourceSite *site;
    
    int drag_source_button_press_event_id;
    int drag_source_motion_notify_event_id;
} ETable;

typedef struct {
    GtkTableClass parent_class;

    void        (*cursor_change)      (ETable *et, int row);
    void        (*double_click)       (ETable *et, int row);
    gint        (*right_click)        (ETable *et, int row, int col, GdkEvent *event);
    gint        (*key_press)          (ETable *et, int row, int col, GdkEvent *event);

    void  (*set_scroll_adjustments)   (ETable    *table,
                       GtkAdjustment *hadjustment,
                       GtkAdjustment *vadjustment);

    /* Source side drag signals */
    void (* table_drag_begin)              (ETable         *table,
                            int                 row,
                            int                 col,
                            GdkDragContext     *context);
    void (* table_drag_end)            (ETable         *table,
                        int                 row,
                        int                 col,
                        GdkDragContext     *context);
    void (* table_drag_data_get)             (ETable             *table,
                          int                 row,
                          int                 col,
                          GdkDragContext     *context,
                          GtkSelectionData   *selection_data,
                          guint               info,
                          guint               time);
    void (* table_drag_data_delete)          (ETable           *table,
                          int                 row,
                          int                 col,
                          GdkDragContext     *context);
    
    /* Target side drag signals */     
    void (* table_drag_leave)              (ETable         *table,
                            int                 row,
                            int                 col,
                            GdkDragContext     *context,
                            guint               time);
    gboolean (* table_drag_motion)           (ETable           *table,
                          int                 row,
                          int                 col,
                          GdkDragContext     *context,
                          gint                x,
                          gint                y,
                          guint               time);
    gboolean (* table_drag_drop)             (ETable           *table,
                          int                 row,
                          int                 col,
                          GdkDragContext     *context,
                          gint                x,
                          gint                y,
                          guint               time);
    void (* table_drag_data_received)        (ETable             *table,
                          int                 row,
                          int                 col,
                          GdkDragContext     *context,
                          gint                x,
                          gint                y,
                          GtkSelectionData   *selection_data,
                          guint               info,
                          guint               time);
} ETableClass;

GtkType     e_table_get_type            (void);
       
ETable     *e_table_construct           (ETable *e_table, ETableHeader *full_header, ETableModel *etm,
                          const char *spec);
GtkWidget  *e_table_new                 (ETableHeader *full_header, ETableModel *etm,
                          const char *spec);
       
ETable     *e_table_construct_from_spec_file (ETable *e_table,
                          ETableHeader *full_header,
                          ETableModel *etm,
                          const char *filename);
GtkWidget  *e_table_new_from_spec_file       (ETableHeader *full_header,
                          ETableModel *etm,
                          const char *filename);
       
gchar      *e_table_get_specification        (ETable *e_table);
void        e_table_save_specification       (ETable *e_table, gchar *filename);
       
void        e_table_set_cursor_row           (ETable *e_table,
                          int row);
/* -1 means we don't have the cursor. */
int         e_table_get_cursor_row           (ETable *e_table);
void        e_table_selected_row_foreach     (ETable *e_table,
                          ETableForeachFunc callback,
                          gpointer closure);
EPrintable *e_table_get_printable            (ETable *e_table);

gint        e_table_get_next_row             (ETable *e_table,
                          gint    model_row);
gint        e_table_get_prev_row             (ETable *e_table,
                          gint    model_row);

gint        e_table_model_to_view_row        (ETable *e_table,
                          gint    model_row);
gint        e_table_view_to_model_row        (ETable *e_table,
                          gint    view_row);


/* Drag & drop stuff. */
/* Target */
void e_table_drag_get_data (ETable         *table,
                int             row,
                int             col,
                GdkDragContext *context,
                GdkAtom         target,
                guint32         time);

void e_table_drag_highlight   (ETable     *table,
                   int         row,
                   int         col); /* col == -1 to highlight entire row. */
void e_table_drag_unhighlight (ETable     *table);

void e_table_drag_dest_set   (ETable               *table,
                  GtkDestDefaults       flags,
                  const GtkTargetEntry *targets,
                  gint                  n_targets,
                  GdkDragAction         actions);

void e_table_drag_dest_set_proxy (ETable         *table,
                  GdkWindow      *proxy_window,
                  GdkDragProtocol protocol,
                  gboolean        use_coordinates);

/* There probably should be functions for setting the targets
 * as a GtkTargetList
 */

void e_table_drag_dest_unset (GtkWidget          *widget);

/* Source side */

void e_table_drag_source_set  (ETable               *table,
                   GdkModifierType       start_button_mask,
                   const GtkTargetEntry *targets,
                   gint                  n_targets,
                   GdkDragAction         actions);

void e_table_drag_source_unset (ETable        *table);

/* There probably should be functions for setting the targets
 * as a GtkTargetList
 */

GdkDragContext *e_table_drag_begin (ETable            *table,
                    int row,
                    int col,
                    GtkTargetList     *targets,
                    GdkDragAction      actions,
                    gint               button,
                    GdkEvent          *event);

END_GNOME_DECLS

#endif /* _E_TABLE_H_ */