src/summaryview.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2012 Hiroyuki Yamamoto and the Claws Mail team
   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 3 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, see <http://www.gnu.org/licenses/>.
  17  *
  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/gtk.h>
  29
  30 #include "viewtypes.h"
  31 typedef struct _SummaryColumnState      SummaryColumnState;
  32
  33 #define MAIL_MANUAL_FILTERING_HOOKLIST "mail_manual_filtering_hooklist"
  34
  35 typedef enum
  36 {
  37         S_COL_MARK,
  38         S_COL_STATUS,
  39         S_COL_MIME,
  40         S_COL_SUBJECT,
  41         S_COL_FROM,
  42         S_COL_TO,
  43         S_COL_DATE,
  44         S_COL_SIZE,
  45         S_COL_NUMBER,
  46         S_COL_SCORE,
  47         S_COL_LOCKED,
  48         S_COL_TAGS
  49 } SummaryColumnType;
  50
  51 #define N_SUMMARY_COLS  12
  52
  53 typedef enum
  54 {
  55         SUMMARY_NONE,
  56         SUMMARY_SELECTED_NONE,
  57         SUMMARY_SELECTED_SINGLE,
  58         SUMMARY_SELECTED_MULTIPLE
  59 } SummarySelection;
  60
  61 typedef enum
  62 {
  63         TARGET_MAIL_URI_LIST,
  64         TARGET_DUMMY,
  65         TARGET_MAIL_CM_PATH_LIST,
  66 } TargetInfo;
  67
  68 #include "mainwindow.h"
  69 #include "compose.h"
  70 #include "folder.h"
  71 #include "gtksctree.h"
  72 #include "prefs_filtering.h"
  73 #include "quicksearch.h"
  74
  75 extern GtkTargetEntry summary_drag_types[3];
  76
  77 struct _SummaryColumnState
  78 {
  79         SummaryColumnType type;
  80         gboolean visible;
  81 };
  82
  83 struct _SummaryView
  84 {
  85         GtkWidget *vbox;
  86         GtkWidget *mainwidget_book;
  87         GtkWidget *scrolledwin;
  88         GtkWidget *ctree;
  89         GtkWidget *hbox;
  90         GtkWidget *hbox_l;
  91         GtkWidget *hbox_spc;
  92         GtkWidget *stat_box;
  93         GtkWidget *stat_box2;
  94         GtkWidget *folder_pixmap;
  95         GtkWidget *folder_pixmap_eventbox;
  96         GtkWidget *statlabel_folder;
  97         GtkWidget *statlabel_select;
  98         GtkWidget *statlabel_msgs;
  99         GtkWidget *toggle_eventbox;
 100         GtkWidget *toggle_arrow;
 101 #ifdef GENERIC_UMPC
 102         GtkWidget *multiple_sel_togbtn;
 103         GtkWidget *multiple_sel_image;
 104 #endif
 105         GtkWidget *toggle_search;
 106         GtkWidget *quick_search_pixmap;
 107         GtkWidget *popupmenu;
 108         GtkWidget *colorlabel_menu;
 109         GtkWidget *tags_menu;
 110
 111         GtkWidget *window;
 112
 113         GtkCMCTreeNode *selected;
 114         GtkCMCTreeNode *displayed;
 115
 116         gboolean display_msg;
 117
 118         GdkColor color_important;
 119         SummaryColumnState col_state[N_SUMMARY_COLS];
 120         gint col_pos[N_SUMMARY_COLS];
 121
 122         GdkColor color_marked;
 123         GdkColor color_dim;
 124
 125         guint lock_count;
 126
 127         MainWindow   *mainwin;
 128         FolderView   *folderview;
 129         HeaderView   *headerview;
 130         MessageView  *messageview;
 131         MessageView  *ext_messageview;
 132         QuickSearch  *quicksearch;
 133
 134         FolderItem *folder_item;
 135
 136         /* summaryview prefs */
 137         gint important_score;
 138         FolderSortKey sort_key;
 139         FolderSortType sort_type;
 140         guint threaded;
 141         guint thread_collapsed;
 142
 143         /* Extra data for summaryview */
 144         regex_t *simplify_subject_preg;
 145
 146         /* current message status */
 147         gint   unreadmarked;
 148         goffset total_size;
 149         gint   deleted;
 150         gint   moved;
 151         gint   copied;
 152
 153 /*
 154 private:
 155 */
 156         /* table for looking up message-id */
 157         GHashTable *msgid_table;
 158         GHashTable *subject_table;
 159
 160         /* list for moving/deleting messages */
 161         GSList *mlist;
 162         int msginfo_update_callback_id;
 163
 164         /* update folder label when renaming */
 165         gint folder_item_update_callback_id;
 166         gint folder_update_callback_id;
 167
 168         GtkTargetList *target_list; /* DnD */
 169
 170         // folders with matches for recursive quicksearch queries
 171         GSList *recursive_matched_folders;
 172         FolderItem *search_root_folder;
 173
 174         guint mark_as_read_timeout_tag;
 175 #if !GTK_CHECK_VERSION(2,12,0)
 176         GtkTooltips *tooltips;
 177 #endif
 178 };
 179
 180 SummaryView     *summary_create(MainWindow *mainwin);
 181 void summaryview_destroy(SummaryView *summaryview);
 182 void summary_init                 (SummaryView          *summaryview);
 183 gboolean summary_show             (SummaryView          *summaryview,
 184                                    FolderItem           *fitem);
 185 void summary_clear_list           (SummaryView          *summaryview);
 186 void summary_clear_all            (SummaryView          *summaryview);
 187
 188 void summary_lock                 (SummaryView          *summaryview);
 189 void summary_unlock               (SummaryView          *summaryview);
 190 void summary_freeze               (SummaryView          *summaryview);
 191 void summary_thaw                 (SummaryView          *summaryview);
 192 void summary_grab_focus           (SummaryView          *summaryview);
 193 GtkWidget *summary_get_main_widget(SummaryView          *summaryview);
 194 gboolean summary_is_locked        (SummaryView          *summaryview);
 195
 196 SummarySelection summary_get_selection_type     (SummaryView    *summaryview);
 197 MsgInfo *summary_get_selected_msg               (SummaryView *summaryview);
 198 GSList *summary_get_selected_msg_list           (SummaryView    *summaryview);
 199
 200 void summary_select_prev_unread   (SummaryView          *summaryview);
 201 void summary_select_next_unread   (SummaryView          *summaryview);
 202 void summary_select_prev_new      (SummaryView          *summaryview);
 203 void summary_select_next_new      (SummaryView          *summaryview);
 204 void summary_select_prev_marked   (SummaryView          *summaryview);
 205 void summary_select_next_marked   (SummaryView          *summaryview);
 206 void summary_select_prev_labeled  (SummaryView          *summaryview);
 207 void summary_select_next_labeled  (SummaryView          *summaryview);
 208 void summary_select_parent        (SummaryView          *summaryview);
 209 void summary_select_by_msgnum     (SummaryView          *summaryview,
 210                                    guint                 msgnum);
 211 void summary_display_by_msgnum    (SummaryView          *summaryview,
 212                                    guint                 msgnum);
 213 void summary_select_by_msg_list   (SummaryView          *summaryview, GSList *msginfos);
 214 guint summary_get_current_msgnum  (SummaryView          *summaryview);
 215 void summary_select_node          (SummaryView          *summaryview,
 216                                    GtkCMCTreeNode               *node,
 217                                    gboolean              display_msg,
 218                                    gboolean              do_refresh);
 219
 220 void summary_expand_threads       (SummaryView          *summaryview);
 221 void summary_collapse_threads     (SummaryView          *summaryview);
 222 void summary_toggle_ignore_thread (SummaryView          *summaryview);
 223 void summary_toggle_watch_thread  (SummaryView          *summaryview);
 224
 225 void summary_filter               (SummaryView          *summaryview,
 226                                    gboolean              selected_only);
 227 void summary_filter_open          (SummaryView *summaryview,
 228                                    PrefsFilterType type,
 229                                    gint processing_rule);
 230 void summary_msginfo_filter_open  (FolderItem * item, MsgInfo *msginfo,
 231                                    PrefsFilterType type, gint processing_rule);
 232
 233 void summary_sort                 (SummaryView          *summaryview,
 234                                    FolderSortKey         sort_key,
 235                                    FolderSortType        sort_type);
 236
 237 void summary_delete               (SummaryView          *summaryview);
 238 void summary_delete_trash         (SummaryView          *summaryview);
 239
 240 void summary_cancel               (SummaryView          *summaryview);
 241
 242 gboolean summary_execute          (SummaryView          *summaryview);
 243 gboolean summary_expunge          (SummaryView          *summaryview);
 244
 245 void summary_attract_by_subject   (SummaryView          *summaryview);
 246
 247 gint summary_write_cache          (SummaryView          *summaryview);
 248
 249 gboolean summary_pass_key_press_event (SummaryView              *summaryview,
 250                                    GdkEventKey          *event);
 251
 252 void summary_display_msg_selected (SummaryView          *summaryview,
 253                                    gboolean              all_headers);
 254 void summary_redisplay_msg        (SummaryView          *summaryview);
 255 void summary_open_msg             (SummaryView          *summaryview);
 256 void summary_open_row             (GtkSCTree *sctree, SummaryView *summaryview);
 257 void summary_view_source          (SummaryView          *summaryview);
 258 void summary_reedit               (SummaryView          *summaryview);
 259 gboolean summary_step             (SummaryView          *summaryview,
 260                                    GtkScrollType         type);
 261 void summary_toggle_view          (SummaryView          *summaryview);
 262 void summary_set_marks_selected   (SummaryView          *summaryview);
 263 guint summary_get_msgnum          (SummaryView          *summaryview,
 264                                    GtkCMCTreeNode               *node);
 265
 266 void summary_move_selected_to     (SummaryView          *summaryview,
 267                                    FolderItem           *to_folder);
 268 void summary_move_to              (SummaryView          *summaryview);
 269 void summary_copy_selected_to     (SummaryView          *summaryview,
 270                                    FolderItem           *to_folder);
 271 GSList *summary_get_selection     (SummaryView          *summaryview);
 272 void summary_copy_to              (SummaryView          *summaryview);
 273 void summary_save_as              (SummaryView          *summaryview);
 274 void summary_print                (SummaryView          *summaryview);
 275 void summary_mark                 (SummaryView          *summaryview);
 276 void summary_unmark               (SummaryView          *summaryview);
 277 void summary_mark_as_unread       (SummaryView          *summaryview);
 278 void summary_mark_as_read         (SummaryView          *summaryview);
 279 void summary_msgs_lock            (SummaryView          *summaryview);
 280 void summary_msgs_unlock          (SummaryView          *summaryview);
 281 void summary_mark_all_read        (SummaryView          *summaryview);
 282 void summary_mark_as_spam         (SummaryView          *summaryview,
 283                                    guint                 action,
 284                                    GtkWidget            *widget);
 285 void summary_ignore_thread        (SummaryView          *summaryview);
 286 void summary_unignore_thread      (SummaryView          *summaryview);
 287 void summary_watch_thread         (SummaryView          *summaryview);
 288 void summary_unwatch_thread       (SummaryView          *summaryview);
 289
 290 void summary_add_address          (SummaryView          *summaryview);
 291 void summary_select_all           (SummaryView          *summaryview);
 292 void summary_unselect_all         (SummaryView          *summaryview);
 293 void summary_select_thread        (SummaryView          *summaryview,
 294                                    gboolean              delete_thread);
 295
 296 void summary_set_colorlabel       (SummaryView          *summaryview,
 297                                    guint                 labelcolor,
 298                                    GtkWidget            *widget);
 299 void summary_set_tag              (SummaryView          *summaryview,
 300                                    gint                  tag_id,
 301                                    GtkWidget            *widget);
 302
 303 void summary_set_column_order     (SummaryView          *summaryview);
 304
 305 void summary_toggle_show_read_messages
 306                                   (SummaryView *summaryview);
 307 void summary_toggle_show_read_threads
 308                                   (SummaryView *summaryview);
 309 void summary_toggle_show_del_messages
 310                                   (SummaryView *summaryview);
 311
 312 void summary_toggle_view_real     (SummaryView  *summaryview);
 313
 314 void summary_reflect_prefs_pixmap_theme
 315                                   (SummaryView *summaryview);
 316 void summary_reflect_prefs_custom_colors(SummaryView *summaryview);
 317 void summary_reflect_tags_changes(SummaryView *summaryview);
 318 void summary_harvest_address      (SummaryView *summaryview);
 319 void summary_set_prefs_from_folderitem
 320                                   (SummaryView *summaryview, FolderItem *item);
 321 void summary_save_prefs_to_folderitem
 322                                   (SummaryView *summaryview, FolderItem *item);
 323 gint summaryview_export_mbox_list (SummaryView *summaryview);
 324 void summaryview_lock(SummaryView *summaryview, FolderItem *item);
 325 void summaryview_unlock(SummaryView *summaryview, FolderItem *item);
 326 void summary_reflect_prefs(void);
 327 void summaryview_activate_quicksearch(SummaryView *summaryview, gboolean show);
 328 void summary_set_menu_sensitive (SummaryView            *summaryview);
 329 void summary_relayout(SummaryView *summaryview);
 330 void summary_update_unread(SummaryView *summaryview, FolderItem *removed_item);
 331 gboolean summary_is_list(SummaryView *summaryview);
 332 gboolean summaryview_search_root_progress(gpointer data, guint at, guint matched, guint total);
 333 #endif /* __SUMMARY_H__ */