Modified webpage: now tinymail repository is in gitorious.
[modest] / src / widgets / modest-msg-view.h
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __MODEST_MSG_VIEW_H__
31 #define __MODEST_MSG_VIEW_H__
32
33 #include <tny-stream.h>
34 #include <tny-msg.h>
35 #include <tny-mime-part.h>
36 #include <tny-msg-view.h>
37 #include <tny-header-view.h>
38 #include <widgets/modest-recpt-view.h>
39 #include <widgets/modest-zoomable.h>
40 #include <widgets/modest-isearch-view.h>
41 #include <widgets/modest-mime-part-view.h>
42
43 G_BEGIN_DECLS
44
45 /* convenience macros */
46 #define MODEST_TYPE_MSG_VIEW             (modest_msg_view_get_type())
47 #define MODEST_MSG_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_VIEW,ModestMsgView))
48 #define MODEST_IS_MSG_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_VIEW))
49 #define MODEST_MSG_VIEW_GET_IFACE(obj)   (G_TYPE_INSTANCE_GET_INTERFACE((obj),MODEST_TYPE_MSG_VIEW,ModestMsgViewIface))
50
51 typedef struct _ModestMsgView      ModestMsgView;
52 typedef struct _ModestMsgViewIface ModestMsgViewIface;
53
54 struct _ModestMsgViewIface {
55         GTypeInterface parent;
56
57         void (*set_msg_with_other_body_func) (ModestMsgView *self, TnyMsg *msg, TnyMimePart *other_body);
58         GtkAdjustment* (*get_vadjustment_func) (ModestMsgView *self);
59         GtkAdjustment* (*get_hadjustment_func) (ModestMsgView *self);
60         void (*set_vadjustment_func) (ModestMsgView *self, GtkAdjustment *vadj);
61         void (*set_hadjustment_func) (ModestMsgView *self, GtkAdjustment *vadj);
62         void (*set_shadow_type_func) (ModestMsgView *self, GtkShadowType type);
63         GtkShadowType (*get_shadow_type_func) (ModestMsgView *self);
64         TnyHeaderFlags (*get_priority_func) (ModestMsgView *self);
65         void (*set_priority_func) (ModestMsgView *self, TnyHeaderFlags flags);
66         void (*set_view_images_func) (ModestMsgView *self, gboolean view_images);
67         TnyList * (*get_selected_attachments_func) (ModestMsgView *self);
68         TnyList * (*get_attachments_func) (ModestMsgView *self);
69         void (*grab_focus_func) (ModestMsgView *self);
70         void (*remove_attachment_func) (ModestMsgView *view, TnyMimePart *attachment);
71         void (*set_branding_func) (ModestMsgView *view, const gchar *brand_name, const GdkPixbuf *brand_icon);
72
73         /* signals */
74         void (*set_scroll_adjustments)      (ModestMsgView *msg_view,
75                                              GtkAdjustment *hadj,
76                                              GtkAdjustment *vadj);
77         
78         void (*link_contextual)    (ModestMsgView *msgview, const gchar* link,
79                                     gpointer user_data);
80         void (*attachment_clicked) (ModestMsgView *msgview, TnyMimePart *mime_part,
81                                     gpointer user_data);
82         void (*recpt_activated)    (ModestMsgView *msgview, const gchar *address,
83                                     gpointer user_data);
84         gboolean (*fetch_image)    (ModestMsgView *msgview, const gchar *uri,
85                                     TnyStream *stream);
86         void (*show_details)       (ModestMsgView *msgview, gpointer userdata);
87
88         void (*request_fetch_images_func) (ModestMsgView *msgview);
89         gboolean (*has_blocked_external_images_func) (ModestMsgView *msgview);
90         void (*limit_error)        (ModestMsgView *msgview);
91         gboolean (*handle_calendar)    (ModestMsgView *msgview, TnyMimePart *calendar_part, GtkContainer *container);
92 };
93
94
95 /**
96  *
97  * modest_msg_view_get_type
98  *
99  * get the GType for the this interface
100  *
101  * Returns: the GType for this interface
102  */
103 GType        modest_msg_view_get_type    (void) G_GNUC_CONST;
104
105 void modest_msg_view_set_msg_with_other_body (ModestMsgView *self, TnyMsg *msg, TnyMimePart *part);
106 GtkAdjustment *modest_msg_view_get_vadjustment (ModestMsgView *self);
107 GtkAdjustment *modest_msg_view_get_hadjustment (ModestMsgView *self);
108 void modest_msg_view_set_vadjustment (ModestMsgView *self, GtkAdjustment *vadj);
109 void modest_msg_view_set_hadjustment (ModestMsgView *self, GtkAdjustment *hadj);
110 void modest_msg_view_set_shadow_type (ModestMsgView *self, GtkShadowType type);
111 GtkShadowType modest_msg_view_get_shadow_type (ModestMsgView *self);
112
113 TnyHeaderFlags modest_msg_view_get_priority (ModestMsgView *self);
114 void modest_msg_view_set_priority (ModestMsgView *self, TnyHeaderFlags flags);
115 TnyList *modest_msg_view_get_selected_attachments (ModestMsgView *self);
116 TnyList *modest_msg_view_get_attachments (ModestMsgView *self);
117 void modest_msg_view_grab_focus (ModestMsgView *self);
118 void modest_msg_view_remove_attachment (ModestMsgView *view, TnyMimePart *attachment);
119 void modest_msg_view_set_branding (ModestMsgView *view, const gchar *brand_name, const GdkPixbuf *brand_icon);
120 void modest_msg_view_set_view_images (ModestMsgView *view, gboolean view_images);
121 void modest_msg_view_request_fetch_images (ModestMsgView *view);
122 gboolean modest_msg_view_has_blocked_external_images (ModestMsgView *view);
123
124
125 G_END_DECLS
126
127 #endif /* __MODEST_MSG_VIEW_H__ */