Refactoring of mail header view.
[modest] / src / widgets / modest-mail-header-view.h
1 /* Copyright (c) 2008, 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_MAIL_HEADER_VIEW_H__
31 #define __MODEST_MAIL_HEADER_VIEW_H__
32
33 #include <tny-header-view.h>
34 #include <gtk/gtkwidget.h>
35
36 G_BEGIN_DECLS
37
38 /* convenience macros */
39 #define MODEST_TYPE_MAIL_HEADER_VIEW             (modest_mail_header_view_get_type())
40 #define MODEST_MAIL_HEADER_VIEW(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_MAIL_HEADER_VIEW,ModestMailHeaderView))
41 #define MODEST_IS_MAIL_HEADER_VIEW(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_MAIL_HEADER_VIEW))
42 #define MODEST_MAIL_HEADER_VIEW_GET_IFACE(obj)   (G_TYPE_INSTANCE_GET_INTERFACE((obj),MODEST_TYPE_MAIL_HEADER_VIEW,ModestMailHeaderViewIface))
43
44 typedef struct _ModestMailHeaderView      ModestMailHeaderView;
45 typedef struct _ModestMailHeaderViewIface ModestMailHeaderViewIface;
46
47 struct _ModestMailHeaderViewIface {
48         GTypeInterface parent;
49
50         TnyHeaderFlags (*get_priority) (ModestMailHeaderView *self);
51         void (*set_priority) (ModestMailHeaderView *self, TnyHeaderFlags flags);
52         const GtkWidget *(*add_custom_header) (ModestMailHeaderView *self,
53                                                const gchar *label,
54                                                GtkWidget *custom_widget,
55                                                gboolean with_expander,
56                                                gboolean start);
57         
58         /* signals */
59         void (*show_details) (ModestMailHeaderView *msgview,
60                               gpointer user_data);
61         void (*recpt_activated)    (ModestMailHeaderView *msgview, const gchar *address,
62                                     gpointer user_data);
63 };
64
65
66 /**
67  *
68  * modest_mail_header_view_get_type
69  *
70  * get the GType for the this interface
71  *
72  * Returns: the GType for this interface
73  */
74 GType        modest_mail_header_view_get_type    (void) G_GNUC_CONST;
75
76 TnyHeaderFlags modest_mail_header_view_get_priority (ModestMailHeaderView *self);
77 void modest_mail_header_view_set_priority (ModestMailHeaderView *self, TnyHeaderFlags flags);
78 const GtkWidget *modest_mail_header_view_add_custom_header (ModestMailHeaderView *header_view,
79                                                             const gchar *label,
80                                                             GtkWidget *custom_widget,
81                                                             gboolean with_expander,
82                                                             gboolean start);
83
84
85 G_END_DECLS
86
87 #endif /* __MODEST_MAIL_HEADER_VIEW_H__ */