Modified webpage: now tinymail repository is in gitorious.
[modest] / src / widgets / modest-folder-view.h
index 99e155b..ff916b3 100644 (file)
@@ -34,6 +34,7 @@
 #include <tny-gtk-account-list-model.h>
 #include <tny-account-store.h>
 #include <modest-tny-account-store.h>
+#include <modest-tny-folder.h>
 
 G_BEGIN_DECLS
 
@@ -50,6 +51,25 @@ typedef enum _ModestFolderViewStyle {
        MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
 } ModestFolderViewStyle;
 
+typedef enum _ModestFolderViewCellStyle {
+       MODEST_FOLDER_VIEW_CELL_STYLE_DEFAULT,
+       MODEST_FOLDER_VIEW_CELL_STYLE_COMPACT
+} ModestFolderViewCellStyle;
+
+typedef enum _ModestFolderViewFilter {
+       MODEST_FOLDER_VIEW_FILTER_NONE = 0,
+       MODEST_FOLDER_VIEW_FILTER_CAN_HAVE_FOLDERS = 1 << 0,
+       MODEST_FOLDER_VIEW_FILTER_HIDE_MANDATORY_FOLDERS = 1 << 1,
+       MODEST_FOLDER_VIEW_FILTER_RENAMEABLE = 1 << 2,
+       MODEST_FOLDER_VIEW_FILTER_MOVEABLE = 1 << 3,
+       MODEST_FOLDER_VIEW_FILTER_DELETABLE = 1 << 4,
+       MODEST_FOLDER_VIEW_FILTER_HIDE_ACCOUNTS = 1 << 5,
+       MODEST_FOLDER_VIEW_FILTER_HIDE_FOLDERS = 1 << 6,
+       MODEST_FOLDER_VIEW_FILTER_HIDE_LOCAL_FOLDERS = 1 << 7,
+       MODEST_FOLDER_VIEW_FILTER_HIDE_MCC_FOLDERS = 1 << 8,
+       MODEST_FOLDER_VIEW_FILTER_SHOW_ONLY_MAILBOXES = 1<< 9,
+} ModestFolderViewFilter;
+
 typedef struct _ModestFolderView      ModestFolderView;
 typedef struct _ModestFolderViewClass ModestFolderViewClass;
 
@@ -70,6 +90,17 @@ struct _ModestFolderViewClass {
        void     (*folder_display_name_changed) (ModestFolderView* self,
                                                 const gchar *display_name,
                                                 gpointer user_data);
+
+       void     (*folder_activated) (ModestFolderView *self,
+                                     TnyFolderStore *folder,
+                                     gpointer userdata);
+
+       void     (*visible_account_changed) (ModestFolderView* self,
+                                            const gchar *account_id,
+                                            gpointer user_data);
+       void     (*activity_changed) (ModestFolderView* self,
+                                     gboolean activity,
+                                     gpointer user_data);
 };
 
 /**
@@ -94,6 +125,17 @@ GType        modest_folder_view_get_type        (void) G_GNUC_CONST;
 GtkWidget*    modest_folder_view_new            (TnyFolderStoreQuery *query);
 
 /**
+ * modest_folder_view_new_full:
+ * @query: a #TnyFolderStoreQuery that specifies the folders to show
+ * @do_refresh: do auto refresh on loading (may be slow)
+ * 
+ * create a new #ModestFolderView instance
+ *  
+ * Returns: a new #GtkWidget (a #GtkTreeView subclass)
+ */
+GtkWidget*    modest_folder_view_new_full            (TnyFolderStoreQuery *query, gboolean do_refresh);
+
+/**
  * modest_folder_view_set_title:
  * @self: a ModestFolderView instance
  * @title: the new title
@@ -157,6 +199,27 @@ void         modest_folder_view_set_account_id_of_visible_server_account (Modest
                                                                          const gchar *account_id);
 
 /**
+ * modest_folder_view_set_visible_mailbox:
+ * @self: a #ModestFolderView
+ * @account_id: the remote account mailbox to show
+ * 
+ * if set an account id to filter, this filters also to show only
+ * folders of a specific mailbox.
+ **/
+void         modest_folder_view_set_mailbox (ModestFolderView *self,
+                                            const gchar *mailbox);
+
+/**
+ * modest_folder_view_get_mailbox:
+ * @self: a #ModestFolderView
+ *
+ * Return the current mailbox set for filtering in folder view
+ *
+ * Returns: a string, or %NULL
+ */
+const gchar *modest_folder_view_get_mailbox (ModestFolderView *self);
+
+/**
  * modest_folder_view_get_account_id_of_visible_server_account:
  * @self: a #ModestFolderView
  * 
@@ -176,8 +239,7 @@ void         modest_folder_view_select_first_inbox_or_local  (ModestFolderView *
  * Stores a #TnyList of selected folders in the own clibpoard of 
  * @self folder view.
  **/
-void 
-modest_folder_view_copy_selection (ModestFolderView *folder_view);
+void modest_folder_view_copy_selection (ModestFolderView *folder_view);
 
 /**
  * modest_folder_view_cut_selection:
@@ -187,15 +249,14 @@ modest_folder_view_copy_selection (ModestFolderView *folder_view);
  * @self folder view and filter them into folders tree model to
  * hide these rows in treeview.
  **/
-void 
-modest_folder_view_cut_selection (ModestFolderView *folder_view);
+void modest_folder_view_cut_selection (ModestFolderView *folder_view);
 
 
 /**
  * modest_folder_view_select_folder
  * @self: a #ModestFolderView
  * @folder: a #TnyFolder
- * @after_change: should we select directly (TRUE), or after the first change to the view (FALSE)
+ * @after_change: should we select first change to the view (TRUE), or just now (FALSE)
  *
  * select the given TnyFolder in the folder;
  * return TRUE if it succeeded, FALSE otherwise.
@@ -210,10 +271,7 @@ gboolean modest_folder_view_select_folder (ModestFolderView *self, TnyFolder *fo
  * 
  * Gets the selected folders to copy/cut.
  **/
-void
-modest_folder_view_paste_selection (ModestFolderView *folder_view,
-                                   TnyList **folders,
-                                   gboolean *delete);
+void modest_folder_view_paste_selection (ModestFolderView *folder_view, TnyList **folders, gboolean *delete);
 
 /*
  * modest_folder_view_show_non_move_folders:
@@ -222,9 +280,7 @@ modest_folder_view_paste_selection (ModestFolderView *folder_view,
  * 
  * Whether to show folders where no messages can be moved to 
  **/
-void
-modest_folder_view_show_non_move_folders (ModestFolderView *folder_view,
-                                   gboolean show);
+void modest_folder_view_show_non_move_folders (ModestFolderView *folder_view, gboolean show);
 
 /*
  * modest_folder_view_copy_model:
@@ -235,9 +291,108 @@ modest_folder_view_show_non_move_folders (ModestFolderView *folder_view,
  * #GtkTreeFilterModel object for that model. This copied
  * model will be asigned to @folder_view_dst. 
  **/
-void
-modest_folder_view_copy_model (ModestFolderView *folder_view_src,
-                              ModestFolderView *folder_view_dst);
+void modest_folder_view_copy_model (ModestFolderView *folder_view_src, ModestFolderView *folder_view_dst);
+
+/*
+ * modest_folder_disable_next_folder_selection:
+ * @folder_view: a #ModestFolderView
+ * 
+ * Checks if folder_to_select private field is set and 
+ * unref it in this case, assigning it to NULL to avoid 
+ * next call to on_row_inserted_maybe_select_folder does 
+ * not select any folder.
+ * 
+ **/
+void modest_folder_view_disable_next_folder_selection (ModestFolderView *self);
+
+/**
+ * modest_folder_view_set_cell_style:
+ * @self: a #ModestFolderView
+ * @cell_style: a #ModestFolderViewCellStyle
+ *
+ * Sets the way cells are shown
+ */
+void modest_folder_view_set_cell_style (ModestFolderView *self,
+                                       ModestFolderViewCellStyle cell_style);
+
+/**
+ * modest_folder_view_set_filter:
+ * @self: a #ModestFolderView
+ * @filter: a filter mask to be applied to files
+ *
+ * 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_folder_view_set_filter (ModestFolderView *self,
+                                   ModestFolderViewFilter filter);
+
+/**
+ * modest_folder_view_unset_filter:
+ * @self: a #ModestFolderView
+ * @filter: a filter mask to be unapplied to files
+ *
+ * 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_folder_view_unset_filter (ModestFolderView *self,
+                                     ModestFolderViewFilter filter);
+
+gboolean modest_folder_view_any_folder_fulfils_rules (ModestFolderView *self,
+                                                     ModestTnyFolderRules rules);
+
+/**
+ * modest_folder_view_set_list_to_move:
+ * @self: a #ModestFolderView
+ * @list: a #TnyList, or %NULL for unsetting the current list.
+ * 
+ * list of folders or messages we're moving. This has some effects on 
+ * "show_non_move_to".
+ */
+void modest_folder_view_set_list_to_move (ModestFolderView *self,
+                                         TnyList *list);
+
+/**
+ * modest_folder_view_show_message_count:
+ * @self: a #ModestFolderView
+ * @show: a #gboolean
+ *
+ * Set if the message count should be shown or not
+ */
+void modest_folder_view_show_message_count (ModestFolderView *self,
+                                           gboolean show);
+
+/**
+ * modest_folder_view_get_activity:
+ * @self: a #ModestFolderView
+ *
+ * tells if widget is retrieving information
+ *
+ * Returns: %TRUE if retrieving, %FALSE otherwise
+ */
+gboolean modest_folder_view_get_activity (ModestFolderView *self);
+
+/**
+ * modest_folder_view_get_model_tny_list:
+ * @self: a #ModestFolderView
+ *
+ * obtains the #TnyList model containing the accounts in the folder view.
+ *
+ * Returns: a caller owner #TnyList
+ */
+TnyList *modest_folder_view_get_model_tny_list (ModestFolderView *self);
+
+#ifdef MODEST_TOOLKIT_HILDON2
+/**
+ * modest_folder_view_setup_live_search:
+ * @self: a #ModestAccountView
+ *
+ * obtains a properly set up #HildonLiveSearch for @self
+ *
+ * Returns: a #HildonLiveSearch
+ */
+GtkWidget *modest_folder_view_setup_live_search (ModestFolderView *self);
+#endif
+
 
 G_END_DECLS