\r
/**\r
* @file FWebCtrlWebStorageManager.h\r
-* @brief This is the header file for the %WebStorageManager class.\r
+* @brief This is the header file for the %WebStorageManager class.\r
*\r
* This header file contains the declarations of the %WebStorageManager class for a %Web control.\r
*/\r
*/\r
enum WebStorageType\r
{\r
- WEB_STORAGE_TYPE_APPLICATION_CACHE, /**< The application cache: the web storage type */\r
- WEB_STORAGE_TYPE_INDEXED_DATABASE, /**< The indexed database: the web storage type */\r
- WEB_STORAGE_TYPE_WEB_SQL_DATABASE, /**< The web database: the web storage type */\r
- WEB_STORAGE_TYPE_WEB_STORAGE, /**< The web storage: the web storage type */\r
- WEB_STORAGE_TYPE_FILE_SYSTEM /**< The file system: the web storage type */\r
+ WEB_STORAGE_TYPE_APPLICATION_CACHE, /**< The web storage type: application cache */\r
+ WEB_STORAGE_TYPE_INDEXED_DATABASE, /**< The web storage type: indexed database */\r
+ WEB_STORAGE_TYPE_WEB_SQL_DATABASE, /**< The web storage type: web database */\r
+ WEB_STORAGE_TYPE_WEB_STORAGE, /**< The web storage type: web storage */\r
+ WEB_STORAGE_TYPE_FILE_SYSTEM /**< The web storage type: file system */\r
};\r
\r
/**\r
* @brief This class holds the setting values for a %Web control.\r
*\r
* @since 2.1\r
+*\r
* @final This class is not intended for extension.\r
*\r
-* The %WebStorageManager\r
+* The %WebStorageManager class holds the setting values for a %Web control.\r
*/\r
class _OSP_EXPORT_ WebStorageManager\r
: public Tizen::Base::Object\r
public:\r
\r
/**\r
- * Gets the list of origins for the given storage type.\r
- * The WEB_STORAGE_TYPE_INDEXED_DATABASE is not supported.\r
+ * Gets the list of origins for a given storage type. @n\r
+ * The @c WEB_STORAGE_TYPE_INDEXED_DATABASE is not supported.\r
*\r
* @since 2.1\r
- *\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/web.privacy\r
*\r
- * @return A pointer to IList containing origin(Tizen::Base::String) list, @n\r
- * else @c null if no web storage data exists\r
- * @param[in] storageType The web storage type\r
+ * @return A pointer to Tizen::Base::Collection::IList that contains the origin(Tizen::Base::String) list, @n\r
+ * else @c null if no web storage data exists\r
+ * @param[in] storageType The web storage type\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_UNSUPPORTED_TYPE The specified storageType is not supported.\r
+ * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Tizen::Base::Collection::IList* GetOriginListN(WebStorageType storageType) const;\r
\r
/**\r
- * Sets the default quota for the given origin for the given storage type.\r
- * Only the WEB_STORAGE_TYPE_WEB_SQL_DATABASE and the WEB_STORAGE_TYPE_APPLICATION_CACHE are supported.\r
+ * Sets the default quota for a given origin of a given storage type. @n\r
+ * Only @c WEB_STORAGE_TYPE_WEB_SQL_DATABASE and @c WEB_STORAGE_TYPE_APPLICATION_CACHE are supported.\r
*\r
* @since 2.1\r
- *\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/web.privacy\r
*\r
* @return An error code\r
- * @param[in] storageType The web storage type\r
- * @param[in] origin The origin\r
- * @param[in] quota The quota of the web storage to set in bytes\r
+ * @param[in] storageType The web storage type\r
+ * @param[in] origin The origin\r
+ * @param[in] quota The quota of the web storage to set in bytes\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c origin is invalid.\r
- * @exception E_UNSUPPORTED_TYPE The specified storageType is not supported.\r
+ * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
*/\r
result SetQuotaForOrigin(WebStorageType storageType, const Tizen::Base::String& origin, long quota);\r
\r
\r
/**\r
- * Gets the quota for the given origin for the given storage type.\r
- * Only the WEB_STORAGE_TYPE_WEB_SQL_DATABASE is supported.\r
+ * Gets the quota for a given origin of a given storage type. @n\r
+ * Only @c WEB_STORAGE_TYPE_WEB_SQL_DATABASE is supported.\r
*\r
* @since 2.1\r
- *\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/web.privacy\r
*\r
* @return The usage of the web storage in bytes\r
- * @param[in] storageType The web storage type\r
- * @param[in] origin The origin\r
+ * @param[in] storageType The web storage type\r
+ * @param[in] origin The origin\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c origin is invalid.\r
- * @exception E_UNSUPPORTED_TYPE The specified storageType is not supported.\r
+ * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
*/\r
long GetQuotaForOrigin(WebStorageType storageType, const Tizen::Base::String& origin);\r
\r
/**\r
- * Gets the usage for the given origin for the given storage type.\r
- * The WEB_STORAGE_TYPE_INDEXED_DATABASE and the WEB_STORAGE_TYPE_FILE_SYSTEM are not supported.\r
+ * Gets the usage for a given origin of a given storage type. @n\r
+ * @c WEB_STORAGE_TYPE_INDEXED_DATABASE and @c WEB_STORAGE_TYPE_FILE_SYSTEM are not supported.\r
*\r
* @since 2.1\r
- *\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/web.privacy\r
*\r
* @return The usage of the web storage in bytes\r
- * @param[in] storageType The web storage type\r
- * @param[in] origin The origin\r
+ * @param[in] storageType The web storage type\r
+ * @param[in] origin The origin\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c origin is invalid.\r
- * @exception E_UNSUPPORTED_TYPE The specified storageType is not supported.\r
+ * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
long GetUsageForOrigin(WebStorageType storageType, const Tizen::Base::String& origin) const;\r
\r
/**\r
- * Removes the data for the given origin for the given storage type.\r
- * The WEB_STORAGE_TYPE_INDEXED_DATABASE is not supported.\r
+ * Removes the data for a given origin of a given storage type. @n\r
+ * @c WEB_STORAGE_TYPE_INDEXED_DATABASE is not supported.\r
*\r
* @since 2.1\r
- *\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/web.privacy\r
*\r
* @return An error code\r
- * @param[in] storageType The web storage type\r
- * @param[in] origin The origin\r
+ * @param[in] storageType The web storage type\r
+ * @param[in] origin The origin\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_INVALID_ARG The specified @c origin is invalid.\r
- * @exception E_UNSUPPORTED_TYPE The specified storageType is not supported.\r
+ * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @see RemoveAll()\r
*/\r
result Remove(WebStorageType storageType, const Tizen::Base::String& origin);\r
\r
/**\r
- * Removes all data for the given storage type.\r
+ * Removes all the data of a given storage type.\r
*\r
* @since 2.1\r
- *\r
* @privlevel public\r
* @privilege %http://tizen.org/privilege/web.privacy\r
*\r
* @return An error code\r
- * @param[in] storageType The web storage type\r
+ * @param[in] storageType The web storage type\r
* @exception E_SUCCESS The method is successful.\r
- * @exception E_UNSUPPORTED_TYPE The specified storageType is not supported.\r
+ * @exception E_UNSUPPORTED_TYPE The specified @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @see Remove()\r
*/\r
result RemoveAll(WebStorageType storageType);\r
\r
/**\r
- * Gets the web storage manager instance.\r
+ * Gets a web storage manager instance.\r
*\r
* @since 2.1\r
*\r
- *\r
* @return A pointer to the %WebStorageManager instance, @n\r
- * else @c null if it fails\r
+ * else @c null if it fails\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_OUT_OF_MEMORY The memory is insufficient.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
projects / framework / osp / web.git / blobdiff