X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fwidgets%2Fmodest-header-view.h;h=e1d671bf8d37873c29ccd4da51705827641f4647;hp=ed3465b613b3a32a5a2b631d762dfe1bf4913075;hb=f6d386ff93e929092ba105385a29d760aeba9ff7;hpb=340f39855dbd04254976cd6c0fcbd0ccc4979dca diff --git a/src/widgets/modest-header-view.h b/src/widgets/modest-header-view.h index ed3465b..e1d671b 100644 --- a/src/widgets/modest-header-view.h +++ b/src/widgets/modest-header-view.h @@ -30,12 +30,14 @@ #ifndef __MODEST_HEADER_VIEW_H__ #define __MODEST_HEADER_VIEW_H__ -#include #include +#include #include #include #include #include +#include "modest-mail-operation.h" +#include "modest-header-view-observer.h" G_BEGIN_DECLS @@ -56,27 +58,42 @@ struct _ModestHeaderView { }; #define MODEST_HEADER_VIEW_COLUMN "header-view-column" +#define MODEST_HEADER_VIEW_FLAG_SORT "header-view-flags-sort" typedef enum _ModestHeaderViewColumn { - MODEST_HEADER_VIEW_COLUMN_FROM = 0, + MODEST_HEADER_VIEW_COLUMN_FROM, MODEST_HEADER_VIEW_COLUMN_TO, MODEST_HEADER_VIEW_COLUMN_SUBJECT, MODEST_HEADER_VIEW_COLUMN_SENT_DATE, MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE, - MODEST_HEADER_VIEW_COLUMN_MSGTYPE, MODEST_HEADER_VIEW_COLUMN_ATTACH, - MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER, + MODEST_HEADER_VIEW_COLUMN_SIZE, + MODEST_HEADER_VIEW_COLUMN_STATUS, + + /* + * these two are for compact display on small devices, + * with two line display with all relevant headers + */ + MODEST_HEADER_VIEW_COLUMN_COMPACT_FLAG, /* priority and attachments */ + MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN, /* incoming mail */ + MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT,/* outgoing mail */ + MODEST_HEADER_VIEW_COLUMN_COMPACT_SENT_DATE, + MODEST_HEADER_VIEW_COLUMN_COMPACT_RECEIVED_DATE, MODEST_HEADER_VIEW_COLUMN_NUM + } ModestHeaderViewColumn; -/* typedef enum _ModestHeaderViewColumn ModestHeaderViewColumn; */ +/* + * this can be extended with more style thingies, + * to make a small-device specific display + */ typedef enum _ModestHeaderViewStyle { - MODEST_HEADER_VIEW_STYLE_NORMAL, - MODEST_HEADER_VIEW_STYLE_COMPACT, - MODEST_HEADER_VIEW_STYLE_NUM + MODEST_HEADER_VIEW_STYLE_DETAILS = 0, /* many columns, single line, col headers visible */ + MODEST_HEADER_VIEW_STYLE_TWOLINES = 1, /* two-line headers, col headers invisible */ + + MODEST_HEADER_VIEW_STYLE_NUM } ModestHeaderViewStyle; -/* typedef enum _ModestHeaderViewStyle ModestHeaderViewStyle; */ typedef enum _ModestItemType { MODEST_ITEM_TYPE_MESSAGE, @@ -84,23 +101,30 @@ typedef enum _ModestItemType { MODEST_ITEM_TYPE_NUM } ModestItemType; + struct _ModestHeaderViewClass { GtkTreeViewClass parent_class; - void (*message_selected) (ModestHeaderView* self, - TnyMsg *msg, - gpointer user_data); + void (*header_selected) (ModestHeaderView* self, + TnyHeader *header, + gpointer user_data); void (*item_not_found) (ModestHeaderView* self, ModestItemType type, gpointer user_data); - - /* msg == NULL implies that the operation is finished, ie. - * the progress indictation can be hidden */ - void (*status_update) (ModestHeaderView* self, - const gchar* msg, - gint status, - gpointer user_data); + + void (*header_activated) (ModestHeaderView* self, + TnyHeader *header, + gpointer user_data); + + void (*msg_count_changed) (ModestHeaderView* self, + TnyFolder *folder, + TnyFolderChange *change, + gpointer user_data); + + void (*updating_msg_list) (ModestHeaderView *self, + gboolean starting, + gpointer user_data); }; /** @@ -116,7 +140,6 @@ GType modest_header_view_get_type (void) G_GNUC_CONST; /** * modest_header_view_new: * @folder: a TnyMsgFolder object - * @columns: a list of ModestHeaderViewColumn * @style: a ModestHeaderViewColumn with the style of this listview * ( MODEST_HEADER_VIEW_STYLE_NORMAL or MODEST_HEADER_VIEW_STYLE_COMPACT) * @@ -125,7 +148,6 @@ GType modest_header_view_get_type (void) G_GNUC_CONST; * Returns: a new GtkWidget (a GtkTreeView-subclass) */ GtkWidget* modest_header_view_new (TnyFolder *folder, - const GList *columns, ModestHeaderViewStyle style); /** @@ -134,46 +156,58 @@ GtkWidget* modest_header_view_new (TnyFolder *folder, * @folder: a TnyFolder object * * set the folder for this ModestHeaderView + */ +void modest_header_view_set_folder (ModestHeaderView *self, + TnyFolder *folder, + gboolean refresh, + RefreshAsyncUserCallback callback, + gpointer user_data); + +/** + * modest_header_view_get_folder: + * @self: a ModestHeaderView instance + * + * get the folder in this ModestHeaderView * - * Returns: TRUE if it succeeded, FALSE otherwise + * Returns: the tny folder instance or NULL if there is none */ -gboolean modest_header_view_set_folder (ModestHeaderView *self, - TnyFolder *folder); +TnyFolder *modest_header_view_get_folder (ModestHeaderView *self); /** * modest_header_view_set_columns: * @self: a ModestHeaderView instance - * @columns: a list of ModestHeaderViewColumn + * @columns: a list of gint ModestHeaderViewColumn column IDs, using GINT_TO_POINTER() and GPOINTER_TO_INT(). + * @type: #TnyFolderType type * * set the columns for this ModestHeaderView. * * Returns: TRUE if it succeeded, FALSE otherwise */ gboolean modest_header_view_set_columns (ModestHeaderView *self, - const GList *columns); + const GList *columns, + TnyFolderType type); /** * modest_header_view_get_columns: * @self: a ModestHeaderView instance - * @folder: a TnyFolder object * * get the GtkTreeColumns for this ModestHeaderView. Each one of the * tree columns will have property than can be retrieved * with g_object_get_data MODEST_HEADER_VIEW_COLUMN (#define), * and which contains the corresponding ModestHeaderViewColumn * - * Returns: newly allocated list of column ids, or NULL in case of no columns or error + * Returns: newly allocated list of #GtkTreeViewColumns objects, or NULL in case of no columns or error * You must free the list with g_list_free */ GList* modest_header_view_get_columns (ModestHeaderView *self); - + /** * modest_header_view_set_style: * @self: a ModestHeaderView instance * @style: the style for this tree view * - * set the style this ModestHeaderView + * set the style for this ModestHeaderView * * Returns: TRUE if it succeeded, FALSE otherwise */ @@ -190,10 +224,203 @@ gboolean modest_header_view_set_style (ModestHeaderView *self, */ ModestHeaderViewStyle modest_header_view_get_style (ModestHeaderView *self); +/** + * modest_header_view_count_selected_headers: + * @self: a ModestHeaderView instance + * + * Check selected headers counter. + * Returns: the number of selected headers. + */ +guint +modest_header_view_count_selected_headers (ModestHeaderView *self); + +/** + * modest_header_view_has_selected_headers: + * @self: a ModestHeaderView instance + * + * Check if any row is selected on headers tree view. + * Returns: TRUE if any header is selected, FALSE otherwise. + */ +gboolean +modest_header_view_has_selected_headers (ModestHeaderView *self); + +/** + * modest_header_view_get_selected_headers: + * @self: a ModestHeaderView instance + * + * get the list of the currently selected TnyHeader's. The list and + * the headers should be freed by the caller + * + * Returns: the list with the currently selected headers + */ TnyList* modest_header_view_get_selected_headers (ModestHeaderView *self); + +/** + * modest_header_view_is_empty: + * @self: a valid ModestHeaderView instance + * + * see if this header view is empty; use this function instead of + * using the GtkTreeView parent directly, as 'empty' in this case + * may mean that there is one "This is empty"-message, and of course + * GtkTreeView then thinks it is *not* empty + * + * Returns: TRUE if the header view is empty, FALSE otherwise + */ +gboolean modest_header_view_is_empty (ModestHeaderView *self); + + + +/** + * modest_header_view_select_next: + * @self: a #ModestHeaderView + * + * Selects the header next to the current selected one + **/ +void modest_header_view_select_next (ModestHeaderView *self); + +/** + * modest_header_view_select_prev: + * @self: a #ModestHeaderView + * + * Selects the previous header of the current selected one + **/ +void modest_header_view_select_prev (ModestHeaderView *self); + + +/* PROTECTED method. It's useful when we want to force a given + selection to reload a msg. For example if we have selected a header + in offline mode, when Modest become online, we want to reload the + message automatically without an user click over the header */ +void +_modest_header_view_change_selection (GtkTreeSelection *selection, + gpointer user_data); + +/** + * modest_header_view_get_sort_column_id: + * @self: a #ModestHeaderView + * @type: #TnyFolderType type + * + * Gets the selected logical columnd id for sorting. + **/ +gint +modest_header_view_get_sort_column_id (ModestHeaderView *self, TnyFolderType type); + +/** + * modest_header_view_get_sort_type: + * @self: a #ModestHeaderView + * @type: #TnyFolderType type + * + * Gets the selected sort type. + **/ +GtkSortType +modest_header_view_get_sort_type (ModestHeaderView *self, TnyFolderType type); + +/** + * modest_header_view_set_sort_params: + * @self: a #ModestHeaderView + * @sort_colid: logical column id to sort + * @sort_type: #GtkSortType sort type + * @type: #TnyFolderType type + * + * Sets the logical columnd id and sort type for sorting operations. + **/ +void +modest_header_view_set_sort_params (ModestHeaderView *self, guint sort_colid, GtkSortType sort_type, TnyFolderType type); + +/** + * modest_header_view_set_sort_params: + * @self: a #ModestHeaderView + * @sort_colid: logical column id to sort + * @sort_type: #GtkSortType sort type + * + * Sorts headers treeview by logical column id, @sort_colid, using a + * @sort_type sorting method. In addition, new headder settings will be + * stored in @self object. + **/ +void +modest_header_view_sort_by_column_id (ModestHeaderView *self, + guint sort_colid, + GtkSortType sort_type); + +/** + * modest_header_view_clear: + * @self: a #ModestHeaderView + * + * Clear the contents of a header view. It internally calls the + * set_folder function with last three arguments as NULL + **/ +void +modest_header_view_clear (ModestHeaderView *self); + +/** + * modest_header_view_copy_selection: + * @self: a #ModestHeaderView + * + * Stores a #TnyList of selected headers in the own clibpoard of + * @self header view. + **/ +void +modest_header_view_copy_selection (ModestHeaderView *header_view); + +/** + * modest_header_view_cut_selection: + * @self: a #ModestHeaderView + * + * Stores a #TnyList of selected headers in the own clibpoard of + * @self header view and filter them into headers tree model to + * hide these rows in treeview. + **/ +void +modest_header_view_cut_selection (ModestHeaderView *header_view); + + +/** + * modest_header_view_paste_selection: + * @self: a #ModestHeaderView + * @headers: ouput parameter with a #TnyList of headers which will be returned. + * @delete: output parameter with indication about delete or not the selected headers. + * + * Gets the selected headers to copy/cut. + **/ +void +modest_header_view_paste_selection (ModestHeaderView *header_view, + TnyList **headers, + gboolean *delete); + +void modest_header_view_refilter (ModestHeaderView *header_view); + +/** + * modest_header_view_add_observer: + * @header_view: a #ModestHeaderView + * @observer: The observer to notify. + * + * Registers a new observer. Warning! Each added observer object must + * removed using @modest_header_view_remove_observer before destroying + * the observer, or at least when it is under destruction. Also you + * should care about that the observer's #update function might be + * called any time until the observer is removed. + **/ +void modest_header_view_add_observer( + ModestHeaderView *header_view, + ModestHeaderViewObserver *observer); + +/** + * modest_header_view_remove_observer: + * @header_view: a #ModestHeaderView + * @observer: The observer to remove. + * + * Removes exactly one observer from the notification list. If you + * added an observer twice, you should call this remove funtion twice + * as well. + **/ +void modest_header_view_remove_observer( + ModestHeaderView *header_view, + ModestHeaderViewObserver *observer); + G_END_DECLS + #endif /* __MODEST_HEADER_VIEW_H__ */