* Changes in the autotools stuff affecting a lot of platform dependent
[modest] / src / widgets / modest-folder-view.h
index e4d9744..ed7e973 100644 (file)
@@ -45,6 +45,11 @@ G_BEGIN_DECLS
 #define MODEST_IS_FOLDER_VIEW_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_FOLDER_VIEW))
 #define MODEST_FOLDER_VIEW_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_FOLDER_VIEW,ModestFolderViewClass))
 
+typedef enum _ModestFolderViewStyle {
+       MODEST_FOLDER_VIEW_STYLE_SHOW_ALL,
+       MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
+} ModestFolderViewStyle;
+
 typedef struct _ModestFolderView      ModestFolderView;
 typedef struct _ModestFolderViewClass ModestFolderViewClass;
 
@@ -58,9 +63,13 @@ struct _ModestFolderViewClass {
 
        /* emitted when a folder is selected or unselected */
        void     (*folder_selection_changed) (ModestFolderView* self,
-                                             TnyFolder *folder,
+                                             TnyFolderStore *folder,
                                              gboolean selected,
                                              gpointer user_data);
+
+       void     (*folder_display_name_changed) (ModestFolderView* self,
+                                                const gchar *display_name,
+                                                gpointer user_data);
 };
 
 /**
@@ -100,16 +109,14 @@ void          modest_folder_view_set_title       (ModestFolderView *self,
  * modest_folder_view_get_selected:
  * @self: a #ModestFolderView
  * 
- * returns a new reference to the #TnyFolder that is already selected
+ * gets a new reference to the #TnyFolderStore that is already
+ * selected. The caller must free this reference
  * 
- * Returns: the selected folder or NULL if none is selected
+ * Returns: the selected #TnyFolderStore or NULL if none is selected
  **/
-TnyFolder*    modest_folder_view_get_selected    (ModestFolderView *self);
+TnyFolderStore*    modest_folder_view_get_selected    (ModestFolderView *self);
 
 
-gboolean      modest_folder_view_rename (ModestFolderView *self);
-gboolean      modest_folder_view_add_subfolder (ModestFolderView *self, TnyFolder *folder);
-
 /**
  * modest_folder_view_update_model:
  * @self: a #ModestFolderView
@@ -121,6 +128,120 @@ gboolean      modest_folder_view_add_subfolder (ModestFolderView *self, TnyFolde
 gboolean      modest_folder_view_update_model    (ModestFolderView *self,
                                                  TnyAccountStore *account_store);
 
+/**
+ * modest_folder_view_set_style:
+ * @self: a #ModestFolderView
+ * @style: a #ModestFolderViewStyle
+ * 
+ * Sets the folder view style. There are currently two available,
+ * MODEST_FOLDER_VIEW_STYLE_SHOW_ALL shows all the active accounts,
+ * and MODEST_FOLDER_VIEW_STYLE_SHOW_ONE (Maemo style) shows the local
+ * account the mmc and only one of the available active server
+ * accounts
+
+ **/
+void         modest_folder_view_set_style         (ModestFolderView *self,
+                                                  ModestFolderViewStyle style);
+
+/**
+ * modest_folder_view_set_account_id_of_visible_server_account:
+ * @self: a #ModestFolderView
+ * @account_id: the remote server account id
+ * 
+ * sets the server account id (value returned by tny_account_get_id())
+ * to the string passed as argument. The remote server with the
+ * specified id will be the unique visible account if the folder view
+ * is configured in MODEST_FOLDER_VIEW_STYLE_SHOW_ONE
+ **/
+void         modest_folder_view_set_account_id_of_visible_server_account (ModestFolderView *self,
+                                                                         const gchar *account_id);
+
+/**
+ * modest_folder_view_get_account_id_of_visible_server_account:
+ * @self: a #ModestFolderView
+ * 
+ * gets the account id of the currently visible server account id
+ * 
+ * Return value: the visible server account id or NULL if none set
+ **/
+const gchar* modest_folder_view_get_account_id_of_visible_server_account (ModestFolderView *self);
+
+
+void         modest_folder_view_select_first_inbox_or_local  (ModestFolderView *self);
+
+/**
+ * modest_folder_view_copy_selection:
+ * @self: a #ModestFolderView
+ * 
+ * Stores a #TnyList of selected folders in the own clibpoard of 
+ * @self folder view.
+ **/
+void modest_folder_view_copy_selection (ModestFolderView *folder_view);
+
+/**
+ * modest_folder_view_cut_selection:
+ * @self: a #ModestFolderView
+ * 
+ * Stores a #TnyList of selected folders in the own clibpoard of 
+ * @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);
+
+
+/**
+ * modest_folder_view_select_folder
+ * @self: a #ModestFolderView
+ * @folder: a #TnyFolder
+ * @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.
+ **/
+gboolean modest_folder_view_select_folder (ModestFolderView *self, TnyFolder *folder, gboolean after_change);
+
+/**
+ * modest_folder_view_paste_selection:
+ * @self: a #ModestFolderView
+ * @folders: ouput parameter with a #TnyList of folders which will be returned.
+ * @delete: output parameter with indication about delete or not the selected folders. 
+ * 
+ * Gets the selected folders to copy/cut.
+ **/
+void modest_folder_view_paste_selection (ModestFolderView *folder_view, TnyList **folders, gboolean *delete);
+
+/*
+ * modest_folder_view_show_non_move_folders:
+ * @self: a #ModestFolderView
+ * @show: show or hide the folders
+ * 
+ * Whether to show folders where no messages can be moved to 
+ **/
+void modest_folder_view_show_non_move_folders (ModestFolderView *folder_view, gboolean show);
+
+/*
+ * modest_folder_view_copy_model:
+ * @folder_view_src: a #ModestFolderView
+ * @folder_view_dst: a #ModestFolderView
+ * 
+ * Get model from @folder_view_src and builds a new 
+ * #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);
+
+/*
+ * 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);
+
 G_END_DECLS
 
 #endif /* __MODEST_FOLDER_VIEW_H__ */