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.
30 #ifndef __MODEST_HEADER_VIEW_H__
31 #define __MODEST_HEADER_VIEW_H__
33 #include <tny-folder.h>
34 #include <tny-gtk-account-list-model.h>
36 #include <tny-header.h>
37 #include <tny-gtk-header-list-model.h>
41 /* convenience macros */
42 #define MODEST_TYPE_HEADER_VIEW (modest_header_view_get_type())
43 #define MODEST_HEADER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderView))
44 #define MODEST_HEADER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
45 #define MODEST_IS_HEADER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_HEADER_VIEW))
46 #define MODEST_IS_HEADER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_HEADER_VIEW))
47 #define MODEST_HEADER_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
49 typedef struct _ModestHeaderView ModestHeaderView;
50 typedef struct _ModestHeaderViewClass ModestHeaderViewClass;
52 struct _ModestHeaderView {
54 /* insert public members, if any */
57 #define MODEST_HEADER_VIEW_COLUMN "header-view-column"
59 typedef enum _ModestHeaderViewColumn {
60 MODEST_HEADER_VIEW_COLUMN_FROM = 0,
61 MODEST_HEADER_VIEW_COLUMN_TO,
62 MODEST_HEADER_VIEW_COLUMN_SUBJECT,
63 MODEST_HEADER_VIEW_COLUMN_SENT_DATE,
64 MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE,
65 MODEST_HEADER_VIEW_COLUMN_MSGTYPE,
66 MODEST_HEADER_VIEW_COLUMN_ATTACH,
67 MODEST_HEADER_VIEW_COLUMN_SIZE,
69 * these two are for compact display on small devices,
70 * with two line display with all relevant headers
72 MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN, /* incoming mail */
73 MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT, /* outgoing mail */
75 MODEST_HEADER_VIEW_COLUMN_NUM
77 } ModestHeaderViewColumn;
80 * this can be extended with more style thingies,
81 * to make a small-device specific display
83 typedef enum _ModestHeaderViewStyle {
84 MODEST_HEADER_VIEW_STYLE_DETAILS, /* many columns, single line, col headers visible */
85 MODEST_HEADER_VIEW_STYLE_TWOLINES, /* two-line headers, col headers invisible */
87 MODEST_HEADER_VIEW_STYLE_NUM
88 } ModestHeaderViewStyle;
90 typedef enum _ModestItemType {
91 MODEST_ITEM_TYPE_MESSAGE,
92 MODEST_ITEM_TYPE_FOLDER,
97 struct _ModestHeaderViewClass {
98 GtkTreeViewClass parent_class;
100 void (*header_selected) (ModestHeaderView* self,
104 void (*item_not_found) (ModestHeaderView* self,
108 void (*header_activated) (ModestHeaderView* self,
112 /* msg == NULL implies that the operation is finished, ie.
113 * the progress indictation can be hidden */
114 void (*status_update) (ModestHeaderView* self,
116 gint num, gint total,
121 * modest_header_view_get_type:
123 * get the GType for ModestHeaderView
127 GType modest_header_view_get_type (void) G_GNUC_CONST;
131 * modest_header_view_new:
132 * @folder: a TnyMsgFolder object
133 * @style: a ModestHeaderViewColumn with the style of this listview
134 * ( MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
136 * create a new ModestHeaderView instance, based on a folder iface
138 * Returns: a new GtkWidget (a GtkTreeView-subclass)
140 GtkWidget* modest_header_view_new (TnyFolder *folder,
141 ModestHeaderViewStyle style);
144 * modest_header_view_set_folder:
145 * @self: a ModestHeaderView instance
146 * @folder: a TnyFolder object
148 * set the folder for this ModestHeaderView
150 void modest_header_view_set_folder (ModestHeaderView *self,
154 * modest_header_view_get_folder:
155 * @self: a ModestHeaderView instance
157 * get the folder in this ModestHeaderView
159 * Returns: the tny folder instance or NULL if there is none
161 TnyFolder *modest_header_view_get_folder (ModestHeaderView *self);
165 * modest_header_view_set_columns:
166 * @self: a ModestHeaderView instance
167 * @columns: a list of ModestHeaderViewColumn
169 * set the columns for this ModestHeaderView.
171 * Returns: TRUE if it succeeded, FALSE otherwise
173 gboolean modest_header_view_set_columns (ModestHeaderView *self,
174 const GList *columns);
176 * modest_header_view_get_columns:
177 * @self: a ModestHeaderView instance
179 * get the GtkTreeColumns for this ModestHeaderView. Each one of the
180 * tree columns will have property than can be retrieved
181 * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define),
182 * and which contains the corresponding ModestHeaderViewColumn
184 * Returns: newly allocated list of column ids, or NULL in case of no columns or error
185 * You must free the list with g_list_free
187 GList* modest_header_view_get_columns (ModestHeaderView *self);
191 * modest_header_view_set_style:
192 * @self: a ModestHeaderView instance
193 * @style: the style for this tree view
195 * set the style for this ModestHeaderView
197 * Returns: TRUE if it succeeded, FALSE otherwise
199 gboolean modest_header_view_set_style (ModestHeaderView *self,
200 ModestHeaderViewStyle style);
203 * modest_header_view_set_folder:
204 * @self: a ModestHeaderView instance
206 * get the style for this ModestHeaderView
208 * Returns: the current style
210 ModestHeaderViewStyle modest_header_view_get_style (ModestHeaderView *self);
213 * modest_header_view_get_selected_headers:
214 * @self: a ModestHeaderView instance
216 * get the list of the currently selected TnyHeader's
218 * Returns: the list with the currently selected headers
220 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
224 * modest_header_view_is_empty:
225 * @self: a valid ModestHeaderView instance
227 * see if this header view is empty; use this function instead of
228 * using the GtkTreeView parent directly, as 'empty' in this case
229 * may mean that there is one "This is empty"-message, and of course
230 * GtkTreeView then thinks it is *not* empty
232 * Returns: TRUE if the header view is empty, FALSE otherwise
234 gboolean modest_header_view_is_empty (ModestHeaderView *self);
239 * modest_header_view_select_next:
240 * @self: a #ModestHeaderView
242 * Selects the header next to the current selected one
244 void modest_header_view_select_next (ModestHeaderView *self);
247 * modest_header_view_select_prev:
248 * @self: a #ModestHeaderView
250 * Selects the previous header of the current selected one
252 void modest_header_view_select_prev (ModestHeaderView *self);
255 /* PROTECTED method. It's useful when we want to force a given
256 selection to reload a msg. For example if we have selected a header
257 in offline mode, when Modest become online, we want to reload the
258 message automatically without an user click over the header */
260 _modest_header_view_change_selection (GtkTreeSelection *selection,
266 #endif /* __MODEST_HEADER_VIEW_H__ */