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