Modified webpage: now tinymail repository is in gitorious.

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

diff --git a/src/modest-tny-folder.h b/src/modest-tny-folder.h
index 6f2ec64..cdfccf3 100644 (file)
--- a/src/modest-tny-folder.h
+++ b/src/modest-tny-folder.h
@@ -53,13 +53,7 @@ typedef enum {
  * 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
@@ -70,7 +64,7 @@ typedef enum {
  *  
  * Returns: the folder type, or TNY_FOLDER_TYPE_UNKNOWN
  */
-TnyFolderType  modest_tny_folder_guess_folder_type   (const TnyFolder *folder);
+TnyFolderType  modest_tny_folder_guess_folder_type   (TnyFolder *folder);
 
 
 
@@ -129,6 +123,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 (TnyFolder *folder);
+
+
 /**
  * modest_tny_folder_is_outbox_for_account:
  * @folder: a valid tnymail folder
@@ -172,6 +178,8 @@ gchar* modest_tny_folder_get_header_unique_id (TnyHeader *header);
  * modest_tny_folder_has_subfolder_with_name:
  * @folder: a #TnyFolderStore 
  * @name: the name to check into subfolders.
+ * @nonstrict: if TRUE, also match on different-case and current-locale
+ * display versions of the name
  *   
  * This function check if subfolders of @folder has the same
  * name as @name.
@@ -179,7 +187,8 @@ gchar* modest_tny_folder_get_header_unique_id (TnyHeader *header);
  * Returns: TRUE if some subfolder has the name @name.
  **/
 gboolean modest_tny_folder_has_subfolder_with_name (TnyFolderStore *folder,
-                                                   const gchar *name);
+                                                   const gchar *name,
+                                                   gboolean nonstrict);
 
 /**
  * modest_tny_folder_is_ancestor:
@@ -194,6 +203,29 @@ gboolean modest_tny_folder_has_subfolder_with_name (TnyFolderStore *folder,
 gboolean modest_tny_folder_is_ancestor (TnyFolder *folder,
                                        TnyFolderStore *ancestor);
 
+/**
+ * modest_tny_folder_store_find_folder_from_uri:
+ * @folder_store: a #TnyFolderStore
+ * @uri: a string
+ *
+ * This method tries to find a folder in @folder_store. The idea is
+ * being as fast as possible being synchronous. This is accomplished
+ * avoiding network access.
+ *
+ * Returns: %NULL if folder is not found, or a #TnyFolder.
+ */
+TnyFolder *modest_tny_folder_store_find_folder_from_uri (TnyFolderStore *folder_store, const gchar *uri);
+
+/**
+ * modest_tny_folder_get_display_name:
+ * @folder: a #TnyFolder
+ *
+ * obtain the display name for @folder
+ *
+ * Returns: a newly allocated string
+ */
+gchar * modest_tny_folder_get_display_name (TnyFolder *folder);
+
 G_END_DECLS
 
 #endif /* __MODEST_TNY_FOLDER_H__*/