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,
68 MODEST_HEADER_VIEW_COLUMN_STATUS,
71 * these two are for compact display on small devices,
72 * with two line display with all relevant headers
74 MODEST_HEADER_VIEW_COLUMN_COMPACT_FLAG, /* priority and attachments */
75 MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN, /* incoming mail */
76 MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT, /* outgoing mail */
77 MODEST_HEADER_VIEW_COLUMN_COMPACT_SENT_DATE,
78 MODEST_HEADER_VIEW_COLUMN_COMPACT_RECEIVED_DATE,
80 MODEST_HEADER_VIEW_COLUMN_NUM
82 } ModestHeaderViewColumn;
85 * this can be extended with more style thingies,
86 * to make a small-device specific display
88 typedef enum _ModestHeaderViewStyle {
89 MODEST_HEADER_VIEW_STYLE_DETAILS, /* many columns, single line, col headers visible */
90 MODEST_HEADER_VIEW_STYLE_TWOLINES, /* two-line headers, col headers invisible */
92 MODEST_HEADER_VIEW_STYLE_NUM
93 } ModestHeaderViewStyle;
95 typedef enum _ModestItemType {
96 MODEST_ITEM_TYPE_MESSAGE,
97 MODEST_ITEM_TYPE_FOLDER,
102 struct _ModestHeaderViewClass {
103 GtkTreeViewClass parent_class;
105 void (*header_selected) (ModestHeaderView* self,
109 void (*item_not_found) (ModestHeaderView* self,
113 void (*header_activated) (ModestHeaderView* self,
117 /* msg == NULL implies that the operation is finished, ie.
118 * the progress indictation can be hidden */
119 void (*status_update) (ModestHeaderView* self,
121 gint num, gint total,
126 * modest_header_view_get_type:
128 * get the GType for ModestHeaderView
132 GType modest_header_view_get_type (void) G_GNUC_CONST;
136 * modest_header_view_new:
137 * @folder: a TnyMsgFolder object
138 * @style: a ModestHeaderViewColumn with the style of this listview
139 * ( MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
141 * create a new ModestHeaderView instance, based on a folder iface
143 * Returns: a new GtkWidget (a GtkTreeView-subclass)
145 GtkWidget* modest_header_view_new (TnyFolder *folder,
146 ModestHeaderViewStyle style);
149 * modest_header_view_set_folder:
150 * @self: a ModestHeaderView instance
151 * @folder: a TnyFolder object
153 * set the folder for this ModestHeaderView
155 void modest_header_view_set_folder (ModestHeaderView *self,
159 * modest_header_view_get_folder:
160 * @self: a ModestHeaderView instance
162 * get the folder in this ModestHeaderView
164 * Returns: the tny folder instance or NULL if there is none
166 TnyFolder *modest_header_view_get_folder (ModestHeaderView *self);
170 * modest_header_view_set_columns:
171 * @self: a ModestHeaderView instance
172 * @columns: a list of ModestHeaderViewColumn
173 * @type: #TnyFolderType type
175 * set the columns for this ModestHeaderView.
177 * Returns: TRUE if it succeeded, FALSE otherwise
179 gboolean modest_header_view_set_columns (ModestHeaderView *self,
180 const GList *columns,
183 * modest_header_view_get_columns:
184 * @self: a ModestHeaderView instance
186 * get the GtkTreeColumns for this ModestHeaderView. Each one of the
187 * tree columns will have property than can be retrieved
188 * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define),
189 * and which contains the corresponding ModestHeaderViewColumn
191 * Returns: newly allocated list of column ids, or NULL in case of no columns or error
192 * You must free the list with g_list_free
194 GList* modest_header_view_get_columns (ModestHeaderView *self);
198 * modest_header_view_set_style:
199 * @self: a ModestHeaderView instance
200 * @style: the style for this tree view
202 * set the style for this ModestHeaderView
204 * Returns: TRUE if it succeeded, FALSE otherwise
206 gboolean modest_header_view_set_style (ModestHeaderView *self,
207 ModestHeaderViewStyle style);
210 * modest_header_view_set_folder:
211 * @self: a ModestHeaderView instance
213 * get the style for this ModestHeaderView
215 * Returns: the current style
217 ModestHeaderViewStyle modest_header_view_get_style (ModestHeaderView *self);
220 * modest_header_view_get_selected_headers:
221 * @self: a ModestHeaderView instance
223 * get the list of the currently selected TnyHeader's
225 * Returns: the list with the currently selected headers
227 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
231 * modest_header_view_is_empty:
232 * @self: a valid ModestHeaderView instance
234 * see if this header view is empty; use this function instead of
235 * using the GtkTreeView parent directly, as 'empty' in this case
236 * may mean that there is one "This is empty"-message, and of course
237 * GtkTreeView then thinks it is *not* empty
239 * Returns: TRUE if the header view is empty, FALSE otherwise
241 gboolean modest_header_view_is_empty (ModestHeaderView *self);
246 * modest_header_view_select_next:
247 * @self: a #ModestHeaderView
249 * Selects the header next to the current selected one
251 void modest_header_view_select_next (ModestHeaderView *self);
254 * modest_header_view_select_prev:
255 * @self: a #ModestHeaderView
257 * Selects the previous header of the current selected one
259 void modest_header_view_select_prev (ModestHeaderView *self);
262 /* PROTECTED method. It's useful when we want to force a given
263 selection to reload a msg. For example if we have selected a header
264 in offline mode, when Modest become online, we want to reload the
265 message automatically without an user click over the header */
267 _modest_header_view_change_selection (GtkTreeSelection *selection,
271 * modest_header_view_get_sort_column_id:
272 * @self: a #ModestHeaderView
273 * @type: #TnyFolderType type
275 * Gets the selected logical columnd id for sorting.
278 modest_header_view_get_sort_column_id (ModestHeaderView *self, TnyFolderType type);
281 * modest_header_view_get_sort_column_id:
282 * @self: a #ModestHeaderView
283 * @sort_colid: logical column id to sort
284 * @type: #TnyFolderType type
286 * Sets the logical columnd id for sorting.
289 modest_header_view_set_sort_column_id (ModestHeaderView *self, guint sort_colid, TnyFolderType type);
297 #endif /* __MODEST_HEADER_VIEW_H__ */