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-folder-change.h>
35 #include <tny-gtk-account-list-model.h>
37 #include <tny-header.h>
38 #include <tny-gtk-header-list-model.h>
39 #include "modest-mail-operation.h"
40 #include "modest-header-view-observer.h"
44 /* convenience macros */
45 #define MODEST_TYPE_HEADER_VIEW (modest_header_view_get_type())
46 #define MODEST_HEADER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderView))
47 #define MODEST_HEADER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
48 #define MODEST_IS_HEADER_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_HEADER_VIEW))
49 #define MODEST_IS_HEADER_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_HEADER_VIEW))
50 #define MODEST_HEADER_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_HEADER_VIEW,ModestHeaderViewClass))
52 typedef struct _ModestHeaderView ModestHeaderView;
53 typedef struct _ModestHeaderViewClass ModestHeaderViewClass;
55 struct _ModestHeaderView {
57 /* insert public members, if any */
60 #define MODEST_HEADER_VIEW_COLUMN "header-view-column"
61 #define MODEST_HEADER_VIEW_FLAG_SORT "header-view-flags-sort"
63 typedef enum _ModestHeaderViewColumn {
64 MODEST_HEADER_VIEW_COLUMN_FROM = 0,
65 MODEST_HEADER_VIEW_COLUMN_TO = 1,
66 MODEST_HEADER_VIEW_COLUMN_SUBJECT = 2,
67 MODEST_HEADER_VIEW_COLUMN_SENT_DATE = 3,
68 MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE = 4,
69 MODEST_HEADER_VIEW_COLUMN_MSGTYPE = 5,
70 MODEST_HEADER_VIEW_COLUMN_ATTACH = 6,
71 MODEST_HEADER_VIEW_COLUMN_SIZE = 7,
72 MODEST_HEADER_VIEW_COLUMN_STATUS = 8,
75 * these two are for compact display on small devices,
76 * with two line display with all relevant headers
78 MODEST_HEADER_VIEW_COLUMN_COMPACT_FLAG = 9, /* priority and attachments */
79 MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN = 10, /* incoming mail */
80 MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT = 11,/* outgoing mail */
81 MODEST_HEADER_VIEW_COLUMN_COMPACT_SENT_DATE = 12,
82 MODEST_HEADER_VIEW_COLUMN_COMPACT_RECEIVED_DATE = 13,
84 MODEST_HEADER_VIEW_COLUMN_NUM
86 } ModestHeaderViewColumn;
89 * this can be extended with more style thingies,
90 * to make a small-device specific display
92 typedef enum _ModestHeaderViewStyle {
93 MODEST_HEADER_VIEW_STYLE_DETAILS = 0, /* many columns, single line, col headers visible */
94 MODEST_HEADER_VIEW_STYLE_TWOLINES = 1, /* two-line headers, col headers invisible */
96 MODEST_HEADER_VIEW_STYLE_NUM
97 } ModestHeaderViewStyle;
99 typedef enum _ModestItemType {
100 MODEST_ITEM_TYPE_MESSAGE,
101 MODEST_ITEM_TYPE_FOLDER,
106 struct _ModestHeaderViewClass {
107 GtkTreeViewClass parent_class;
109 void (*header_selected) (ModestHeaderView* self,
113 void (*item_not_found) (ModestHeaderView* self,
117 void (*header_activated) (ModestHeaderView* self,
121 void (*msg_count_changed) (ModestHeaderView* self,
123 TnyFolderChange *change,
126 void (*updating_msg_list) (ModestHeaderView *self,
132 * modest_header_view_get_type:
134 * get the GType for ModestHeaderView
138 GType modest_header_view_get_type (void) G_GNUC_CONST;
142 * modest_header_view_new:
143 * @folder: a TnyMsgFolder object
144 * @style: a ModestHeaderViewColumn with the style of this listview
145 * ( MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT)
147 * create a new ModestHeaderView instance, based on a folder iface
149 * Returns: a new GtkWidget (a GtkTreeView-subclass)
151 GtkWidget* modest_header_view_new (TnyFolder *folder,
152 ModestHeaderViewStyle style);
155 * modest_header_view_set_folder:
156 * @self: a ModestHeaderView instance
157 * @folder: a TnyFolder object
159 * set the folder for this ModestHeaderView
161 void modest_header_view_set_folder (ModestHeaderView *self,
163 RefreshAsyncUserCallback callback,
167 * modest_header_view_get_folder:
168 * @self: a ModestHeaderView instance
170 * get the folder in this ModestHeaderView
172 * Returns: the tny folder instance or NULL if there is none
174 TnyFolder *modest_header_view_get_folder (ModestHeaderView *self);
178 * modest_header_view_set_columns:
179 * @self: a ModestHeaderView instance
180 * @columns: a list of gint ModestHeaderViewColumn column IDs, using GINT_TO_POINTER() and GPOINTER_TO_INT().
181 * @type: #TnyFolderType type
183 * set the columns for this ModestHeaderView.
185 * Returns: TRUE if it succeeded, FALSE otherwise
187 gboolean modest_header_view_set_columns (ModestHeaderView *self,
188 const GList *columns,
191 * modest_header_view_get_columns:
192 * @self: a ModestHeaderView instance
194 * get the GtkTreeColumns for this ModestHeaderView. Each one of the
195 * tree columns will have property than can be retrieved
196 * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define),
197 * and which contains the corresponding ModestHeaderViewColumn
199 * Returns: newly allocated list of #GtkTreeViewColumns objects, or NULL in case of no columns or error
200 * You must free the list with g_list_free
202 GList* modest_header_view_get_columns (ModestHeaderView *self);
206 * modest_header_view_set_style:
207 * @self: a ModestHeaderView instance
208 * @style: the style for this tree view
210 * set the style for this ModestHeaderView
212 * Returns: TRUE if it succeeded, FALSE otherwise
214 gboolean modest_header_view_set_style (ModestHeaderView *self,
215 ModestHeaderViewStyle style);
218 * modest_header_view_set_folder:
219 * @self: a ModestHeaderView instance
221 * get the style for this ModestHeaderView
223 * Returns: the current style
225 ModestHeaderViewStyle modest_header_view_get_style (ModestHeaderView *self);
228 * modest_header_view_count_selected_headers:
229 * @self: a ModestHeaderView instance
231 * Check selected headers counter.
232 * Returns: the number of selected headers.
235 modest_header_view_count_selected_headers (ModestHeaderView *self);
238 * modest_header_view_has_selected_headers:
239 * @self: a ModestHeaderView instance
241 * Check if any row is selected on headers tree view.
242 * Returns: TRUE if any header is selected, FALSE otherwise.
245 modest_header_view_has_selected_headers (ModestHeaderView *self);
248 * modest_header_view_get_selected_headers:
249 * @self: a ModestHeaderView instance
251 * get the list of the currently selected TnyHeader's. The list and
252 * the headers should be freed by the caller
254 * Returns: the list with the currently selected headers
256 TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self);
260 * modest_header_view_is_empty:
261 * @self: a valid ModestHeaderView instance
263 * see if this header view is empty; use this function instead of
264 * using the GtkTreeView parent directly, as 'empty' in this case
265 * may mean that there is one "This is empty"-message, and of course
266 * GtkTreeView then thinks it is *not* empty
268 * Returns: TRUE if the header view is empty, FALSE otherwise
270 gboolean modest_header_view_is_empty (ModestHeaderView *self);
275 * modest_header_view_select_next:
276 * @self: a #ModestHeaderView
278 * Selects the header next to the current selected one
280 void modest_header_view_select_next (ModestHeaderView *self);
283 * modest_header_view_select_prev:
284 * @self: a #ModestHeaderView
286 * Selects the previous header of the current selected one
288 void modest_header_view_select_prev (ModestHeaderView *self);
291 /* PROTECTED method. It's useful when we want to force a given
292 selection to reload a msg. For example if we have selected a header
293 in offline mode, when Modest become online, we want to reload the
294 message automatically without an user click over the header */
296 _modest_header_view_change_selection (GtkTreeSelection *selection,
300 * modest_header_view_get_sort_column_id:
301 * @self: a #ModestHeaderView
302 * @type: #TnyFolderType type
304 * Gets the selected logical columnd id for sorting.
307 modest_header_view_get_sort_column_id (ModestHeaderView *self, TnyFolderType type);
310 * modest_header_view_get_sort_type:
311 * @self: a #ModestHeaderView
312 * @type: #TnyFolderType type
314 * Gets the selected sort type.
317 modest_header_view_get_sort_type (ModestHeaderView *self, TnyFolderType type);
320 * modest_header_view_set_sort_params:
321 * @self: a #ModestHeaderView
322 * @sort_colid: logical column id to sort
323 * @sort_type: #GtkSortType sort type
324 * @type: #TnyFolderType type
326 * Sets the logical columnd id and sort type for sorting operations.
329 modest_header_view_set_sort_params (ModestHeaderView *self, guint sort_colid, GtkSortType sort_type, TnyFolderType type);
332 * modest_header_view_set_sort_params:
333 * @self: a #ModestHeaderView
334 * @sort_colid: logical column id to sort
335 * @sort_type: #GtkSortType sort type
337 * Sorts headers treeview by logical column id, @sort_colid, using a
338 * @sort_type sorting method. In addition, new headder settings will be
339 * stored in @self object.
342 modest_header_view_sort_by_column_id (ModestHeaderView *self,
344 GtkSortType sort_type);
347 * modest_header_view_clear:
348 * @self: a #ModestHeaderView
350 * Clear the contents of a header view. It internally calls the
351 * set_folder function with last three arguments as NULL
354 modest_header_view_clear (ModestHeaderView *self);
357 * modest_header_view_copy_selection:
358 * @self: a #ModestHeaderView
360 * Stores a #TnyList of selected headers in the own clibpoard of
364 modest_header_view_copy_selection (ModestHeaderView *header_view);
367 * modest_header_view_cut_selection:
368 * @self: a #ModestHeaderView
370 * Stores a #TnyList of selected headers in the own clibpoard of
371 * @self header view and filter them into headers tree model to
372 * hide these rows in treeview.
375 modest_header_view_cut_selection (ModestHeaderView *header_view);
379 * modest_header_view_paste_selection:
380 * @self: a #ModestHeaderView
381 * @headers: ouput parameter with a #TnyList of headers which will be returned.
382 * @delete: output parameter with indication about delete or not the selected headers.
384 * Gets the selected headers to copy/cut.
387 modest_header_view_paste_selection (ModestHeaderView *header_view,
391 void modest_header_view_refilter (ModestHeaderView *header_view);
394 * modest_header_view_add_observer:
395 * @header_view: a #ModestHeaderView
396 * @observer: The observer to notify.
398 * Registers a new observer. Warning! Each added observer object must
399 * removed using @modest_header_view_remove_observer before destroying
400 * the observer, or at least when it is under destruction. Also you
401 * should care about that the observer's #update function might be
402 * called any time until the observer is removed.
404 void modest_header_view_add_observer(
405 ModestHeaderView *header_view,
406 ModestHeaderViewObserver *observer);
409 * modest_header_view_remove_observer:
410 * @header_view: a #ModestHeaderView
411 * @observer: The observer to remove.
413 * Removes exactly one observer from the notification list. If you
414 * added an observer twice, you should call this remove funtion twice
417 void modest_header_view_remove_observer(
418 ModestHeaderView *header_view,
419 ModestHeaderViewObserver *observer);
425 #endif /* __MODEST_HEADER_VIEW_H__ */