aboutsummaryrefslogtreecommitdiffstats
path: root/mail/em-folder-view.h
blob: 02d6583c0b7b5e1304838e1117a8c810959d451e (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
/*
 * 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:
 *      Michael Zucchi <notzed@ximian.com>
 *
 * Copyright (C) 1999-2008 Novell, Inc. (www.novell.com)
 *
 */

#ifndef EM_FOLDER_VIEW_H
#define EM_FOLDER_VIEW_H

#include <gtk/gtk.h>
#include "mail/em-popup.h"
#include "message-list.h"

/* Standard GObject macros */
#define EM_TYPE_FOLDER_VIEW \
    (em_folder_view_get_type ())
#define EM_FOLDER_VIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_CAST \
    ((obj), EM_TYPE_FOLDER_VIEW, EMFolderView))
#define EM_FOLDER_VIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_CAST \
    ((cls), EM_TYPE_FOLDER_VIEW, EMFolderViewClass))
#define EM_IS_FOLDER_VIEW(obj) \
    (G_TYPE_CHECK_INSTANCE_TYPE \
    ((obj), EM_TYPE_FOLDER_VIEW))
#define EM_IS_FOLDER_VIEW_CLASS(cls) \
    (G_TYPE_CHECK_CLASS_TYPE \
    ((cls), EM_TYPE_FOLDER_VIEW))
#define EM_FOLDER_VIEW_GET_CLASS(obj) \
    (G_TYPE_INSTANCE_GET_CLASS \
    ((obj), EM_TYPE_FOLDER_VIEW, EMFolderViewClass))

G_BEGIN_DECLS

struct _EMFormatHTMLDisplay;
struct _CamelFolder;
struct _CamelMedium;

typedef struct _EMFolderView EMFolderView;
typedef struct _EMFolderViewClass EMFolderViewClass;

typedef struct _EMFolderViewEnable EMFolderViewEnable;

enum {
    EM_FOLDER_VIEW_SELECT_THREADED = EM_POPUP_SELECT_LAST,
    EM_FOLDER_VIEW_SELECT_HIDDEN = EM_POPUP_SELECT_LAST<<1,
    EM_FOLDER_VIEW_SELECT_NEXT_MSG = EM_POPUP_SELECT_LAST<<2,
    EM_FOLDER_VIEW_SELECT_PREV_MSG = EM_POPUP_SELECT_LAST<<3,
    EM_FOLDER_VIEW_SELECT_LISTONLY = EM_POPUP_SELECT_LAST<<4,
    EM_FOLDER_VIEW_SELECT_DISPLAY = EM_POPUP_SELECT_LAST<<5,
    EM_FOLDER_VIEW_SELECT_SELECTION = EM_POPUP_SELECT_LAST<<6,
    EM_FOLDER_VIEW_SELECT_NOSELECTION = EM_POPUP_SELECT_LAST<<7,
    EM_FOLDER_VIEW_PREVIEW_PRESENT = EM_POPUP_SELECT_LAST<<8,
    EM_FOLDER_VIEW_SELECT_LAST = EM_POPUP_SELECT_LAST<<9,
};

struct _EMFolderViewEnable {
    const char *name;   /* bonobo name, relative to /commands/ */
    guint32 mask;       /* disable mask, see EM_FOLDER_VIEW_CAN* flags */
};

struct _EMFolderView {
    GtkVBox parent;

    struct _EMFolderViewPrivate *priv;

    MessageList *list;

    struct _EMFormatHTMLDisplay *preview;

    struct _CamelFolder *folder;
    char *folder_uri;

    char *displayed_uid;    /* only used to stop re-loads, don't use it to represent any selection state */

    /* used to load ui from base activate implementation */
    GSList *ui_files;   /* const char * list, TODO: should this be on class? */
    const char *ui_app_name;

    /* used to manage some menus, particularly plugins */
    struct _EMMenu *menu;

    /* for proxying jobs to main or other threads */
    struct _MailAsyncEvent *async;

    struct _BonoboUIComponent *uic; /* if we're active, this will be set */
    GSList *enable_map; /* bonobo menu enable map, entries are 0-terminated EMFolderViewEnable arryas
                   TODO: should this be on class? */

    int mark_seen_timeout;  /* local copy of gconf stuff */
    guint mark_seen:1;
    guint preview_active:1; /* is preview being used */
    guint statusbar_active:1; /* should we manage the statusbar messages ourselves? */
    guint hide_deleted:1;
    guint list_active:1;    /* we actually showing the list? */
};

struct _EMFolderViewClass {
    GtkVBoxClass parent_class;

    /* behaviour definition */
    guint update_message_style:1;

    /* if used as a control, used to activate/deactivate custom menu's */
    void (*activate)(EMFolderView *, struct _BonoboUIComponent *uic, int state);

    void (*set_folder_uri)(EMFolderView *emfv, const char *uri);
    void (*set_folder)(EMFolderView *emfv, struct _CamelFolder *folder, const char *uri);
    void (*set_message)(EMFolderView *emfv, const char *uid, int nomarkseen);

    /* Signals */
    void (*on_url)(EMFolderView *emfv, const char *uri, const char *nice_uri);

    void (*loaded)(EMFolderView *emfv);
    void (*changed)(EMFolderView *emfv);
};

GType em_folder_view_get_type(void);

GtkWidget *em_folder_view_new(void);

#define em_folder_view_activate(emfv, uic, state) EM_FOLDER_VIEW_GET_CLASS (emfv)->activate((emfv), (uic), (state))
#define em_folder_view_set_folder(emfv, folder, uri) EM_FOLDER_VIEW_GET_CLASS (emfv)->set_folder((emfv), (folder), (uri))
#define em_folder_view_set_folder_uri(emfv, uri) EM_FOLDER_VIEW_GET_CLASS (emfv)->set_folder_uri((emfv), (uri))
#define em_folder_view_set_message(emfv, uid, nomarkseen) EM_FOLDER_VIEW_GET_CLASS (emfv)->set_message((emfv), (uid), (nomarkseen))

void em_folder_view_select_next_message(EMFolderView *emfv, int count, gboolean always_can_previous);
void em_folder_view_message_reply(EMFolderView *emfv, int mode);

EMPopupTargetSelect *em_folder_view_get_popup_target(EMFolderView *emfv, EMPopup *emp, int on_display);

int em_folder_view_mark_selected(EMFolderView *emfv, guint32 mask, guint32 set);
int em_folder_view_open_selected(EMFolderView *emfv);

int em_folder_view_print(EMFolderView *emfv, GtkPrintOperationAction action);

/* this could be on message-list */
guint32 em_folder_view_disable_mask(EMFolderView *emfv);

void em_folder_view_set_statusbar(EMFolderView *emfv, gboolean statusbar);
void em_folder_view_set_hide_deleted(EMFolderView *emfv, gboolean status);
void em_folder_view_setup_view_instance (EMFolderView *emfv);

G_END_DECLS

#endif /* EM_FOLDER_VIEW_H */