X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-tny-folder.h;h=c11f3a7b5cc9e37968cc5eacfd6cb99ba66a8f99;hp=0ae722c7e47cdb4e2256decd2f3dc58c2155e18a;hb=00843109d0342129e01ba4b4848ad89eea5fe3e7;hpb=1a4b6bce7dcf450e194555b90ff3c887a23400f4 diff --git a/src/modest-tny-folder.h b/src/modest-tny-folder.h index 0ae722c..c11f3a7 100644 --- 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, @@ -50,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 @@ -67,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); @@ -126,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 @@ -169,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. @@ -176,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: @@ -191,6 +203,16 @@ gboolean modest_tny_folder_has_subfolder_with_name (TnyFolderStore *folder, gboolean modest_tny_folder_is_ancestor (TnyFolder *folder, TnyFolderStore *ancestor); +/** + * 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__*/