X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fwidgets%2Fmodest-header-view.h;h=be9b88c2350074d96964a371131b3dfb147a4e2e;hp=2e8aeabc7f6b75bb2112924c87f45eed174475d5;hb=d9eb3162361166eee20ddb8b5a8518c7ea310372;hpb=2ded5c8d7b2fc0b7fad127294e997939fe8d6a8e diff --git a/src/widgets/modest-header-view.h b/src/widgets/modest-header-view.h index 2e8aeab..be9b88c 100644 --- a/src/widgets/modest-header-view.h +++ b/src/widgets/modest-header-view.h @@ -31,10 +31,14 @@ #define __MODEST_HEADER_VIEW_H__ #include +#include #include #include #include #include +#include "modest-window.h" +#include "modest-mail-operation.h" +#include "modest-header-view-observer.h" G_BEGIN_DECLS @@ -55,25 +59,30 @@ 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_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_HEADER_IN, /* incoming mail */ - MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT, /* outgoing mail */ + 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; /* @@ -81,8 +90,9 @@ typedef enum _ModestHeaderViewColumn { * to make a small-device specific display */ typedef enum _ModestHeaderViewStyle { - MODEST_HEADER_VIEW_STYLE_DETAILS, /* many columns, single line, col headers visible */ - MODEST_HEADER_VIEW_STYLE_TWOLINES, /* two-line headers, col headers invisible */ + 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; @@ -93,6 +103,12 @@ typedef enum _ModestItemType { } ModestItemType; +typedef enum _ModestHeaderViewFilter { + MODEST_HEADER_VIEW_FILTER_NONE = 0, + MODEST_HEADER_VIEW_FILTER_MOVEABLE = 1 << 0, + MODEST_HEADER_VIEW_FILTER_DELETABLE = 1 << 1, +} ModestHeaderViewFilter; + struct _ModestHeaderViewClass { GtkTreeViewClass parent_class; @@ -103,13 +119,20 @@ struct _ModestHeaderViewClass { 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 num, gint total, - gpointer user_data); + + void (*header_activated) (ModestHeaderView* self, + TnyHeader *header, + GtkTreePath *path, + 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); }; /** @@ -125,7 +148,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) * @@ -134,7 +156,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); /** @@ -143,14 +164,13 @@ GtkWidget* modest_header_view_new (TnyFolder *folder, * @folder: a TnyFolder object * * set the folder for this ModestHeaderView - * - * Returns: TRUE if it succeeded, FALSE otherwise */ -gboolean modest_header_view_set_folder (ModestHeaderView *self, - TnyFolder *folder); - - - +void modest_header_view_set_folder (ModestHeaderView *self, + TnyFolder *folder, + gboolean refresh, + ModestWindow *progress_window, + RefreshAsyncUserCallback callback, + gpointer user_data); /** * modest_header_view_get_folder: @@ -166,14 +186,16 @@ 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 @@ -183,7 +205,7 @@ gboolean modest_header_view_set_columns (ModestHeaderView *self, * 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); @@ -212,10 +234,31 @@ 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 + * 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 */ @@ -245,6 +288,14 @@ gboolean modest_header_view_is_empty (ModestHeaderView *self); **/ 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 @@ -254,8 +305,171 @@ 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_set_filter: + * @self: a #ModestHeaderView + * @filter: a filter mask to be applied to messages + * + * sets the special filter to be applied (affects visibility of items). + * It's a mask, and filters applied are applied with an AND. + */ +void modest_header_view_set_filter (ModestHeaderView *self, + ModestHeaderViewFilter filter); + +/** + * modest_header_view_unset_filter: + * @self: a #ModestHeaderView + * @filter: a filter mask to be unapplied to headers + * + * Unsets the special filter to be applied (affects visibility of + * items). It's a mask, and filters applied are applied with an AND. + */ +void modest_header_view_unset_filter (ModestHeaderView *self, + ModestHeaderViewFilter filter); + + + +/** + * 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); + +/** + * modest_header_view_get_header_at_pos: + * @header_view: a #ModestHeaderView + * @initial_x: the x coordinate + * @initial_y: the y coordinate + * + * Return the #TnyHeader stored in the row at (x,y) coordinates + * relatives to the widget. It returns a new reference so you must + * unref it once you're done with it. + * + * Returns: a #TnyHeader if found, else NULL + **/ +TnyHeader* modest_header_view_get_header_at_pos (ModestHeaderView *header_view, + gint initial_x, + gint initial_y); + G_END_DECLS + #endif /* __MODEST_HEADER_VIEW_H__ */