src/summaryview.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2007 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 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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_TO,
  46         S_COL_DATE,
  47         S_COL_SIZE,
  48         S_COL_NUMBER,
  49         S_COL_SCORE,
  50         S_COL_LOCKED
  51 } SummaryColumnType;
  52
  53 #define N_SUMMARY_COLS  11
  54
  55 typedef enum
  56 {
  57         SUMMARY_NONE,
  58         SUMMARY_SELECTED_NONE,
  59         SUMMARY_SELECTED_SINGLE,
  60         SUMMARY_SELECTED_MULTIPLE
  61 } SummarySelection;
  62
  63 typedef enum
  64 {
  65         TARGET_MAIL_URI_LIST,
  66         TARGET_DUMMY
  67 } TargetInfo;
  68
  69 #include "mainwindow.h"
  70 #include "folderview.h"
  71 #include "headerview.h"
  72 #include "messageview.h"
  73 #include "compose.h"
  74 #include "folder.h"
  75 #include "gtksctree.h"
  76 #include "prefs_filtering.h"
  77 #include "quicksearch.h"
  78
  79 extern GtkTargetEntry summary_drag_types[2];
  80
  81 struct _SummaryColumnState
  82 {
  83         SummaryColumnType type;
  84         gboolean visible;
  85 };
  86
  87 struct _SummaryView
  88 {
  89         GtkWidget *vbox;
  90         GtkWidget *scrolledwin;
  91         GtkWidget *ctree;
  92         GtkWidget *hbox;
  93         GtkWidget *hbox_l;
  94         GtkWidget *hbox_spc;
  95         GtkWidget *stat_box;
  96         GtkWidget *stat_box2;
  97         GtkWidget *folder_pixmap;
  98         GtkWidget *statlabel_folder;
  99         GtkWidget *statlabel_select;
 100         GtkWidget *statlabel_msgs;
 101         GtkWidget *toggle_eventbox;
 102         GtkWidget *toggle_arrow;
 103         GtkWidget *toggle_search;
 104         GtkWidget *quick_search_pixmap;
 105         GtkWidget *popupmenu;
 106         GtkWidget *colorlabel_menu;
 107
 108         GtkItemFactory *popupfactory;
 109
 110         GtkWidget *window;
 111
 112         GtkCTreeNode *selected;
 113         GtkCTreeNode *displayed;
 114         GtkCTreeNode *last_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         QuickSearch  *quicksearch;
 132
 133         FolderItem *folder_item;
 134
 135         /* summaryview prefs */
 136         gint important_score;
 137         FolderSortKey sort_key;
 138         FolderSortType sort_type;
 139         guint threaded;
 140         guint thread_collapsed;
 141
 142         /* Extra data for summaryview */
 143         regex_t *simplify_subject_preg;
 144
 145         /* current message status */
 146         gint   unreadmarked;
 147         off_t  total_size;
 148         gint   deleted;
 149         gint   moved;
 150         gint   copied;
 151
 152 /*
 153 private:
 154 */
 155         /* table for looking up message-id */
 156         GHashTable *msgid_table;
 157         GHashTable *subject_table;
 158
 159         /* list for moving/deleting messages */
 160         GSList *mlist;
 161         int msginfo_update_callback_id;
 162
 163         /* update folder label when renaming */
 164         gint folder_item_update_callback_id;
 165
 166         GtkTargetList *target_list; /* DnD */
 167 };
 168
 169 SummaryView     *summary_create(void);
 170
 171 void summary_init                 (SummaryView          *summaryview);
 172 gboolean summary_show             (SummaryView          *summaryview,
 173                                    FolderItem           *fitem);
 174 void summary_clear_list           (SummaryView          *summaryview);
 175 void summary_clear_all            (SummaryView          *summaryview);
 176
 177 void summary_lock                 (SummaryView          *summaryview);
 178 void summary_unlock               (SummaryView          *summaryview);
 179 void summary_freeze               (SummaryView          *summaryview);
 180 void summary_thaw                 (SummaryView          *summaryview);
 181 void summary_grab_focus           (SummaryView          *summaryview);
 182 GtkWidget *summary_get_main_widget(SummaryView          *summaryview);
 183 gboolean summary_is_locked        (SummaryView          *summaryview);
 184
 185 SummarySelection summary_get_selection_type     (SummaryView    *summaryview);
 186 MsgInfo *summary_get_selected_msg               (SummaryView *summaryview);
 187 GSList *summary_get_selected_msg_list           (SummaryView    *summaryview);
 188
 189 void summary_select_prev_unread   (SummaryView          *summaryview);
 190 void summary_select_next_unread   (SummaryView          *summaryview);
 191 void summary_select_prev_new      (SummaryView          *summaryview);
 192 void summary_select_next_new      (SummaryView          *summaryview);
 193 void summary_select_prev_marked   (SummaryView          *summaryview);
 194 void summary_select_next_marked   (SummaryView          *summaryview);
 195 void summary_select_prev_labeled  (SummaryView          *summaryview);
 196 void summary_select_next_labeled  (SummaryView          *summaryview);
 197 void summary_select_last_read     (SummaryView          *summaryview);
 198 void summary_select_parent        (SummaryView          *summaryview);
 199 void summary_select_by_msgnum     (SummaryView          *summaryview,
 200                                    guint                 msgnum);
 201 guint summary_get_current_msgnum  (SummaryView          *summaryview);
 202 void summary_select_node          (SummaryView          *summaryview,
 203                                    GtkCTreeNode         *node,
 204                                    gboolean              display_msg,
 205                                    gboolean              do_refresh);
 206
 207 void summary_thread_build         (SummaryView          *summaryview);
 208
 209 void summary_expand_threads       (SummaryView          *summaryview);
 210 void summary_collapse_threads     (SummaryView          *summaryview);
 211 void summary_toggle_ignore_thread (SummaryView          *summaryview);
 212
 213 void summary_filter               (SummaryView          *summaryview,
 214                                    gboolean              selected_only);
 215 void summary_filter_open          (SummaryView *summaryview,
 216                                    PrefsFilterType type,
 217                                    gint processing_rule);
 218 void summary_msginfo_filter_open  (FolderItem * item, MsgInfo *msginfo,
 219                                    PrefsFilterType type, gint processing_rule);
 220
 221 void summary_sort                 (SummaryView          *summaryview,
 222                                    FolderSortKey         sort_key,
 223                                    FolderSortType        sort_type);
 224
 225 void summary_delete               (SummaryView          *summaryview);
 226 void summary_delete_trash         (SummaryView          *summaryview);
 227
 228 void summary_cancel               (SummaryView          *summaryview);
 229
 230 gboolean summary_execute          (SummaryView          *summaryview);
 231
 232 void summary_attract_by_subject   (SummaryView          *summaryview);
 233
 234 gint summary_write_cache          (SummaryView          *summaryview);
 235
 236 gboolean summary_pass_key_press_event (SummaryView              *summaryview,
 237                                    GdkEventKey          *event);
 238
 239 void summary_display_msg_selected (SummaryView          *summaryview,
 240                                    gboolean              all_headers);
 241 void summary_redisplay_msg        (SummaryView          *summaryview);
 242 void summary_open_msg             (SummaryView          *summaryview);
 243 void summary_view_source          (SummaryView          *summaryview);
 244 void summary_reedit               (SummaryView          *summaryview);
 245 gboolean summary_step             (SummaryView          *summaryview,
 246                                    GtkScrollType         type);
 247 void summary_toggle_view          (SummaryView          *summaryview);
 248 void summary_set_marks_selected   (SummaryView          *summaryview);
 249 guint summary_get_msgnum          (SummaryView          *summaryview,
 250                                    GtkCTreeNode         *node);
 251
 252 void summary_move_selected_to     (SummaryView          *summaryview,
 253                                    FolderItem           *to_folder);
 254 void summary_move_to              (SummaryView          *summaryview);
 255 void summary_copy_selected_to     (SummaryView          *summaryview,
 256                                    FolderItem           *to_folder);
 257 GSList *summary_get_selection     (SummaryView          *summaryview);
 258 void summary_copy_to              (SummaryView          *summaryview);
 259 void summary_save_as              (SummaryView          *summaryview);
 260 void summary_print                (SummaryView          *summaryview);
 261 void summary_mark                 (SummaryView          *summaryview);
 262 void summary_unmark               (SummaryView          *summaryview);
 263 void summary_mark_as_unread       (SummaryView          *summaryview);
 264 void summary_mark_as_read         (SummaryView          *summaryview);
 265 void summary_msgs_lock            (SummaryView          *summaryview);
 266 void summary_msgs_unlock          (SummaryView          *summaryview);
 267 void summary_mark_all_read        (SummaryView          *summaryview);
 268 void summary_mark_as_spam         (SummaryView          *summaryview,
 269                                    guint                 action,
 270                                    GtkWidget            *widget);
 271 void summary_ignore_thread        (SummaryView          *summaryview);
 272 void summary_unignore_thread      (SummaryView          *summaryview);
 273
 274 void summary_add_address          (SummaryView          *summaryview);
 275 void summary_select_all           (SummaryView          *summaryview);
 276 void summary_unselect_all         (SummaryView          *summaryview);
 277 void summary_select_thread        (SummaryView          *summaryview,
 278                                    gboolean              delete_thread);
 279
 280 void summary_set_colorlabel       (SummaryView          *summaryview,
 281                                    guint                 labelcolor,
 282                                    GtkWidget            *widget);
 283 void summary_set_colorlabel_color (GtkCTree             *ctree,
 284                                    GtkCTreeNode         *node,
 285                                    guint                 labelcolor);
 286
 287 void summary_set_column_order     (SummaryView          *summaryview);
 288
 289 void summary_toggle_show_read_messages
 290                                   (SummaryView *summaryview);
 291
 292 void summary_toggle_view_real     (SummaryView  *summaryview);
 293
 294 void summary_reflect_prefs_pixmap_theme
 295                                   (SummaryView *summaryview);
 296 void summary_reflect_prefs_custom_colors(SummaryView *summaryview);
 297 void summary_harvest_address      (SummaryView *summaryview);
 298 void summary_set_prefs_from_folderitem
 299                                   (SummaryView *summaryview, FolderItem *item);
 300 void summary_save_prefs_to_folderitem
 301                                   (SummaryView *summaryview, FolderItem *item);
 302 gint summaryview_export_mbox_list (SummaryView *summaryview);
 303 void summaryview_lock(SummaryView *summaryview, FolderItem *item);
 304 void summaryview_unlock(SummaryView *summaryview, FolderItem *item);
 305 void summary_reflect_prefs(void);
 306 void summaryview_activate_quicksearch(SummaryView *summaryview, gboolean show);
 307 void summary_set_menu_sensitive (SummaryView            *summaryview);
 308 void summary_relayout(SummaryView *summaryview);
 309 #endif /* __SUMMARY_H__ */