X-Git-Url: http://git.maemo.org/git/?p=modest;a=blobdiff_plain;f=src%2Fmodest-tny-folder.h;h=c11f3a7b5cc9e37968cc5eacfd6cb99ba66a8f99;hp=274727d67bc4e494ee1b38fcf9ee022b8f0c7732;hb=3449c1e0b6acdd87e28263928d9cf079f075e06f;hpb=8aa037a33d83d2c05799e83182f09ac95e7fa618 diff --git a/src/modest-tny-folder.h b/src/modest-tny-folder.h index 274727d..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,21 +64,8 @@ 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); -/** - * 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 +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 @@ -179,20 +175,43 @@ TnyAccount *modest_tny_folder_get_account (TnyFolder *folder); gchar* modest_tny_folder_get_header_unique_id (TnyHeader *header); /** - * modest_tny_msg_get_header_unique_id: + * modest_tny_folder_has_subfolder_with_name: * @folder: a #TnyFolderStore - * @new_name: the new name to check into subfolders. + * @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 @new_name. + * name as @name. * - * Returns: TRUE if some subfolder has the name @new_name. + * Returns: TRUE if some subfolder has the name @name. **/ -gboolean modest_tny_folder_same_subfolder (TnyFolderStore *folder, - const gchar *new_name); - +gboolean modest_tny_folder_has_subfolder_with_name (TnyFolderStore *folder, + const gchar *name, + gboolean nonstrict); +/** + * 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); +/** + * 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