X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-tny-folder.h;h=46df4676ca67774975f2c177049cac5aca12c153;hp=0ace9ac7b4707ab81d825cb806f57b1a15a50ac5;hb=40a8f5cbe03bd040fe3403dbfa6806df4fb6bc8a;hpb=d2ccacc82b0f9d49e38cccb7aa227e31e7f29995

diff --git a/src/modest-tny-folder.h b/src/modest-tny-folder.h
index 0ace9ac..46df467 100644
--- a/src/modest-tny-folder.h
+++ b/src/modest-tny-folder.h
@@ -35,28 +35,28 @@
 #define __MODEST_TNY_FOLDER_H__
 
 #include <tny-folder.h>
+#include <modest-local-folder-info.h>
 
 G_BEGIN_DECLS
 
 typedef enum {
-	MODEST_FOLDER_RULES_FOLDER_READ_ONLY = 0 << 1,
-	MODEST_FOLDER_RULES_FOLDER_DELETABLE 
+	MODEST_FOLDER_RULES_FOLDER_NON_WRITEABLE  = 1 << 1,
+	MODEST_FOLDER_RULES_FOLDER_NON_DELETABLE  = 1 << 2,
+	MODEST_FOLDER_RULES_FOLDER_NON_MOVEABLE   = 1 << 3,
+	MODEST_FOLDER_RULES_FOLDER_NON_RENAMEABLE = 1 << 4,
 } ModestTnyFolderRules;
 
-typedef enum {
-	MODEST_LOCAL_FOLDER_TYPE_UNKNOWN,
-	
-	MODEST_LOCAL_FOLDER_TYPE_DRAFTS,
-	MODEST_LOCAL_FOLDER_TYPE_SENT,
-	MODEST_LOCAL_FOLDER_TYPE_OUTBOX,
-	MODEST_LOCAL_FOLDER_TYPE_ARCHIVE,
-	MODEST_LOCAL_FOLDER_TYPE_JUNK,
-	MODEST_LOCAL_FOLDER_TYPE_TRASH,
-	
-	MODEST_LOCAL_FOLDER_TYPE_NUM	
-} ModestLocalFolderType;
-
-
+/** Note: This is not a derived TnyFolder type. These are just convenience 
+ * functions for working with a TnyFolder. tinymail does not seem to offer any 
+ * easy way to cause derived TnyFolders to be instantiated.
+ */
+ 
+/* TODO: These "const TnyFolder*" arguments will eventually need to 
+ * be "TnyFolder*". C cannot support constness for complex objects like C++ 
+ * can, because it lacks the mutable keyword and doesn't allow both const 
+ * and non-const get function overloads.
+ */
+ 
 /**
  * modest_tny_folder_guess_type:
  * @folder: a valid tnymail folder
@@ -84,6 +84,39 @@ TnyFolderType  modest_tny_folder_guess_folder_type   (const TnyFolder *folder);
 TnyFolderType  modest_tny_folder_guess_folder_type_from_name   (const gchar *folder_name);
 
 
+
+/**
+ * modest_tny_folder_is_local_folder:
+ * @folder: a valid tnymail folder
+ * 
+ * checks if the folder is part of the "local folders" pseudo-account
+ *  
+ * Returns: TRUE if it's a local folder, FALSE otherwise
+ */
+gboolean modest_tny_folder_is_local_folder   (TnyFolder *folder);
+
+/**
+ * modest_tny_folder_is_memory_card_folder:
+ * @folder: a valid tnymail folder
+ * 
+ * checks if the folder is part of the memory card account.
+ *  
+ * Returns: TRUE if it's a memory card folder, FALSE otherwise
+ */
+gboolean
+modest_tny_folder_is_memory_card_folder   (TnyFolder *folder);
+
+/**
+ * modest_tny_folder_get_local_folder_type:
+ * @folder: a valid tnymail folder
+ * 
+ * checks if the folder is part of the "local folders" pseudo-account
+ *  
+ * Returns: TRUE if it's a local folder, FALSE otherwise
+ */
+TnyFolderType modest_tny_folder_get_local_or_mmc_folder_type  (TnyFolder *folder);
+
+
 /**
  * modest_tny_folder_get_rules:
  * @folder: a valid tnymail folder
@@ -94,15 +127,46 @@ TnyFolderType  modest_tny_folder_guess_folder_type_from_name   (const gchar *fol
  * Returns: the ModestTnyFolderRules rules (bitwise-OR) for this
  * folder
  */
-ModestTnyFolderRules  modest_tny_folder_get_rules   (const TnyFolder *folder);
-
-
-/* some class-function (ie. don't require TnyFolder* */
-ModestLocalFolderType modest_tny_folder_get_local_folder_type (const gchar *name);
-const gchar* modest_tny_folder_get_local_folder_type_name (ModestLocalFolderType type);
-const gchar* modest_tny_folder_get_local_folder_type_display_name (ModestLocalFolderType type);
+ModestTnyFolderRules  modest_tny_folder_get_rules   (TnyFolder *folder);
 
+/**
+ * modest_tny_folder_is_outbox_for_account:
+ * @folder: a valid tnymail folder
+ * 
+ * Discover whether this folder is the per-account outbox for the specified 
+ * account.
+ *  
+ * Returns: TRUE if this folder is the per-account outbox for the account.
+ */
+gboolean modest_tny_folder_is_outbox_for_account (TnyFolder *folder, 
+						  TnyAccount *account);
+					
+/**
+ * modest_tny_folder_get_account:
+ * @folder: a folder
+ * 
+ * Get the parent account of the folder or, for TnyMergeFolder 
+ * instances, get the local-folders account.
+ *  
+ * Returns: the account. You should call g_object_unref() on this.
+ */	  
+TnyAccount *modest_tny_folder_get_account (TnyFolder *folder);
 
+/**
+ * modest_tny_msg_get_header_unique_id:
+ * @header: a #TnyHeader
+ * 
+ * This function returns a unique id for a message summary from 
+ * a TnyHeader retrieved with tny_folder_get_headers. You can not use
+ * the TnyHeader returned by tny_msg_get_header because it has no uid.
+ *
+ * This uid is built from the folder URL string and the header uid,
+ * the caller of the function must free the unique id when no longer
+ * needed
+ * 
+ * Returns: a unique identificator for a header object
+ **/
+gchar* modest_tny_folder_get_header_unique_id (TnyHeader *header);
 
 G_END_DECLS