* Replaced two confusing function names
[modest] / src / widgets / modest-folder-view.h
index 9650b28..e8845ef 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;
 
@@ -61,6 +66,10 @@ struct _ModestFolderViewClass {
                                              TnyFolder *folder,
                                              gboolean selected,
                                              gpointer user_data);
+
+       void     (*folder_display_name_changed) (ModestFolderView* self,
+                                                const gchar *display_name,
+                                                gpointer user_data);
 };
 
 /**
@@ -100,11 +109,12 @@ 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);
 
 
 /**
@@ -133,6 +143,45 @@ gboolean      modest_folder_view_update_model    (ModestFolderView *self,
  **/
 const gchar* modest_folder_view_get_selected_display_name (ModestFolderView *self);
 
+
+/**
+ * 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);
+
 G_END_DECLS
 
 #endif /* __MODEST_FOLDER_VIEW_H__ */