1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
31 /* modest-tny-msg-view.h */
33 #ifndef __MODEST_MSG_VIEW_H__
34 #define __MODEST_MSG_VIEW_H__
37 #include <tny-stream-iface.h>
38 #include <tny-msg-iface.h>
39 #include <tny-mime-part-iface.h>
40 #include <modest-conf.h>
44 /* convenience macros */
45 #define MODEST_TYPE_MSG_VIEW (modest_msg_view_get_type())
46 #define MODEST_MSG_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MSG_VIEW,ModestMsgView))
47 #define MODEST_MSG_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_MSG_VIEW,ModestMsgViewClass))
48 #define MODEST_IS_MSG_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MSG_VIEW))
49 #define MODEST_IS_MSG_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_MSG_VIEW))
50 #define MODEST_MSG_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_MSG_VIEW,ModestMsgViewClass))
52 typedef struct _ModestMsgView ModestMsgView;
53 typedef struct _ModestMsgViewClass ModestMsgViewClass;
55 struct _ModestMsgView {
56 GtkScrolledWindow parent;
59 struct _ModestMsgViewClass {
60 GtkScrolledWindowClass parent_class;
62 void (*link_hover) (ModestMsgView *msgview, const gchar* link,
64 void (*link_clicked) (ModestMsgView *msgview, const gchar* link,
66 void (*attachment_clicked) (ModestMsgView *msgview, int index,
72 * modest_msg_view_get_type
74 * get the GType for the this class
76 * Returns: the GType for this class
78 GType modest_msg_view_get_type (void) G_GNUC_CONST;
83 * @tny_msg: a TnyMsgIface instance, or NULL
85 * create a new ModestMsgView widget (a GtkScrolledWindow subclass),
86 * and display the @tny_msg e-mail message in it. If @tny_msg is NULL,
87 * then a blank page will be displayed
89 * Returns: a new ModestMsgView widget, or NULL if there's an error
91 GtkWidget* modest_msg_view_new (TnyMsgIface *tny_msg);
95 * modest_msg_view_set_message
96 * @self: a ModestMsgView instance
97 * @tny_msg: a TnyMsgIface instance, or NULL
99 * display the @tny_msg e-mail message. If @tny_msg is NULL,
100 * then a blank page will be displayed
102 void modest_msg_view_set_message (ModestMsgView *self, TnyMsgIface *tny_msg);
105 * modest_msg_view_get_selected_text:
106 * @self: a ModestMsgView instance
108 * get the user selected part of the message
110 * Returns: a newly allocated string of the user's selection or NULL if nothing is selected
112 gchar * modest_msg_view_get_selected_text (ModestMsgView *self);
116 #endif /* __MODEST_MSG_VIEW_H__ */