* improved documentation, fix spuug mistake
[modest] / src / modest-tny-msg-view.h
1 /* modest-tny-msg-view.h */
2 /* insert (c)/licensing information) */
3
4 #ifndef __MODEST_TNY_MSG_VIEW_H__
5 #define __MODEST_TNY_MSG_VIEW_H__
6
7
8 #include <gtk/gtk.h>
9 #include <tny-stream-iface.h>
10 #include <tny-msg-iface.h>
11 #include <tny-msg-mime-part-iface.h>
12
13 G_BEGIN_DECLS
14
15 /* convenience macros */
16 #define MODEST_TYPE_TNY_MSG_VIEW             (modest_tny_msg_view_get_type())
17 #define MODEST_TNY_MSG_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_MSG_VIEW,ModestTnyMsgView))
18 #define MODEST_TNY_MSG_VIEW_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_MSG_VIEW,ModestTnyMsgViewClass))
19 #define MODEST_IS_TNY_MSG_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_MSG_VIEW))
20 #define MODEST_IS_TNY_MSG_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_MSG_VIEW))
21 #define MODEST_TNY_MSG_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_MSG_VIEW,ModestTnyMsgViewClass))
22
23 typedef struct _ModestTnyMsgView      ModestTnyMsgView;
24 typedef struct _ModestTnyMsgViewClass ModestTnyMsgViewClass;
25
26 struct _ModestTnyMsgView {
27         GtkScrolledWindow parent;
28 };
29
30 struct _ModestTnyMsgViewClass {
31         GtkScrolledWindowClass parent_class;
32 };
33
34
35 /**
36  * modest_tny_msg_view_get_type
37  *
38  * get the GType for the this class
39  *
40  * Returns: the GType for this class
41  */
42 GType        modest_tny_msg_view_get_type    (void) G_GNUC_CONST;
43
44
45 /**
46  * modest_tny_msg_view_new 
47  * @tny_msg: a TnyMsgIface instance, or NULL
48  *
49  * create a new ModestTnyMsgView widget (a GtkScrolledWindow subclass),
50  * and display the @tny_msg e-mail message in it. If @tny_msg is NULL,
51  * then a blank page will be displayed
52  *  
53  * Returns: a new ModestTnyMsgView widget, or NULL if there's an error
54  */
55 GtkWidget*   modest_tny_msg_view_new          (TnyMsgIface *tny_msg);
56
57
58 /**
59  * modest_tny_msg_view_set_message
60  * @self: a ModestTnyMsgView instance
61  * @tny_msg: a TnyMsgIface instance, or NULL
62  *
63  * display the @tny_msg e-mail message. If @tny_msg is NULL,
64  * then a blank page will be displayed
65  *  */
66 void         modest_tny_msg_view_set_message  (ModestTnyMsgView *self,
67                                                 TnyMsgIface *tny_msg);
68
69 G_END_DECLS
70
71 #endif /* __MODEST_TNY_MSG_VIEW_H__ */
72