2005-06-15 [colin] 1.9.11cvs74
[claws.git] / src / summaryview.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2005 Hiroyuki Yamamoto
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #ifndef __SUMMARY_H__
21 #define __SUMMARY_H__
22
23 #include <sys/types.h>
24 #include <regex.h>
25
26 #include <glib.h>
27 #include <gdk/gdk.h>
28 #include <gtk/gtkwidget.h>
29 #include <gtk/gtkitemfactory.h>
30 #include <gtk/gtkctree.h>
31 #include <gtk/gtkdnd.h>
32
33 typedef struct _SummaryView             SummaryView;
34 typedef struct _SummaryColumnState      SummaryColumnState;
35
36 #define MAIL_MANUAL_FILTERING_HOOKLIST "mail_manual_filtering_hooklist"
37
38 typedef enum
39 {
40         S_COL_MARK,
41         S_COL_STATUS,
42         S_COL_MIME,
43         S_COL_SUBJECT,
44         S_COL_FROM,
45         S_COL_DATE,
46         S_COL_SIZE,
47         S_COL_NUMBER,
48         S_COL_SCORE,
49         S_COL_LOCKED
50 } SummaryColumnType;
51
52 #define N_SUMMARY_COLS  10
53
54 typedef enum
55 {
56         SUMMARY_NONE,
57         SUMMARY_SELECTED_NONE,
58         SUMMARY_SELECTED_SINGLE,
59         SUMMARY_SELECTED_MULTIPLE
60 } SummarySelection;
61
62 typedef enum
63 {
64         TARGET_MAIL_URI_LIST,
65         TARGET_DUMMY
66 } TargetInfo;
67
68 #include "mainwindow.h"
69 #include "folderview.h"
70 #include "headerview.h"
71 #include "messageview.h"
72 #include "compose.h"
73 #include "folder.h"
74 #include "gtksctree.h"
75 #include "prefs_filtering.h"
76 #include "quicksearch.h"
77
78 extern GtkTargetEntry summary_drag_types[1];
79
80 struct _SummaryColumnState
81 {
82         SummaryColumnType type;
83         gboolean visible;
84 };
85
86 struct _SummaryView
87 {
88         GtkWidget *vbox;
89         GtkWidget *scrolledwin;
90         GtkWidget *ctree;
91         GtkWidget *hbox;
92         GtkWidget *hbox_l;
93         GtkWidget *folder_pixmap;
94         GtkWidget *statlabel_folder;
95         GtkWidget *statlabel_select;
96         GtkWidget *statlabel_msgs;
97         GtkWidget *toggle_eventbox;
98         GtkWidget *toggle_arrow;
99         GtkWidget *toggle_search;
100         GtkWidget *quick_search_pixmap;
101         GtkWidget *popupmenu;
102         GtkWidget *colorlabel_menu;
103
104         GtkItemFactory *popupfactory;
105
106         GtkWidget *window;
107
108         GtkCTreeNode *selected;
109         GtkCTreeNode *displayed;
110
111         gboolean display_msg;
112
113         GdkColor color_important;
114         SummaryColumnState col_state[N_SUMMARY_COLS];
115         gint col_pos[N_SUMMARY_COLS];
116
117         GdkColor color_marked;
118         GdkColor color_dim;
119
120         guint lock_count;
121
122         MainWindow   *mainwin;
123         FolderView   *folderview;
124         HeaderView   *headerview;
125         MessageView  *messageview;
126         QuickSearch  *quicksearch;
127
128         FolderItem *folder_item;
129
130         /* summaryview prefs */
131         gint important_score;
132         FolderSortKey sort_key;
133         FolderSortType sort_type;
134         guint threaded;
135         guint thread_collapsed;
136
137         /* Extra data for summaryview */
138         regex_t *simplify_subject_preg;
139
140         /* current message status */
141         gint   unreadmarked;
142         off_t  total_size;
143         gint   deleted;
144         gint   moved;
145         gint   copied;
146
147 /*
148 private:
149 */
150         /* table for looking up message-id */
151         GHashTable *msgid_table;
152         GHashTable *subject_table;
153
154         /* list for moving/deleting messages */
155         GSList *mlist;
156         int msginfo_update_callback_id;
157
158         GtkTargetList *target_list; /* DnD */
159 };
160
161 SummaryView     *summary_create(void);
162
163 void summary_init                 (SummaryView          *summaryview);
164 gboolean summary_show             (SummaryView          *summaryview,
165                                    FolderItem           *fitem);
166 void summary_clear_list           (SummaryView          *summaryview);
167 void summary_clear_all            (SummaryView          *summaryview);
168
169 void summary_lock                 (SummaryView          *summaryview);
170 void summary_unlock               (SummaryView          *summaryview);
171 gboolean summary_is_locked        (SummaryView          *summaryview);
172
173 SummarySelection summary_get_selection_type     (SummaryView    *summaryview);
174 MsgInfo *summary_get_selected_msg               (SummaryView *summaryview);
175 GSList *summary_get_selected_msg_list           (SummaryView    *summaryview);
176
177 void summary_select_prev_unread   (SummaryView          *summaryview);
178 void summary_select_next_unread   (SummaryView          *summaryview);
179 void summary_select_prev_new      (SummaryView          *summaryview);
180 void summary_select_next_new      (SummaryView          *summaryview);
181 void summary_select_prev_marked   (SummaryView          *summaryview);
182 void summary_select_next_marked   (SummaryView          *summaryview);
183 void summary_select_prev_labeled  (SummaryView          *summaryview);
184 void summary_select_next_labeled  (SummaryView          *summaryview);
185 void summary_select_by_msgnum     (SummaryView          *summaryview,
186                                    guint                 msgnum);
187 guint summary_get_current_msgnum  (SummaryView          *summaryview);
188 void summary_select_node          (SummaryView          *summaryview,
189                                    GtkCTreeNode         *node,
190                                    gboolean              display_msg,
191                                    gboolean              do_refresh);
192
193 void summary_thread_build         (SummaryView          *summaryview);
194 void summary_unthread             (SummaryView          *summaryview);
195
196 void summary_expand_threads       (SummaryView          *summaryview);
197 void summary_collapse_threads     (SummaryView          *summaryview);
198 void summary_toggle_ignore_thread (SummaryView          *summaryview);
199
200 void summary_filter               (SummaryView          *summaryview,
201                                    gboolean              selected_only);
202 void summary_filter_open          (SummaryView *summaryview,
203                                    PrefsFilterType type,
204                                    gint processing_rule);
205 void summary_msginfo_filter_open  (FolderItem * item, MsgInfo *msginfo,
206                                    PrefsFilterType type, gint processing_rule);
207
208 void summary_sort                 (SummaryView          *summaryview,
209                                    FolderSortKey         sort_key,
210                                    FolderSortType        sort_type);
211
212 void summary_delete               (SummaryView          *summaryview);
213
214 void summary_cancel               (SummaryView          *summaryview);
215
216 gboolean summary_execute          (SummaryView          *summaryview);
217
218 void summary_attract_by_subject   (SummaryView          *summaryview);
219
220 gint summary_write_cache          (SummaryView          *summaryview);
221
222 void summary_pass_key_press_event (SummaryView          *summaryview,
223                                    GdkEventKey          *event);
224
225 void summary_display_msg_selected (SummaryView          *summaryview,
226                                    gboolean              all_headers);
227 void summary_redisplay_msg        (SummaryView          *summaryview);
228 void summary_open_msg             (SummaryView          *summaryview);
229 void summary_view_source          (SummaryView          *summaryview);
230 void summary_reedit               (SummaryView          *summaryview);
231 gboolean summary_step             (SummaryView          *summaryview,
232                                    GtkScrollType         type);
233 void summary_toggle_view          (SummaryView          *summaryview);
234 void summary_set_marks_selected   (SummaryView          *summaryview);
235
236 void summary_move_selected_to     (SummaryView          *summaryview,
237                                    FolderItem           *to_folder);
238 void summary_move_to              (SummaryView          *summaryview);
239 void summary_copy_selected_to     (SummaryView          *summaryview,
240                                    FolderItem           *to_folder);
241 GSList *summary_get_selection     (SummaryView          *summaryview);
242 void summary_copy_to              (SummaryView          *summaryview);
243 void summary_save_as              (SummaryView          *summaryview);
244 void summary_print                (SummaryView          *summaryview);
245 void summary_mark                 (SummaryView          *summaryview);
246 void summary_unmark               (SummaryView          *summaryview);
247 void summary_mark_as_unread       (SummaryView          *summaryview);
248 void summary_mark_as_read         (SummaryView          *summaryview);
249 void summary_msgs_lock            (SummaryView          *summaryview);
250 void summary_msgs_unlock          (SummaryView          *summaryview);
251 void summary_mark_all_read        (SummaryView          *summaryview);
252 void summary_add_address          (SummaryView          *summaryview);
253 void summary_select_all           (SummaryView          *summaryview);
254 void summary_unselect_all         (SummaryView          *summaryview);
255 void summary_select_thread        (SummaryView          *summaryview);
256
257 void summary_set_colorlabel       (SummaryView          *summaryview,
258                                    guint                 labelcolor,
259                                    GtkWidget            *widget);
260 void summary_set_colorlabel_color (GtkCTree             *ctree,
261                                    GtkCTreeNode         *node,
262                                    guint                 labelcolor);
263
264 void summary_set_column_order     (SummaryView          *summaryview);
265
266 #if 0 /* OLD PROCESSING */
267 void processing_apply();
268 #endif
269
270 void summary_toggle_show_read_messages
271                                   (SummaryView *summaryview);
272
273 void summary_toggle_view_real     (SummaryView  *summaryview);
274
275 void summary_reflect_prefs_pixmap_theme
276                                   (SummaryView *summaryview);
277
278 void summary_harvest_address      (SummaryView *summaryview);
279 void summary_set_prefs_from_folderitem
280                                   (SummaryView *summaryview, FolderItem *item);
281 void summary_save_prefs_to_folderitem
282                                   (SummaryView *summaryview, FolderItem *item);
283 void summaryview_export_mbox_list (SummaryView *summaryview);
284 void summaryview_lock(SummaryView *summaryview, FolderItem *item);
285 void summaryview_unlock(SummaryView *summaryview, FolderItem *item);
286
287 #endif /* __SUMMARY_H__ */