src/summaryview.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws 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 *folder_pixmap;
  95         GtkWidget *statlabel_folder;
  96         GtkWidget *statlabel_select;
  97         GtkWidget *statlabel_msgs;
  98         GtkWidget *toggle_eventbox;
  99         GtkWidget *toggle_arrow;
 100         GtkWidget *toggle_search;
 101         GtkWidget *quick_search_pixmap;
 102         GtkWidget *popupmenu;
 103         GtkWidget *colorlabel_menu;
 104
 105         GtkItemFactory *popupfactory;
 106
 107         GtkWidget *window;
 108
 109         GtkCTreeNode *selected;
 110         GtkCTreeNode *displayed;
 111         GtkCTreeNode *last_displayed;
 112
 113         gboolean display_msg;
 114
 115         GdkColor color_important;
 116         SummaryColumnState col_state[N_SUMMARY_COLS];
 117         gint col_pos[N_SUMMARY_COLS];
 118
 119         GdkColor color_marked;
 120         GdkColor color_dim;
 121
 122         guint lock_count;
 123
 124         MainWindow   *mainwin;
 125         FolderView   *folderview;
 126         HeaderView   *headerview;
 127         MessageView  *messageview;
 128         QuickSearch  *quicksearch;
 129
 130         FolderItem *folder_item;
 131
 132         /* summaryview prefs */
 133         gint important_score;
 134         FolderSortKey sort_key;
 135         FolderSortType sort_type;
 136         guint threaded;
 137         guint thread_collapsed;
 138
 139         /* Extra data for summaryview */
 140         regex_t *simplify_subject_preg;
 141
 142         /* current message status */
 143         gint   unreadmarked;
 144         off_t  total_size;
 145         gint   deleted;
 146         gint   moved;
 147         gint   copied;
 148
 149 /*
 150 private:
 151 */
 152         /* table for looking up message-id */
 153         GHashTable *msgid_table;
 154         GHashTable *subject_table;
 155
 156         /* list for moving/deleting messages */
 157         GSList *mlist;
 158         int msginfo_update_callback_id;
 159
 160         GtkTargetList *target_list; /* DnD */
 161 };
 162
 163 SummaryView     *summary_create(void);
 164
 165 void summary_init                 (SummaryView          *summaryview);
 166 gboolean summary_show             (SummaryView          *summaryview,
 167                                    FolderItem           *fitem);
 168 void summary_clear_list           (SummaryView          *summaryview);
 169 void summary_clear_all            (SummaryView          *summaryview);
 170
 171 void summary_lock                 (SummaryView          *summaryview);
 172 void summary_unlock               (SummaryView          *summaryview);
 173 gboolean summary_is_locked        (SummaryView          *summaryview);
 174
 175 SummarySelection summary_get_selection_type     (SummaryView    *summaryview);
 176 MsgInfo *summary_get_selected_msg               (SummaryView *summaryview);
 177 GSList *summary_get_selected_msg_list           (SummaryView    *summaryview);
 178
 179 void summary_select_prev_unread   (SummaryView          *summaryview);
 180 void summary_select_next_unread   (SummaryView          *summaryview);
 181 void summary_select_prev_new      (SummaryView          *summaryview);
 182 void summary_select_next_new      (SummaryView          *summaryview);
 183 void summary_select_prev_marked   (SummaryView          *summaryview);
 184 void summary_select_next_marked   (SummaryView          *summaryview);
 185 void summary_select_prev_labeled  (SummaryView          *summaryview);
 186 void summary_select_next_labeled  (SummaryView          *summaryview);
 187 void summary_select_last_read     (SummaryView          *summaryview);
 188 void summary_select_parent        (SummaryView          *summaryview);
 189 void summary_select_by_msgnum     (SummaryView          *summaryview,
 190                                    guint                 msgnum);
 191 guint summary_get_current_msgnum  (SummaryView          *summaryview);
 192 void summary_select_node          (SummaryView          *summaryview,
 193                                    GtkCTreeNode         *node,
 194                                    gboolean              display_msg,
 195                                    gboolean              do_refresh);
 196
 197 void summary_thread_build         (SummaryView          *summaryview);
 198
 199 void summary_expand_threads       (SummaryView          *summaryview);
 200 void summary_collapse_threads     (SummaryView          *summaryview);
 201 void summary_toggle_ignore_thread (SummaryView          *summaryview);
 202
 203 void summary_filter               (SummaryView          *summaryview,
 204                                    gboolean              selected_only);
 205 void summary_filter_open          (SummaryView *summaryview,
 206                                    PrefsFilterType type,
 207                                    gint processing_rule);
 208 void summary_msginfo_filter_open  (FolderItem * item, MsgInfo *msginfo,
 209                                    PrefsFilterType type, gint processing_rule);
 210
 211 void summary_sort                 (SummaryView          *summaryview,
 212                                    FolderSortKey         sort_key,
 213                                    FolderSortType        sort_type);
 214
 215 void summary_delete               (SummaryView          *summaryview);
 216 void summary_delete_trash         (SummaryView          *summaryview);
 217
 218 void summary_cancel               (SummaryView          *summaryview);
 219
 220 gboolean summary_execute          (SummaryView          *summaryview);
 221
 222 void summary_attract_by_subject   (SummaryView          *summaryview);
 223
 224 gint summary_write_cache          (SummaryView          *summaryview);
 225
 226 gboolean summary_pass_key_press_event (SummaryView              *summaryview,
 227                                    GdkEventKey          *event);
 228
 229 void summary_display_msg_selected (SummaryView          *summaryview,
 230                                    gboolean              all_headers);
 231 void summary_redisplay_msg        (SummaryView          *summaryview);
 232 void summary_open_msg             (SummaryView          *summaryview);
 233 void summary_view_source          (SummaryView          *summaryview);
 234 void summary_reedit               (SummaryView          *summaryview);
 235 gboolean summary_step             (SummaryView          *summaryview,
 236                                    GtkScrollType         type);
 237 void summary_toggle_view          (SummaryView          *summaryview);
 238 void summary_set_marks_selected   (SummaryView          *summaryview);
 239 guint summary_get_msgnum          (SummaryView          *summaryview,
 240                                    GtkCTreeNode         *node);
 241
 242 void summary_move_selected_to     (SummaryView          *summaryview,
 243                                    FolderItem           *to_folder);
 244 void summary_move_to              (SummaryView          *summaryview);
 245 void summary_copy_selected_to     (SummaryView          *summaryview,
 246                                    FolderItem           *to_folder);
 247 GSList *summary_get_selection     (SummaryView          *summaryview);
 248 void summary_copy_to              (SummaryView          *summaryview);
 249 void summary_save_as              (SummaryView          *summaryview);
 250 void summary_print                (SummaryView          *summaryview);
 251 void summary_mark                 (SummaryView          *summaryview);
 252 void summary_unmark               (SummaryView          *summaryview);
 253 void summary_mark_as_unread       (SummaryView          *summaryview);
 254 void summary_mark_as_read         (SummaryView          *summaryview);
 255 void summary_msgs_lock            (SummaryView          *summaryview);
 256 void summary_msgs_unlock          (SummaryView          *summaryview);
 257 void summary_mark_all_read        (SummaryView          *summaryview);
 258 void summary_mark_as_spam         (SummaryView          *summaryview,
 259                                    guint                 action,
 260                                    GtkWidget            *widget);
 261 void summary_add_address          (SummaryView          *summaryview);
 262 void summary_select_all           (SummaryView          *summaryview);
 263 void summary_unselect_all         (SummaryView          *summaryview);
 264 void summary_select_thread        (SummaryView          *summaryview);
 265
 266 void summary_set_colorlabel       (SummaryView          *summaryview,
 267                                    guint                 labelcolor,
 268                                    GtkWidget            *widget);
 269 void summary_set_colorlabel_color (GtkCTree             *ctree,
 270                                    GtkCTreeNode         *node,
 271                                    guint                 labelcolor);
 272
 273 void summary_set_column_order     (SummaryView          *summaryview);
 274
 275 void summary_toggle_show_read_messages
 276                                   (SummaryView *summaryview);
 277
 278 void summary_toggle_view_real     (SummaryView  *summaryview);
 279
 280 void summary_reflect_prefs_pixmap_theme
 281                                   (SummaryView *summaryview);
 282 void summary_reflect_prefs_custom_colors(SummaryView *summaryview);
 283 void summary_harvest_address      (SummaryView *summaryview);
 284 void summary_set_prefs_from_folderitem
 285                                   (SummaryView *summaryview, FolderItem *item);
 286 void summary_save_prefs_to_folderitem
 287                                   (SummaryView *summaryview, FolderItem *item);
 288 gint summaryview_export_mbox_list (SummaryView *summaryview);
 289 void summaryview_lock(SummaryView *summaryview, FolderItem *item);
 290 void summaryview_unlock(SummaryView *summaryview, FolderItem *item);
 291 void summary_reflect_prefs(void);
 292 void summaryview_activate_quicksearch(SummaryView *summaryview);
 293 void summary_set_menu_sensitive (SummaryView            *summaryview);
 294 #endif /* __SUMMARY_H__ */