aboutsummaryrefslogtreecommitdiffstats
path: root/mail/message-list.h
blob: 187b22f4a340617e3d1cb82fc05022b82130e27f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with the program; if not, see <http://www.gnu.org/licenses/>
 *
 *
 * Authors:
 *      Jeffrey Stedfast <fejj@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef _MESSAGE_LIST_H_
#define _MESSAGE_LIST_H_

#include <gtk/gtk.h>
#include <camel/camel.h>

#include <e-util/e-util.h>
#include <libemail-engine/e-mail-session.h>

/* Standard GObject macros */
#define MESSAGE_LIST_TYPE \
    (message_list_get_type ())
#define MESSAGE_LIST(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), MESSAGE_LIST_TYPE, MessageList))
#define MESSAGE_LIST_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), MESSAGE_LIST_TYPE, MessageListClass))
#define IS_MESSAGE_LIST(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), MESSAGE_LIST_TYPE))
#define IS_MESSAGE_LIST_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), MESSAGE_LIST_TYPE))
#define MESSAGE_LIST_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), MESSAGE_LIST_TYPE, MessageListClass))

G_BEGIN_DECLS

enum {
    COL_MESSAGE_STATUS,
    COL_FLAGGED,
    COL_SCORE,
    COL_ATTACHMENT,
    COL_FROM,
    COL_SUBJECT,
    COL_SENT,
    COL_RECEIVED,
    COL_TO,
    COL_SIZE,
    COL_FOLLOWUP_FLAG_STATUS,
    COL_FOLLOWUP_FLAG,
    COL_FOLLOWUP_DUE_BY,
    COL_LOCATION,       /* vfolder location? */
    COL_SENDER,
    COL_RECIPIENTS,
    COL_MIXED_SENDER,
    COL_MIXED_RECIPIENTS,
    COL_LABELS,

    /* subject with junk removed */
    COL_SUBJECT_TRIMMED,

    /* normalised strings */
    COL_FROM_NORM,
    COL_SUBJECT_NORM,
    COL_TO_NORM,

    COL_LAST,

    /* Invisible columns */
    COL_DELETED,
    COL_UNREAD,
    COL_COLOUR
};

#define MESSAGE_LIST_COLUMN_IS_ACTIVE(col) (col == COL_MESSAGE_STATUS || \
                        col == COL_FLAGGED)

typedef struct _MessageList MessageList;
typedef struct _MessageListClass MessageListClass;
typedef struct _MessageListPrivate MessageListPrivate;

struct _MessageList {
    ETree parent;

    MessageListPrivate *priv;

    /* The table */
    ETableExtras *extras;

    GHashTable *uid_nodemap; /* uid (from info) -> tree node mapping */

    GHashTable *normalised_hash;

    /* Current search string, or %NULL */
    gchar *search;

    /* are we regenerating the message_list because set_folder
     * was just called? */
    guint just_set_folder : 1;

    guint expand_all :1;
    guint collapse_all :1;

    /* frozen count */
    guint frozen : 16;

    /* Where the ETree cursor is. */
    gchar *cursor_uid;

    /* whether the last selection was on a single row or none/multi */
    gboolean last_sel_single;

    /* Row-selection and seen-marking timers */
    guint idle_id, seen_id;

    gchar *frozen_search;   /* to save search took place while we were frozen */

    /* the current camel folder thread tree, if any */
    CamelFolderThread *thread_tree;
};

struct _MessageListClass {
    ETreeClass parent_class;

    /* signals - select a message */
    void (*message_selected) (MessageList *message_list, const gchar *uid);
    void (*message_list_built) (MessageList *message_list);
    void (*message_list_scrolled) (MessageList *message_list);
};

typedef enum {
    MESSAGE_LIST_SELECT_NEXT = 0,
    MESSAGE_LIST_SELECT_PREVIOUS = 1,
    MESSAGE_LIST_SELECT_DIRECTION = 1, /* direction mask */
    MESSAGE_LIST_SELECT_WRAP = 1<<1 /* option bit */
} MessageListSelectDirection;

GType       message_list_get_type       (void);
GtkWidget * message_list_new        (EMailSession *session);
EMailSession *  message_list_get_session    (MessageList *message_list);
CamelFolder *   message_list_ref_folder     (MessageList *message_list);
void        message_list_set_folder     (MessageList *message_list,
                         CamelFolder *folder);
GtkTargetList * message_list_get_copy_target_list
                        (MessageList *message_list);
GtkTargetList * message_list_get_paste_target_list
                        (MessageList *message_list);
void        message_list_set_expanded_default
                        (MessageList *message_list,
                         gboolean expanded_default);
gboolean    message_list_get_group_by_threads
                        (MessageList *message_list);
void        message_list_set_group_by_threads
                        (MessageList *message_list,
                         gboolean group_by_threads);
gboolean    message_list_get_show_deleted   (MessageList *message_list);
void        message_list_set_show_deleted   (MessageList *message_list,
                         gboolean show_deleted);
gboolean    message_list_get_thread_latest  (MessageList *message_list);
void        message_list_set_thread_latest  (MessageList *message_list,
                         gboolean thread_latest);
gboolean    message_list_get_thread_subject (MessageList *message_list);
void        message_list_set_thread_subject (MessageList *message_list,
                         gboolean thread_subject);
void        message_list_freeze     (MessageList *message_list);
void        message_list_thaw       (MessageList *message_list);
GPtrArray * message_list_get_selected   (MessageList *message_list);
void        message_list_set_selected   (MessageList *message_list,
                         GPtrArray *uids);
gboolean    message_list_select     (MessageList *message_list,
                         MessageListSelectDirection direction,
                         guint32 flags,
                         guint32 mask);
gboolean    message_list_can_select     (MessageList *message_list,
                         MessageListSelectDirection direction,
                         guint32 flags,
                         guint32 mask);
void        message_list_select_uid     (MessageList *message_list,
                         const gchar *uid,
                         gboolean with_fallback);
void        message_list_select_next_thread (MessageList *message_list);
void        message_list_select_prev_thread (MessageList *message_list);
void        message_list_select_all     (MessageList *message_list);
void        message_list_select_thread  (MessageList *message_list);
void        message_list_select_subthread   (MessageList *message_list);
void        message_list_copy       (MessageList *message_list,
                         gboolean cut);
void        message_list_paste      (MessageList *message_list);
guint       message_list_count      (MessageList *message_list);
guint       message_list_selected_count (MessageList *message_list);
void        message_list_set_threaded_expand_all
                        (MessageList *message_list);
void        message_list_set_threaded_collapse_all
                        (MessageList *message_list);
void        message_list_set_search     (MessageList *message_list,
                         const gchar *search);
void        message_list_save_state     (MessageList *message_list);

void        message_list_sort_uids      (MessageList *message_list,
                         GPtrArray *uids);

G_END_DECLS

#endif /* _MESSAGE_LIST_H_ */