2005-02-17 [colin] 1.0.1cvs11.5
[claws.git] / src / summaryview.h
1 /*
2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2004 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 typedef enum
37 {
38         S_COL_MARK,
39         S_COL_STATUS,
40         S_COL_MIME,
41         S_COL_SUBJECT,
42         S_COL_FROM,
43         S_COL_DATE,
44         S_COL_SIZE,
45         S_COL_NUMBER,
46         S_COL_SCORE,
47         S_COL_LOCKED
48 } SummaryColumnType;
49
50 #define N_SUMMARY_COLS  10
51
52 typedef enum
53 {
54         SUMMARY_NONE,
55         SUMMARY_SELECTED_NONE,
56         SUMMARY_SELECTED_SINGLE,
57         SUMMARY_SELECTED_MULTIPLE
58 } SummarySelection;
59
60 typedef enum
61 {
62         TARGET_MAIL_URI_LIST,
63         TARGET_DUMMY
64 } TargetInfo;
65
66 #include "mainwindow.h"
67 #include "folderview.h"
68 #include "headerview.h"
69 #include "messageview.h"
70 #include "compose.h"
71 #include "folder.h"
72 #include "gtksctree.h"
73 #include "prefs_filtering.h"
74 #include "quicksearch.h"
75
76 extern GtkTargetEntry summary_drag_types[1];
77
78 struct _SummaryColumnState
79 {
80         SummaryColumnType type;
81         gboolean visible;
82 };
83
84 struct _SummaryView
85 {
86         GtkWidget *vbox;
87         GtkWidget *scrolledwin;
88         GtkWidget *ctree;
89         GtkWidget *hbox;
90         GtkWidget *hbox_l;
91         GtkWidget *folder_pixmap;
92         GtkWidget *statlabel_folder;
93         GtkWidget *statlabel_select;
94         GtkWidget *statlabel_msgs;
95         GtkWidget *toggle_eventbox;
96         GtkWidget *toggle_arrow;
97         GtkWidget *toggle_search;
98         GtkWidget *quick_search_pixmap;
99         GtkWidget *popupmenu;
100         GtkWidget *colorlabel_menu;
101
102         GtkItemFactory *popupfactory;
103
104         GtkWidget *window;
105
106         GtkCTreeNode *selected;
107         GtkCTreeNode *displayed;
108
109         gboolean display_msg;
110
111         GdkColor color_important;
112         SummaryColumnState col_state[N_SUMMARY_COLS];
113         gint col_pos[N_SUMMARY_COLS];
114
115         GdkColor color_marked;
116         GdkColor color_dim;
117
118         guint lock_count;
119
120         MainWindow   *mainwin;
121         FolderView   *folderview;
122         HeaderView   *headerview;
123         MessageView  *messageview;
124         QuickSearch  *quicksearch;
125
126         FolderItem *folder_item;
127
128         /* summaryview prefs */
129         gint important_score;
130         FolderSortKey sort_key;
131         FolderSortType sort_type;
132         guint threaded;
133         guint thread_collapsed;
134
135         /* Extra data for summaryview */
136         regex_t *simplify_subject_preg;
137
138         /* current message status */
139         gint   unreadmarked;
140         off_t  total_size;
141         gint   deleted;
142         gint   moved;
143         gint   copied;
144
145 /*
146 private:
147 */
148         /* table for looking up message-id */
149         GHashTable *msgid_table;
150         GHashTable *subject_table;
151
152         /* list for moving/deleting messages */
153         GSList *mlist;
154         int msginfo_update_callback_id;
155
156         GtkTargetList *target_list; /* DnD */
157 };
158
159 SummaryView     *summary_create(void);
160
161 void summary_init                 (SummaryView          *summaryview);
162 gboolean summary_show             (SummaryView          *summaryview,
163                                    FolderItem           *fitem);
164 void summary_clear_list           (SummaryView          *summaryview);
165 void summary_clear_all            (SummaryView          *summaryview);
166
167 void summary_lock                 (SummaryView          *summaryview);
168 void summary_unlock               (SummaryView          *summaryview);
169 gboolean summary_is_locked        (SummaryView          *summaryview);
170
171 SummarySelection summary_get_selection_type     (SummaryView    *summaryview);
172 MsgInfo *summary_get_selected_msg               (SummaryView *summaryview);
173 GSList *summary_get_selected_msg_list           (SummaryView    *summaryview);
174
175 void summary_select_prev_unread   (SummaryView          *summaryview);
176 void summary_select_next_unread   (SummaryView          *summaryview);
177 void summary_select_prev_new      (SummaryView          *summaryview);
178 void summary_select_next_new      (SummaryView          *summaryview);
179 void summary_select_prev_marked   (SummaryView          *summaryview);
180 void summary_select_next_marked   (SummaryView          *summaryview);
181 void summary_select_prev_labeled  (SummaryView          *summaryview);
182 void summary_select_next_labeled  (SummaryView          *summaryview);
183 void summary_select_by_msgnum     (SummaryView          *summaryview,
184                                    guint                 msgnum);
185 guint summary_get_current_msgnum  (SummaryView          *summaryview);
186 void summary_select_node          (SummaryView          *summaryview,
187                                    GtkCTreeNode         *node,
188                                    gboolean              display_msg,
189                                    gboolean              do_refresh);
190
191 void summary_thread_build         (SummaryView          *summaryview);
192 void summary_unthread             (SummaryView          *summaryview);
193
194 void summary_expand_threads       (SummaryView          *summaryview);
195 void summary_collapse_threads     (SummaryView          *summaryview);
196 void summary_toggle_ignore_thread (SummaryView          *summaryview);
197
198 void summary_filter               (SummaryView          *summaryview,
199                                    gboolean              selected_only);
200 void summary_filter_open          (SummaryView *summaryview,
201                                    PrefsFilterType type,
202                                    gint processing_rule);
203 void summary_msginfo_filter_open  (FolderItem * item, MsgInfo *msginfo,
204                                    PrefsFilterType type, gint processing_rule);
205
206 void summary_sort                 (SummaryView          *summaryview,
207                                    FolderSortKey         sort_key,
208                                    FolderSortType        sort_type);
209
210 void summary_delete               (SummaryView          *summaryview);
211
212 void summary_cancel               (SummaryView          *summaryview);
213
214 gboolean summary_execute          (SummaryView          *summaryview);
215
216 void summary_attract_by_subject   (SummaryView          *summaryview);
217
218 gint summary_write_cache          (SummaryView          *summaryview);
219
220 void summary_pass_key_press_event (SummaryView          *summaryview,
221                                    GdkEventKey          *event);
222
223 void summary_display_msg_selected (SummaryView          *summaryview,
224                                    gboolean              all_headers);
225 void summary_redisplay_msg        (SummaryView          *summaryview);
226 void summary_open_msg             (SummaryView          *summaryview);
227 void summary_view_source          (SummaryView          *summaryview);
228 void summary_reedit               (SummaryView          *summaryview);
229 void summary_step                 (SummaryView          *summaryview,
230                                    GtkScrollType         type);
231 void summary_toggle_view          (SummaryView          *summaryview);
232 void summary_set_marks_selected   (SummaryView          *summaryview);
233
234 void summary_move_selected_to     (SummaryView          *summaryview,
235                                    FolderItem           *to_folder);
236 void summary_move_to              (SummaryView          *summaryview);
237 void summary_copy_selected_to     (SummaryView          *summaryview,
238                                    FolderItem           *to_folder);
239 GSList *summary_get_selection     (SummaryView          *summaryview);
240 void summary_copy_to              (SummaryView          *summaryview);
241 void summary_save_as              (SummaryView          *summaryview);
242 void summary_print                (SummaryView          *summaryview);
243 void summary_mark                 (SummaryView          *summaryview);
244 void summary_unmark               (SummaryView          *summaryview);
245 void summary_mark_as_unread       (SummaryView          *summaryview);
246 void summary_mark_as_read         (SummaryView          *summaryview);
247 void summary_msgs_lock            (SummaryView          *summaryview);
248 void summary_msgs_unlock          (SummaryView          *summaryview);
249 void summary_mark_all_read        (SummaryView          *summaryview);
250 void summary_add_address          (SummaryView          *summaryview);
251 void summary_select_all           (SummaryView          *summaryview);
252 void summary_unselect_all         (SummaryView          *summaryview);
253 void summary_select_thread        (SummaryView          *summaryview);
254
255 void summary_set_colorlabel       (SummaryView          *summaryview,
256                                    guint                 labelcolor,
257                                    GtkWidget            *widget);
258 void summary_set_colorlabel_color (GtkCTree             *ctree,
259                                    GtkCTreeNode         *node,
260                                    guint                 labelcolor);
261
262 void summary_set_column_order     (SummaryView          *summaryview);
263
264 #if 0 /* OLD PROCESSING */
265 void processing_apply();
266 #endif
267
268 void summary_toggle_show_read_messages
269                                   (SummaryView *summaryview);
270
271 void summary_toggle_view_real     (SummaryView  *summaryview);
272
273 void summary_reflect_prefs_pixmap_theme
274                                   (SummaryView *summaryview);
275
276 void summary_harvest_address      (SummaryView *summaryview);
277 void summary_set_prefs_from_folderitem
278                                   (SummaryView *summaryview, FolderItem *item);
279 void summary_save_prefs_to_folderitem
280                                   (SummaryView *summaryview, FolderItem *item);
281 void summaryview_export_mbox_list (SummaryView *summaryview);
282 #endif /* __SUMMARY_H__ */