Modified webpage: now tinymail repository is in gitorious.

[modest] / src / widgets / modest-folder-view.h

diff --git a/src/widgets/modest-folder-view.h b/src/widgets/modest-folder-view.h
index 5c5ae4a..ff916b3 100644 (file)
--- a/src/widgets/modest-folder-view.h
+++ b/src/widgets/modest-folder-view.h
@@ -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
 
@@ -58,6 +59,15 @@ typedef enum _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;
@@ -84,6 +94,13 @@ struct _ModestFolderViewClass {
        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);
 };
 
 /**
@@ -108,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
@@ -171,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
  * 
@@ -267,7 +316,7 @@ void modest_folder_view_set_cell_style (ModestFolderView *self,
                                        ModestFolderViewCellStyle cell_style);
 
 /**
- * modest_folder_view_filter:
+ * modest_folder_view_set_filter:
  * @self: a #ModestFolderView
  * @filter: a filter mask to be applied to files
  *
@@ -277,6 +326,74 @@ void modest_folder_view_set_cell_style (ModestFolderView *self,
 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
 
 #endif /* __MODEST_FOLDER_VIEW_H__ */