* cleanup: added modest_tny_folder_get_help_id, and let modest-ui-actions use that

[modest] / src / modest-tny-folder.h

diff --git a/src/modest-tny-folder.h b/src/modest-tny-folder.h
index b013d87..9526a3c 100644 (file)
--- a/src/modest-tny-folder.h
+++ b/src/modest-tny-folder.h
@@ -39,6 +39,9 @@
 
 G_BEGIN_DECLS
 
+/*  TODO: move this to tinymail */
+#define TNY_FOLDER_TYPE_INVALID -1
+
 typedef enum {
        MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE  = 1 << 1,
        MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE  = 1 << 2,
@@ -69,19 +72,6 @@ typedef enum {
  */
 TnyFolderType  modest_tny_folder_guess_folder_type   (const TnyFolder *folder);
 
-/**
- * modest_tny_folder_guess_type_from_name:
- * @folder_name: a folder name
- * 
- * determine the type of the folder. first, we see if tinymail
- * can give a specific type. if it cannot, we try to guess the
- * type, based on the name of the folder
- *
- * Note: this is a Class function, there does not require a tnyfolder instance
- *  
- * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
- */
-TnyFolderType  modest_tny_folder_guess_folder_type_from_name   (const gchar *folder_name);
 
 
 /**
@@ -139,6 +129,18 @@ TnyFolderType modest_tny_folder_get_local_or_mmc_folder_type  (TnyFolder *folder
  */
 ModestTnyFolderRules  modest_tny_folder_get_rules   (TnyFolder *folder);
 
+
+/**
+ * modest_tny_folder_get_help_id:
+ * @folder: a valid tnymail folder
+ * 
+ * get the help_id for this folder
+ *  
+ * Returns: get the help_id for this folder, or NULL in case of error
+ */
+const gchar* modest_tny_folder_get_help_id (const TnyFolder *folder);
+
+
 /**
  * modest_tny_folder_is_outbox_for_account:
  * @folder: a valid tnymail folder
@@ -191,6 +193,18 @@ gchar* modest_tny_folder_get_header_unique_id (TnyHeader *header);
 gboolean modest_tny_folder_has_subfolder_with_name (TnyFolderStore *folder,
                                                    const gchar *name);
 
+/**
+ * modest_tny_folder_is_ancestor:
+ * @folder: a #TnyFolder 
+ * @ancestor: a #TnyFolderStore
+ * 
+ * This function checks if @ancestor is an ancestor of @folder
+ * 
+ * Returns: TRUE if @ancestor is an ancestor of @folder, FALSE
+ * otherwise
+ **/
+gboolean modest_tny_folder_is_ancestor (TnyFolder *folder,
+                                       TnyFolderStore *ancestor);
 
 G_END_DECLS