aboutsummaryrefslogtreecommitdiffstats
path: root/mail/e-mail-reader.h
blob: b724d6e19bca242dde446f11fb59bde4839de328 (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
/*
 * e-mail-reader.h
 *
 * 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/>
 *
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef E_MAIL_READER_H
#define E_MAIL_READER_H

/* XXX Anjal uses a different message list widget than Evolution, so
 *     avoid including <mail/message-list.h> in this file.  This makes
 *     the get_message_list() method a little awkward since it returns
 *     a GtkWidget pointer which almost always has to be type casted. */

#include <gtk/gtk.h>
#include <camel/camel-folder.h>
#include <mail/em-format-html-display.h>
#include <shell/e-shell-backend.h>

/* Standard GObject macros */
#define E_TYPE_MAIL_READER \
    (e_mail_reader_get_type ())
#define E_MAIL_READER(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), E_TYPE_MAIL_READER, EMailReader))
#define E_MAIL_READER_IFACE(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), E_TYPE_MAIL_READER, EMailReaderIface))
#define E_IS_MAIL_READER(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), E_TYPE_MAIL_READER))
#define E_IS_MAIL_READER_IFACE(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), E_TYPE_MAIL_READER))
#define E_MAIL_READER_GET_IFACE(obj) \
    (G_TYPE_INSTANCE_GET_INTERFACE \
    ((obj), E_TYPE_MAIL_READER, EMailReaderIface))

/* Basename of the UI definition file. */
#define E_MAIL_READER_UI_DEFINITION "evolution-mail-reader.ui"

G_BEGIN_DECLS

typedef struct _EMailReader EMailReader;
typedef struct _EMailReaderIface EMailReaderIface;

enum {
    E_MAIL_READER_HAVE_ACCOUNT          = 1 << 0,
    E_MAIL_READER_SELECTION_SINGLE          = 1 << 1,
    E_MAIL_READER_SELECTION_MULTIPLE        = 1 << 2,
    E_MAIL_READER_SELECTION_CAN_ADD_SENDER      = 1 << 3,
    E_MAIL_READER_SELECTION_FLAG_CLEAR      = 1 << 4,
    E_MAIL_READER_SELECTION_FLAG_COMPLETED      = 1 << 5,
    E_MAIL_READER_SELECTION_FLAG_FOLLOWUP       = 1 << 6,
    E_MAIL_READER_SELECTION_HAS_DELETED     = 1 << 7,
    E_MAIL_READER_SELECTION_HAS_IMPORTANT       = 1 << 8,
    E_MAIL_READER_SELECTION_HAS_JUNK        = 1 << 9,
    E_MAIL_READER_SELECTION_HAS_NOT_JUNK        = 1 << 10,
    E_MAIL_READER_SELECTION_HAS_READ        = 1 << 11,
    E_MAIL_READER_SELECTION_HAS_UNDELETED       = 1 << 12,
    E_MAIL_READER_SELECTION_HAS_UNIMPORTANT     = 1 << 13,
    E_MAIL_READER_SELECTION_HAS_UNREAD      = 1 << 14,
    E_MAIL_READER_SELECTION_IS_MAILING_LIST     = 1 << 15,
    E_MAIL_READER_FOLDER_IS_JUNK            = 1 << 16
};

struct _EMailReaderIface {
    GTypeInterface parent_iface;

    GtkActionGroup *
            (*get_action_group) (EMailReader *reader);
    gboolean    (*get_hide_deleted) (EMailReader *reader);
    EMFormatHTMLDisplay *
            (*get_html_display) (EMailReader *reader);
    GtkWidget * (*get_message_list) (EMailReader *reader);
    GtkMenu *   (*get_popup_menu)   (EMailReader *reader);
    GPtrArray * (*get_selected_uids)    (EMailReader *reader);
    EShellBackend * (*get_shell_backend)    (EMailReader *reader);
    GtkWindow * (*get_window)       (EMailReader *reader);

    CamelFolder *   (*get_folder)       (EMailReader *reader);
    const gchar *   (*get_folder_uri)   (EMailReader *reader);
    void        (*set_folder)       (EMailReader *reader,
                         CamelFolder *folder,
                         const gchar *folder_uri);
    void        (*set_message)      (EMailReader *reader,
                         const gchar *uid);

    /* Signals */
    void        (*show_search_bar)  (EMailReader *reader);
    void        (*update_actions)   (EMailReader *reader);
};

GType       e_mail_reader_get_type      (void);
void        e_mail_reader_init      (EMailReader *reader);
void        e_mail_reader_changed       (EMailReader *reader);
guint32     e_mail_reader_check_state   (EMailReader *reader);
void        e_mail_reader_update_actions    (EMailReader *reader);
GtkAction * e_mail_reader_get_action    (EMailReader *reader,
                         const gchar *action_name);
GtkActionGroup *
        e_mail_reader_get_action_group  (EMailReader *reader);
gboolean    e_mail_reader_get_hide_deleted  (EMailReader *reader);
EMFormatHTMLDisplay *
        e_mail_reader_get_html_display  (EMailReader *reader);
GtkWidget * e_mail_reader_get_message_list  (EMailReader *reader);
GtkMenu *   e_mail_reader_get_popup_menu    (EMailReader *reader);
GPtrArray * e_mail_reader_get_selected_uids (EMailReader *reader);
EShellBackend * e_mail_reader_get_shell_backend (EMailReader *reader);
GtkWindow * e_mail_reader_get_window    (EMailReader *reader);
CamelFolder *   e_mail_reader_get_folder    (EMailReader *reader);
const gchar *   e_mail_reader_get_folder_uri    (EMailReader *reader);
void        e_mail_reader_set_folder    (EMailReader *reader,
                         CamelFolder *folder,
                         const gchar *folder_uri);
void        e_mail_reader_set_folder_uri    (EMailReader *reader,
                         const gchar *folder_uri);
void        e_mail_reader_set_message   (EMailReader *reader,
                         const gchar *uid);
void        e_mail_reader_create_charset_menu
                        (EMailReader *reader,
                         GtkUIManager *ui_manager,
                         guint merge_id);
void        e_mail_reader_show_search_bar   (EMailReader *reader);

G_END_DECLS

#endif /* E_MAIL_READER_H */