X-Git-Url: http://git.maemo.org/git/?a=blobdiff_plain;f=src%2Fmodest-tny-folder.h;h=c2c812e47fcbff96d55efcccd477fda7fda8e2a5;hb=94945a4ee31acfc11dbd1aedf0514ca833c708ee;hp=fb043406c7b94d5c72005a17b4cd1e7343878c4a;hpb=31bb0518a45f4ca59a30a650475d3a3f9ff87610;p=modest

diff --git a/src/modest-tny-folder.h b/src/modest-tny-folder.h
index fb04340..c2c812e 100644
--- a/src/modest-tny-folder.h
+++ b/src/modest-tny-folder.h
@@ -40,10 +40,23 @@
 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;
 
+/** 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
@@ -80,8 +93,18 @@ TnyFolderType  modest_tny_folder_guess_folder_type_from_name   (const gchar *fol
  *  
  * Returns: TRUE if it's a local folder, FALSE otherwise
  */
-gboolean modest_tny_folder_is_local_folder   (const TnyFolder *folder);
+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:
@@ -91,8 +114,7 @@ gboolean modest_tny_folder_is_local_folder   (const TnyFolder *folder);
  *  
  * Returns: TRUE if it's a local folder, FALSE otherwise
  */
-TnyFolderType modest_tny_folder_get_local_folder_type  (const TnyFolder *folder);
-
+TnyFolderType modest_tny_folder_get_local_folder_type  (TnyFolder *folder);
 
 
 /**
@@ -105,12 +127,47 @@ TnyFolderType modest_tny_folder_get_local_folder_type  (const TnyFolder *folder)
  * Returns: the ModestTnyFolderRules rules (bitwise-OR) for this
  * folder
  */
-ModestTnyFolderRules  modest_tny_folder_get_rules   (const TnyFolder *folder);
-
-
-
+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, that's it
+ * a TnyHeader retrieved with tny_folder_get_headers (you can not use
+ * the TnyHeader returned by tny_msg_get_header because it has not an
+ * 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