/**
* A unique ID. This ID is unique within a local storage only. @n
- * @c RecordId is assigned by the local storage when a record is saved to the storage. @n
+ * @c RecordId is assigned by the local storage when a record is saved to the storage.
*
*
* @since 2.1
/**
* The root folder ID. @n
- * In fact, it is symbolic value because the root folder record doesn't exist physically.
+ * In fact, it is a symbolic value because the root folder record does not exist physically.
*
* @since 2.1
*/
* @brief This class is used for accessing a bookmark item stored in the WebBookmark class.
*
* @since 2.1
+*
* @final This class is not intended for extension.
*
* The %BookmarkItem class provides access to the WebBookmark class.
-* Each item contains the title, the URL of the page, the item type and parent folder id.
+* Each item contains the title, the URL of the page, the item type, and the parent folder ID.
*/
class _OSP_EXPORT_ BookmarkItem
: public Tizen::Base::Object
* @since 2.1
*
* @return The URL of the current bookmark item @n
- * If the item type is folder, this method will return the empty string.
+ * If the item type is folder, this method will return an empty string.
* @see IsFolder()
*/
Tizen::Base::String GetUrl(void) const;
/**
- * Gets the favicon image from current bookmark item.
+ * Gets the favicon image from the current bookmark item.
*
* @since 2.1
*
* @return The image
- *
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM Either of the following conditions has occurred: @n
* - The method cannot proceed due to a severe system error. @n
- * - The method has failed because it doesn't work on a service application.
+ * - The method has failed because it does not work on a service application.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetFaviconN(void) const;
/**
- * Gets the parent folder id of the current bookmark item.
+ * Gets the parent folder ID of the current bookmark item.
*
* @since 2.1
*
- * @return The parent folder id of the current bookmark item @n
+ * @return The parent folder ID of the current bookmark item @n
* If the current bookmark item is the one in topmost level, this method will return ::ROOT_FOLDER_ID.
*/
RecordId GetParentFolderId(void) const;
/**
- * Checks whether the type of current bookmark item is folder or not.
+ * Checks whether the type of the current bookmark item is folder or not.
*
* @since 2.1
*
- * @return @c true if the type of current bookmark item is folder, @n
+ * @return @c true if the type of the current bookmark item is folder, @n
* else @c false
*/
bool IsFolder(void) const;
* @remarks @b Header @b %file: @b \#include @b <FWeb.h> @n
* @b Library : @b osp-web
*
- * The %Web::Controls namespace allows you to embed the %Web browser as a control within an application, to upload and download content, and retrieve the HyperText Markup Language (HTML) element and history details.
+ * The %Controls namespace allows you to embed the %Web browser as a control within an application, to upload and download content, and retrieve the HyperText Markup Language (HTML) element and history details.
* @n
* For more information on the %Controls namespace features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
*
* Sends the user ID and password to the host.
*
* @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/web.service
*
- * @privlevel public
- * @privilege %http://tizen.org/privilege/web.service
- *
- * @param[in] userId The user ID for authentication
- * @param[in] password The password for authentication
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @param[in] userId The user ID for authentication
+ * @param[in] password The password for authentication
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void Process(const UserId& userId, const Tizen::Base::String& password);
* Cancels the authentication request.
*
* @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/web.service
*
- * @privlevel public
- * @privilege %http://tizen.org/privilege/web.service
- *
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void Cancel(void);
* Gets the origin list stored at the geolocation database.\r
*\r
* @since 2.0\r
- *\r
* @privlevel platform\r
* @privilege %http://tizen.org/privilege/geolocationpermission.read\r
*\r
* Checks whether geolocation permission is allowed or not for the specified @c origin.\r
*\r
* @since 2.0\r
- *\r
* @privlevel platform\r
* @privilege %http://tizen.org/privilege/geolocationpermission.read\r
*\r
* Removes the geolocation data for the specified @c origin.\r
*\r
* @since 2.0\r
- *\r
* @privlevel platform\r
* @privilege %http://tizen.org/privilege/geolocationpermission.write\r
*\r
* Removes all elements in the list.\r
* \r
* @since 2.0\r
- *\r
* @privlevel platform\r
* @privilege %http://tizen.org/privilege/geolocationpermission.write\r
*\r
virtual void HandleJavaScriptRequestN(Tizen::Web::Json::IJsonValue* pArg) = 0;
/**
- * Provides the name of %IJavaScriptBridge to identify each %IJavaScriptBridge
+ * Gets the name of %IJavaScriptBridge to identify each %IJavaScriptBridge.
*
* @since 2.0
*
* @since 2.0
*
* @param[in] error The error that occurred during loading
- * @param[in] reason The reason for the loading failure, @n
- * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404" @n
- * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported @n
- * - @c WEB_BAD_URL: The URL is incorrect
+ * @param[in] reason The reason for the loading failure:
+ * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404"
+ * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported.
+ * - @c WEB_BAD_URL: The URL is incorrect.
*/
virtual void OnLoadingErrorOccurred(LoadingErrorType error, const Tizen::Base::String& reason) = 0;
*
* @since 2.0
*
- * @param[in] progress The progress rate ranging from [@c 0 ~ @c 100]
+ * @param[in] progress The progress rate ranging from [@c 0 to @c 100]
*/
virtual void OnEstimatedProgress(int progress) = 0;
/**
- * Called when the title of the new page has been received.
+ * Called when the title of the new page is received.
*
* @since 2.0
*/
virtual DecisionPolicy OnWebDataReceived(const Tizen::Base::String& mime, const Tizen::Net::Http::HttpHeader& httpHeader) = 0;
/**
- * Called when the favicon of the new page has been received. @n
- * If receiving this callback the once, an application can get favicon by using Tizen::Web::Controls::GetFaviconN().
+ * Called when the favicon of the new page is received. @n
+ * If this callback is received once, an application can get favicon by using Tizen::Web::Controls::GetFaviconN().
*
* @since 2.1
*
- * @param[in] favicon The image
+ * @param[in] favicon The favicon image
* @see Tizen::Web::Controls::GetFaviconN()
*/
virtual void OnFaviconReceived(const Tizen::Graphics::Bitmap& favicon) {}
virtual void OnWebPageBlockSelected(Tizen::Web::Controls::Web& source, Tizen::Graphics::Point& startPoint, Tizen::Graphics::Point& endPoint) = 0;
/**
- * Called just after touch move event whether preventDefault() method is triggered or not. @n
- * The application which wants to support W3C preventDefault() feature is recommended to use this callback and delay to handle touch move event until receiving this callback if needed.
+ * Called just after the touch move event to determine whether the preventDefault() method is triggered or not. @n
+ * The application that wants to support W3C preventDefault() feature is recommended to use this callback and delay to handle the touch move event until this callback is received.
*
* @since 2.1
*
* @param[in] source The source of the event
* @param[in] trigger Set to @c true if the preventDefault() method is triggered, @n
* else @c false
- * @remarks This callback is always called just after touch move event and return true when preventDefault() is triggered on touch start or touch move event.
+ * @remarks This callback is always called just after the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event.
*/
virtual void OnWebPreventDefaultTriggered(Tizen::Web::Controls::Web& source, bool trigger) {};
/**\r
* Called when a request for closing the window is received. @n\r
* This event is called from the parent window's listener that invoked the child window. @n\r
- * The application must free the resource allocated for the %Web Control.\r
+ * The application must free the resource allocated for the %Web control.\r
*\r
* @since 2.1\r
*\r
virtual void OnWebPageBlockSelected(Tizen::Web::Controls::Web& source, Tizen::Graphics::FloatPoint& startPoint, Tizen::Graphics::FloatPoint& endPoint) = 0;\r
\r
/**\r
- * Called just after touch move event whether preventDefault() method is triggered or not. @n\r
- * The application which wants to support W3C preventDefault() feature is recommended to use this callback and delay to handle touch move event until receiving this callback if needed.\r
+ * Called just after the touch move event to determine whether the preventDefault() method is triggered or not. @n\r
+ * The application that wants to support W3C preventDefault() feature is recommended to use this callback and delay to handle the touch move event until this callback is received.\r
*\r
* @since 2.1\r
*\r
* @param[in] source The source of the event\r
* @param[in] trigger Set to @c true if the preventDefault() method is triggered, @n\r
* else @c false\r
- * @remarks This callback is always called just after touch move event and return true when preventDefault() is triggered on touch start or touch move event.\r
+ * @remarks This callback is always called just after the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event.\r
*/\r
virtual void OnWebPreventDefaultTriggered(Tizen::Web::Controls::Web& source, bool trigger) {};\r
\r
{
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
*/
* Initializes this instance of the %Web control with the specified parameters.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Initializes this instance of the %Web control with the specified parameters.
*
* @since 2.1
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Loads the resource specified by the URL.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
void LoadUrl(const Tizen::Base::String& url);
/**
- * Loads the resource specified by the URL with the given header of HTTP request.
+ * Loads the resource specified by the URL with a given header of HTTP request.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
result LoadUrl(const Tizen::Base::String& url, const Tizen::Net::Http::HttpHeader& header);
/**
- * Load the resource specified by the URL with the given header and body of HTTP request. @n
+ * Loads the resource specified by the URL with a given header and body of HTTP request. @n
* The header must include content-type entity-header field that is needed to check mime-type of the message body.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Loads the content of the specified buffer.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @param[in] mime The MIME type of the content
* @param[in] encoding The <a href= "../org.tizen.native.appprogramming/html/guide/web/supported_web_features.htm">text encoding</a> of the content
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The content buffer is empty @b Since: @b 2.1
+ * @exception E_INVALID_ARG The content buffer is empty. @b Since: @b 2.1
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
* Stops the current loading operation.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Reloads the current page.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Goes to the back history of the current %Web control.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Goes to the forward history of the current %Web control.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* It fails to change the setting during data load.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Evaluates the JavaScript string and returns the result.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Sets a load event listener.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Sets a download event listener.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
* @param[in] startPoint The starting point for the text selection block
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG There is nothing to select from the starting point specified.
+ * @exception E_INVALID_ARG There is nothing to select from the specified starting point.
*/
result SetBlockSelectionPosition(const Tizen::Graphics::Point& startPoint);
* @return An error code
* @param[in] startPoint The starting point for the text selection block
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG There is nothing to select from the starting point specified.
+ * @exception E_INVALID_ARG There is nothing to select from the specified starting point.
*/
result SetBlockSelectionPosition(const Tizen::Graphics::FloatPoint& startPoint);
* @param[in] enable Set to @c true to enable the scrolling of the web page, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @remarks This method doesn't affect javascript touch event.
+ * @remarks This method does not affect javascript touch event.
*/
result SetScrollEnabled(bool enable);
* Sets the private browsing and returns the result.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Clears the back and forward navigation list.
*
* @since 2.1
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Clears the application's cache.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Clears the application's cookie.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Clears the application's all stored form datas.
*
* @since 2.1
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
result ClearFormData(void);
/**
- * Clears the application's all stored id/password datas.
+ * Clears the application's all stored ID/password datas.
*
* @since 2.1
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* Enables or disables a cookie.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @since 2.0
*
* @return An error code
- *
* @param[in] text The string to search for
* @param[in] caseSensitive Set to @c true to search for the text with case-sensitive mode, @n
* else @c false to search for the text in the backward direction from the current position
* @since 2.0
*
* @return An error code
- *
* @param[in] searchForward Set to @c true to search for the text in the forward direction from the current position, @n
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The next instance is not found.
Tizen::Graphics::Point GetScrollPosition(void) const;
/**
- * Gets the real size of the current web page.
+ * Gets the size of the current web page.
*
* @since 2.1
*
* Sets a cache control strategy for a %Web control.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
/**
* Gets the value of the cache control strategy for a %Web control. @n
- * The default is @c WEB_CACHE_VALIDATED.
+ * The default value is @c WEB_CACHE_VALIDATED.
*
* @since 2.0
*
/**
* Gets the font size of the content. @n
- * The default is @c 17.
+ * The default size is @c 17.
*
* @since 2.0
*
/**
* Gets the text encoding of the content of a %Web control. @n
- * The default is UTF-8.
+ * The default encoding is UTF-8.
*
* @since 2.0
*
/**
* Checks whether a %Web control uses JavaScript. @n
- * The default is true.
+ * The default value is @c true.
*
* @since 2.0
*
/**
* Checks whether a %Web control loads images included in the content automatically. @n
- * The default is true.
+ * The default value is @c true.
*
* @since 2.0
*
/**
* Gets the input style of the keypad, which is displayed for the <input> or <textarea> tag. @n
- * The default is @c INPUT_STYLE_FULLSCREEN.
+ * The default style is @c INPUT_STYLE_FULLSCREEN.
*
* @since 2.0
*
/**
* Gets the value of the certificate error handling mode for a %Web control. @n
- * The default is @c WEB_CERTIFICATE_ERROR_HANDLING_MODE_USER_CONFIRM.
+ * The default value is @c WEB_CERTIFICATE_ERROR_HANDLING_MODE_USER_CONFIRM.
*
* @since 2.0
*
/**
* Checks whether a %Web control loads the resize contents to fit width. @n
- * The default is true.
+ * The default value is @c true.
*
* @since 2.0
*
void SetJavaScriptPopupEnabled(bool enable);
/**
- * Checks whether a %Web control allows JavaScript to open new window. Returns true if opening new window by JavaScript is enabled. @n
- * The default is true.
+ * Checks whether a %Web control allows JavaScript to open new window. @n Returns @c true if opening new window by JavaScript is enabled.
+ * The default value is @c true.
*
* @since 2.0
*
* Decides if a %Web control supports html5 geolocation feature.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
void SetGeolocationEnabled(bool enable);
/**
- * Checks whether a %Web control supports html5 geolocation feature. Returns true if html5 geolocation feature is enabled. @n
- * The default is true.
+ * Checks whether a %Web control supports html5 geolocation feature. @n Returns @c true if html5 geolocation feature is enabled.
+ * The default value is @c true.
*
* @since 2.0
*
* Decides if a %Web control saves form data automatically and supports autocomplete feature.
*
* @since 2.1
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
void SetAutoFormDataShowEnabled(bool enable);
/**
- * Checks whether %Web control saves form data automatically and supports autocomplete feature. Returns true if those are enabled. @n
- * The default is true.
+ * Checks whether %Web control saves form data automatically and supports autocomplete feature. @n Returns @c true if those are enabled.
+ * The default value is @c true.
*
* @since 2.1
*
bool IsAutoFormDataShowEnabled(void) const;
/**
- * Decides if a %Web control saves id/password for login form automatically and supports autofill feature.
+ * Decides if a %Web control saves ID/password for login form automatically and supports autofill feature.
*
* @since 2.1
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] enable Set to @c true if the %Web control should save login id/password automatically and supports autofill feature, @n
+ * @param[in] enable Set to @c true if the %Web control should save login ID/password automatically and supports autofill feature, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
void SetAutoLoginFormFillEnabled(bool enable);
/**
- * Checks whether %Web control saves id/password for login form automatically and supports autofill feature. Returns true if those are enabled. @n
- * The default is true.
+ * Checks whether %Web control saves ID/password for login form automatically and supports autofill feature. @n Returns @c true if those are enabled.
+ * The default value is @c true.
*
* @since 2.1
*
- * @return @c true if saving id/password for login form and autofill feature are enabled, @n
+ * @return @c true if saving ID/password for login form and autofill feature are enabled, @n
* else @c false
*/
bool IsAutoLoginFormFillEnabled(void) const;
*/\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
* 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 for a given storage type. @n\r
+ * Only the @c WEB_STORAGE_TYPE_WEB_SQL_DATABASE and the @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
* @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 for a given storage type. @n\r
+ * Only the @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
* @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 for a given storage type. @n\r
+ * The @c WEB_STORAGE_TYPE_INDEXED_DATABASE and the @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
* @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 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
* @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 data for 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
* @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
*\r
* @since 2.1\r
*\r
- *\r
* @return A pointer to the %WebStorageManager instance, @n\r
* else @c null if it fails\r
* @exception E_SUCCESS The method is successful.\r
Tizen::Base::String GetUrl(void) const;
/**
- * Gets the favicon image from HistoryItem.
+ * Gets the favicon image from %HistoryItem.
*
* @since 2.0
*
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM Either of the following conditions has occurred: @n
* - The method cannot proceed due to a severe system error. @n
- * - The method has failed because it doesn't work on a service application.
+ * - The method has failed because it does not work on a service application.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetFaviconN(void) const;
/**
* @file FWebWebBookmark.h
-* @brief This is the header file for the % WebBookmark class.
+* @brief This is the header file for the %WebBookmark class.
*
-* This header file contains the declarations of the % WebBookmark class.
+* This header file contains the declarations of the %WebBookmark class.
*/
#ifndef _FWEB_WEB_BOOKMARK_H_
* @brief This class provides methods to manage bookmark items of the browser.
*
* @since 2.1
+ *
* @final This class is not intended for extension.
*
* The %WebBookmark class provides methods to get bookmark information of the browser and organize it.
- * The bookmark system has hierarchical structure with the parent folder id supporting multiple folders and The bookmark items are represented by the BookmarkItem class. @n
+ * The bookmark system has hierarchical structure with the parent folder ID supporting multiple folders and the bookmark items are represented by the BookmarkItem class. @n
* If you use these APIs to backup and restore the bookmark, add bookmark items and folders recursively from the topmost level.
*/
class _OSP_EXPORT_ WebBookmark
{
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. *
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.1
*/
* Adds a bookmark folder.
*
* @since 2.1
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/bookmark.write
*
* @return An error code
* @param[in] title The title of bookmark item
- * @param[out] folderId The current folder id
- * @param[in] parentId The parent folder id
+ * @param[out] folderId The current folder ID
+ * @param[in] parentId The parent folder ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified title is an empty string. @n
- * - The specified parentId is invalid..
- * @exception E_OBJ_ALREADY_EXIST A folder with the same title and parent id already exists.
+ * - The specified @c parentId is invalid.
+ * @exception E_OBJ_ALREADY_EXIST A folder with the same title and parent ID already exists.
* @exception E_SYSTEM The method has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see BookmarkItem::GetParentFolderId()
/**
- * Adds a bookmark contents.
+ * Adds bookmark contents.
*
* @since 2.1
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/bookmark.write
*
* @return An error code
* @param[in] title The title of bookmark item
- * @param[in] url The url of bookmark item
- * @param[out] bookmarkId The current bookmark id
- * @param[in] parentId The parent folder id
+ * @param[in] url The URL of bookmark item
+ * @param[out] bookmarkId The current bookmark ID
+ * @param[in] parentId The parent folder ID
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
- * - The specified title is an empty string. @n
- * - The specified url is an empty string. @n
- * - The specified folderId is invalid.
- * @exception E_OBJ_ALREADY_EXIST A folder with the same title and parent id already exists.
+ * - The specified @c title is an empty string. @n
+ * - The specified @c url is an empty string. @n
+ * - The specified @c parentId is invalid.
+ * @exception E_OBJ_ALREADY_EXIST A folder with the same title and parent ID already exists.
* @exception E_SYSTEM The method has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see BookmarkItem::GetParentFolderId()
* Sets a favicon.
*
* @since 2.1
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/bookmark.write
*
* @return An error code
- * @param[in] bookmarkId The bookmark id
+ * @param[in] bookmarkId The bookmark ID
* @param[in] favicon The favicon image
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified bookmarkId is invalid.
- * @exception E_INVALID_DATA The specified favicon data is invalid.
+ * @exception E_INVALID_ARG The specified @c bookmarkId is invalid.
+ * @exception E_INVALID_DATA The specified @c favicon data is invalid.
* @exception E_SYSTEM The method has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see BookmarkItem::GetFavicon()
result SetFavicon(RecordId bookmarkId, const Tizen::Graphics::Bitmap& favicon);
/**
- * Gets the bookmark item pointed to by the specified index.
+ * Gets the bookmark item pointed to by the specified @c index.
*
* @since 2.1
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/bookmark.read
*
- * @return The bookmark item at the specified index
+ * @return The bookmark item at the specified @c index
* @param[in] index The index of an element @n
- * The value of the index must be greater than or equal to @c 0.
+ * The value of the @c index must be greater than or equal to @c 0.
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of range.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
* Gets the total number of items.
*
* @since 2.1
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/bookmark.read
*
* Removes all elements.
*
* @since 2.1
- *
* @privlevel platform
* @privilege %http://tizen.org/privilege/bookmark.write
*
{
public:
/**
- * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor.
+ * The object is not fully constructed after this constructor is called. @n
+ * For full construction, the Construct() method must be called right after calling this constructor.
*
* @since 2.0
*/
projects / framework / osp / web.git / commitdiff