/**
* @class BookmarkItem
-* @brief This class is used for accessing a bookmark item stored in the WebBookmark class.
+* @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 the parent folder ID.
+* Each item contains the title, the URL of a page, the item type, and the parent folder ID.
*/
class _OSP_EXPORT_ BookmarkItem
: public Tizen::Base::Object
*
* @since 2.1
*
- * @param[in] rhs An instance of %BookmarkItem
+ * @param[in] rhs An instance of %BookmarkItem to copy
*/
BookmarkItem(const BookmarkItem& rhs);
* @since 2.1
*
* @return The URL of the current bookmark item @n
- * If the item type is folder, this method will return an empty string.
+ * If the item type is folder, this method returns an empty string.
* @see IsFolder()
*/
Tizen::Base::String GetUrl(void) const;
*
* @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
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetFaviconN(void) const;
* @since 2.1
*
* @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.
+ * If the current bookmark item is the one at the topmost level, this method returns ::ROOT_FOLDER_ID.
*/
RecordId GetParentFolderId(void) const;
* @since 2.1
*
* @return @c true if the type of the current bookmark item is folder, @n
- * else @c false
+ * else @c false
*/
bool IsFolder(void) const;
* @since 2.1
*
* @return @c true if the two instances match, or if and only if the two instances contain the same elements, @n
- * else @c false @n
+ * else @c false
* @param[in] obj The object to compare with the current instance
* @see Tizen::Base::Object::Equals()
*/
*
* @since 2.1
*
- * @param[in] rhs The instance of the %BookmarkItem class to assign from
+ * @param[in] rhs An instance of the %BookmarkItem class to assign
*/
BookmarkItem& operator =(const BookmarkItem& rhs);
* @remarks @b Header @b %file: @b \#include @b <FWeb.h> @n
* @b Library : @b osp-web
*
- * 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
+ * The %Controls namespace allows you to embed the %Web browser as a control within an application, upload and download content, and retrieve the HyperText Markup Language (HTML) element and history details.
+ *
* 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>.
*
* The following diagram illustrates the relationships between the classes belonging to the %Controls namespace.
/**
*
* @class AuthenticationChallenge
- * @brief This class handles the HyperText Transfer Protocol (HTTP) authentication requests.
+ * @brief This class handles the HyperText Transfer Protocol (HTTP) authentication requests.
*
* @since 2.0
*
* @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 has blocked the 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);
* @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 has blocked the 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);
/**\r
* @file FWebCtrlGeolocationPermissionManager.h\r
* @brief This is the header file for the %GeolocationPermissionManager class.\r
- * @privlevel platform\r
*\r
* This header file contains the declarations of the %GeolocationPermissionManager class.\r
*\r
*\r
* @since 2.0\r
*\r
- * The %GeolocationPermissionManager class provides methods to manage geolocation permissions decided by a user from origins using html5 JavaScript geolocation APIs.\r
- * @n\r
+ * The %GeolocationPermissionManager class provides methods to manage geolocation permissions decided by a user from origins using html5 JavaScript geolocation APIs. @n\r
* Origin consists of the scheme, host, and port.\r
*/\r
\r
* @privlevel platform\r
* @privilege %http://tizen.org/privilege/geolocationpermission.read\r
*\r
- * @return A pointer to Tizen::Base::Collection::IList containing origin(Tizen::Base::String) list, @n\r
+ * @return A pointer to Tizen::Base::Collection::IList that contains the origin(Tizen::Base::String) list, @n\r
* else @c null if no geolocation permission data exists\r
- * @exception E_SUCCESS The method is successful.\r
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
+ * @exception E_SUCCESS The method is successful.\r
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.\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
* @privilege %http://tizen.org/privilege/geolocationpermission.read\r
*\r
* @return @c true if geolocation permission is allowed, @n\r
- * else @c false\r
- * @param[in] origin The origin\r
+ * else @c false\r
+ * @param[in] origin The origin\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_DATA_NOT_FOUND There is no permission data for the specified @c origin.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @privilege %http://tizen.org/privilege/geolocationpermission.write\r
*\r
* @return An error code\r
- * @param[in] origin The origin\r
+ * @param[in] origin The origin\r
* @exception E_SUCCESS The method is successful.\r
* @exception E_DATA_NOT_FOUND There is no permission data for the specified @c origin.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
result Remove(const Tizen::Base::String& origin);\r
\r
/**\r
- * Removes all elements in the list.\r
+ * Removes all the elements from the list.\r
* \r
* @since 2.0\r
* @privlevel platform\r
* @since 2.0\r
*\r
* @return A pointer to the %GeolocationPermissionManager 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
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.\r
* @exception E_SYSTEM The method cannot proceed due to a severe system error.\r
* @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
*
* @since 2.0
*
- * The %HitElementResult class provides methods to retrieve information from the HTML element, such as tag name, attributes and content.
+ * The %HitElementResult class provides methods to retrieve information such as tag name, attributes and content from the HTML element.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
*
* @since 2.0
*
* @return The value of the specified attribute
- * @param[in] attributeName The name of attribute
+ * @param[in] attributeName The name of the attribute
*/
Tizen::Base::String GetAttributeValue(const Tizen::Base::String& attributeName) const;
* @since 2.0
*
* @return @c true if there is a URL linked to the element, @n
- * else @c false
+ * else @c false
*/
bool HasUrl(void) const;
/**
* @interface IJavaScriptBridge
- * @brief This interface provides a communication channel between JavaScript and native object.
+ * @brief This interface provides a communication channel between JavaScript and a native object.
*
* @since 2.0
*
- * The %IJavaScriptBridge interface provides a communication channel between JavaScript and native object.
+ * The %IJavaScriptBridge interface provides a communication channel between JavaScript and a native object.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
*
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IJavaScriptBridge(void) {}
/**
- * Called asynchronously on invocation request from JavaScript side through the requestToNative() method.
+ * Called asynchronously on an invocation request from JavaScript through the requestToNative() method.
*
* @since 2.0
*
{
WEB_NAVIGATION_LINK_CLICKED, /**< The clicking of a link on the page */
WEB_NAVIGATION_FORM_SUBMITTED, /**< The submission of a form */
- WEB_NAVIGATION_BACKFORWARD, /**< The back and forward navigation*/
+ WEB_NAVIGATION_BACKFORWARD, /**< The back and forward navigation */
WEB_NAVIGATION_RELOAD, /**< The reloading of the page */
- WEB_NAVIGATION_FORM_RESUBMITTED, /**< The resubmission of the form */
+ WEB_NAVIGATION_FORM_RESUBMITTED, /**< The resubmission of the form */
WEB_NAVIGATION_OTHER /**< A navigation other than any of the above */
};
*/
enum LoadingErrorType
{
- WEB_ERROR_UNKNOWN, /**< An unknown error*/
- WEB_REQUEST_TIMEOUT, /**< The request timeout */
+ WEB_ERROR_UNKNOWN, /**< An unknown error */
+ WEB_REQUEST_TIMEOUT, /**< The request timeout */
WEB_NO_CONNECTION, /**< The network is not in service */
WEB_MIME_NOT_SUPPORTED, /**< The content type is not supported */
WEB_BAD_URL, /**< The URL is invalid */
- WEB_HTTP_RESPONSE, /**< The hypertext transfer protocol (HTTP) response */
- WEB_OUT_OF_MEMORY, /**< The memory is not enough to load the page */
- WEB_FILE_ACCESS_FAILED, /**< The file access has failed */
- WEB_REQUEST_MAX_EXCEEDED, /**< The request has failed because the total number of requests have exceeded the maximum limit */
- WEB_INVALID_CERTIFICATE /**< The hypertext transfer protocol secure (HTTPS) request has failed due to an invalid certificate or CA */
+ WEB_HTTP_RESPONSE, /**< The hypertext transfer protocol (HTTP) response */
+ WEB_OUT_OF_MEMORY, /**< The memory is not enough to load the page */
+ WEB_FILE_ACCESS_FAILED, /**< The file access has failed */
+ WEB_REQUEST_MAX_EXCEEDED, /**< The request has failed because the total number of requests have exceeded the maximum limit */
+ WEB_INVALID_CERTIFICATE /**< The hypertext transfer protocol secure (HTTPS) request has failed due to an invalid certificate or CA */
};
/**
*/
enum DecisionPolicy
{
- WEB_DECISION_DOWNLOAD, /**< The download policy*/
- WEB_DECISION_CONTINUE, /**< The usage policy*/
- WEB_DECISION_IGNORE, /**< The ignore policy*/
+ WEB_DECISION_DOWNLOAD, /**< The download policy */
+ WEB_DECISION_CONTINUE, /**< The usage policy */
+ WEB_DECISION_IGNORE, /**< The ignore policy */
};
/**
* @since 2.0
*
* The %ILoadingListener interface receives the events that occur during the loading of data.
- * To listen to the events occurred during a data loading operation, implement this listener. If there is no
+ * To listen to the events that occur during a data loading operation, implement this listener. If there is no
* registered load event listener, the browser engine handles these events according to its own settings.
* @n
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/web/controls_namespace.htm">Web Controls Guide</a>.
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
* @return @c true if the ownership is taken by the application, @n
* else @c false, and a default dialog for the ID and password is displayed @n
* If this method returns @c true, the application must delete the AuthenticationChallenge instance.
- * @param[in] host The host requiring the authentication
- * @param[in] realm The description to help save the user credentials for future visits
+ * @param[in] host The host requiring the authentication
+ * @param[in] realm The description to help save the user credentials for future visits
* @param[in] authentication The handler to send a user response to the server that requested the authentication
*/
virtual bool OnHttpAuthenticationRequestedN(const Tizen::Base::String& host, const Tizen::Base::String& realm, const Tizen::Web::Controls::AuthenticationChallenge& authentication) = 0;
*
* @since 2.0
*
- * @param[in] error The error that occurred during loading
+ * @param[in] error The error that occurs during loading
* @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.
+ * - @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
*
- * @return @c true if the application handles the URL after the request is canceled in the browser engine, @n
- * else @c false if the browser engine proceeds with the requested URL
+ * @return @c true if the application handles the URL after the request is cancelled in the browser engine, @n
+ * else @c false if the browser engine proceeds with the requested URL
* @param[in] url The URL that is requested
- * @param[in] type The type indicating how the URL is triggered
+ * @param[in] type The type that indicates how the URL is triggered
*/
virtual bool OnLoadingRequested(const Tizen::Base::String& url, WebNavigationType type) = 0;
*
* @since 2.0
*
- * @return A value of the enumerator DecisionPolicy
+ * @return A value of the enumerator DecisionPolicy
* @param[in] mime The content type of the data that is downloaded
* @param[in] httpHeader The HTTP header string
*/
/**
* 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::Web::GetFaviconN().
+ * If this callback is received once, an application can get the favicon by using Tizen::Web::Controls::Web::GetFaviconN().
*
* @since 2.1
*
* @param[in] favicon The favicon image
- * @see Tizen::Web::Controls::Web::GetFaviconN()
*/
virtual void OnFaviconReceived(const Tizen::Graphics::Bitmap& favicon) {}
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] totalCount The total count of matches
- * @param[in] currentOrdinal The ordinal of currently selected match @n
- * If there is no match, it will be set to zero.
+ * @param[in] totalCount The total count of the matches
+ * @param[in] currentOrdinal The ordinal of the currently selected match @n
+ * If there is no match, it is set to zero.
*/
virtual void OnTextFound(int totalCount, int currentOrdinal) = 0;
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual void OnWebDataDownloadCompleted(void) = 0;
/**
- * Called when an error has occurred while downloading content.
+ * Called when an error occurs while downloading content.
*
* @since 2.0
*
- * @param[in] error The type of error that occurred while downloading data
+ * @param[in] error The type of error that occurs while downloading data
*/
virtual void OnWebDownloadFailed(LoadingErrorType error) = 0;
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @param[in] source The source of the event
* @remarks When the overlay keypad appears on the screen, the current Form's
- * area is adjusted to account for the space that is taken up by the overlay keypad.
+ * area is adjusted to account for the space that is taken up by the overlay keypad.
* @see Tizen::Ui::Controls::Form::GetClientAreaBounds()
*/
virtual void OnWebKeypadOpened(Tizen::Web::Controls::Web& source) = 0;
virtual void OnWebKeypadClosed(Tizen::Web::Controls::Web& source) = 0;
/**
- * Called when the keypad bounds are changed, for instance when the predictive text window which is located in the upper side of the keypad is shown.
+ * Called when the keypad bounds are changed, for instance when the predictive text window which is located in the upper part of the keypad is shown.
*
* @since 2.0
*
{
public:
/**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
*
* @since 2.0
*
- * @param[in] source The source of the event
+ * @param[in] source The source of the event
* @param[in] startPoint The starting point of the selected block
* @param[in] endPoint The ending point of the selected block
*/
/**
* 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.
+ * The application that wants to support the W3C preventDefault() feature is recommended to use this callback and delay the handling of 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 the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event.
+ * else @c false
+ * @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
/**\r
* @file FWebCtrlIWebUiEventListenerF.h\r
-* @brief This is the header file for the %IWebUiEventListenerF interface.\r
+* @brief This is the header file for the %IWebUiEventListenerF interface.\r
*\r
* This header file contains the declarations of the %IWebUiEventListenerF interface.\r
*/\r
{\r
public:\r
/**\r
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.\r
+ * This polymorphic destructor should be overridden if required. @n\r
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.\r
*\r
* @since 2.1\r
*/\r
*\r
* @since 2.1\r
*\r
- * @param[in] source The source of the event\r
+ * @param[in] source The source of the event\r
* @param[in] startPoint The starting point of the selected block\r
* @param[in] endPoint The ending point of the selected block\r
*/\r
\r
/**\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
+ * The application that wants to support the W3C preventDefault() feature is recommended to use this callback and delay the handling of 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 the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event.\r
+ * else @c false\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
* @since 2.0
*
* @return The current history item, @n
- * else @c null if no history item exists
+ * else @c null if no history item exists
*/
const Tizen::Web::HistoryItem* GetCurrentItem(void) const;
* @since 2.0
*
* @return The index of the currently viewed page in the web page navigation list, @n
- * else @c -1 if no history item exists
+ * else @c -1 if no history item exists
*/
int GetCurrentIndex(void) const;
/**
- * Gets the history item pointed to by the specified @c index.
+ * Gets the history item that the specified @c index points to.
*
* @since 2.0
*
* @return A pointer to the history 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.
- * @exception E_OUT_OF_RANGE The specified @c index is out of range.
+ * @param[in] index The index of the element @n
+ * The value of the index must be greater than or equal to @c 0.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of the valid range.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Tizen::Web::HistoryItem* GetItemAt(int index) const;
/**
- * Gets the total number of the history items.
+ * Gets the total number of history items.
*
* @since 2.0
*
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @param[in] rect The rectangle size of the control
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method has failed.
- * @exception E_INVALID_ARG The specified @c rect is invalid.
- * @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] rect The rectangle size of the control
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method has failed.
+ * @exception E_INVALID_ARG The specified @c rect is invalid.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
*/
result Construct(const Tizen::Graphics::Rectangle& rect);
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @param[in] rect The rectangle size of the control
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The method has failed.
- * @exception E_INVALID_ARG The specified @c rect is invalid.
- * @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.
+ * @param[in] rect The rectangle size of the control
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method has failed.
+ * @exception E_INVALID_ARG The specified @c rect is invalid.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
*/
result Construct(const Tizen::Graphics::FloatRectangle& rect);
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] url The resource to load
- * @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] url The resource to load
+ * @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void LoadUrl(const Tizen::Base::String& url);
/**
- * Loads the resource specified by the URL with a given header of HTTP request.
+ * Loads the resource specified by the URL along with the given header of the HTTP request.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @param[in] url The resource to load
- * @param[in] header The header of the HTTP request
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_HEADER The header object does not contain any header fields.
- * @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] url The resource to load
+ * @param[in] header The header of the HTTP request
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_HEADER The header object does not contain any header fields.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
*/
result LoadUrl(const Tizen::Base::String& url, const Tizen::Net::Http::HttpHeader& header);
/**
- * 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.
+ * Loads the resource specified by the URL along with the given header and body of the HTTP request. @n
+ * The header must include the content-type entity-header field that is needed to check the mime-type of the message body.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @param[in] url The resource to load
- * @param[in] header The header of the HTTP request
- * @param[in] body The message body of the HTTP request
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_HEADER The header object does not contain any header fields.
- * @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] url The resource to load
+ * @param[in] header The header of the HTTP request
+ * @param[in] body The message body of the HTTP request
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_HEADER The header object does not contain any header fields.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
*/
result LoadUrlWithPostRequest(const Tizen::Base::String& url, const Tizen::Net::Http::HttpHeader& header, const Tizen::Base::ByteBuffer& body);
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] baseUrl The uniform resource locator (URL) of the content
- * @param[in] content The content
- * @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_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] baseUrl The uniform resource locator (URL) of the content
+ * @param[in] content The content
+ * @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_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void LoadData(const Tizen::Base::String& baseUrl, const Tizen::Base::ByteBuffer& content, const Tizen::Base::String& mime, const Tizen::Base::String& encoding = "UTF-8");
* @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void StopLoading(void);
* @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void Reload(void);
*
* @since 2.0
*
- * @return @c true if a page is loading, @n
- * else @c false
+ * @return @c true if the page is loading, @n
+ * else @c false
*/
bool IsLoading(void) const;
* @since 2.0
*
* @return @c true if a back history item exists, @n
- * else @c false
+ * else @c false
*/
bool CanGoBack(void) const;
* @since 2.0
*
* @return @c true if a forward history item exists, @n
- * else @c false
+ * else @c false
*/
bool CanGoForward(void) const;
* @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void GoBack(void);
* @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void GoForward(void);
*
* @since 2.0
*
- * @return A pointer to PageNavigationList containing the history items of the %Web control
+ * @return A pointer to PageNavigationList that contains the history items of the %Web control
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
* @since 2.0
*
* @return @c true if the specified @c word is found, @n
- * else @c false
+ * else @c false
* @param[in] word The string to search for
* @param[in] searchForward Set to @c true to search for the word in the forward direction from the current position, @n
- * else @c false to search for the word in the backward direction from the current position
+ * else @c false to search for the word in the backward direction from the current position
*/
bool SearchText(const Tizen::Base::String& word, bool searchForward = true);
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @param[in] setting The setting to update
- * @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] setting The setting to update
+ * @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 has blocked the application from calling this method. @b Since: @b 2.1
*/
result SetSetting(const Tizen::Web::Controls::WebSetting& setting);
* @since 2.0
*
* @return A HitElementResult of the pointed element
- * @param[in] point The x and y coordinates
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c point is invalid.
+ * @param[in] point The x and y coordinates
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c point is invalid.
* @exception E_UNSUPPORTED_FORMAT The image format is not supported.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Web::Controls::HitElementResult* GetElementByPointN(const Tizen::Graphics::Point& point) const;
* @since 2.1
*
* @return A HitElementResult of the pointed element
- * @param[in] point The x and y coordinates
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c point is invalid.
+ * @param[in] point The x and y coordinates
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c point is invalid.
* @exception E_UNSUPPORTED_FORMAT The image format is not supported.
- * @exception E_SYSTEM The method cannot proceed due to a severe system error.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Web::Controls::HitElementResult* GetElementByPointN(const Tizen::Graphics::FloatPoint& point) const;
* @privilege %http://tizen.org/privilege/web.service
*
* @return The result of the evaluated JavaScript, @n
- * else @c null if an error occurs
- * @param[in] scriptCode The JavaScript code as string
- * @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
+ * else @c null if an error occurs
+ * @param[in] scriptCode The JavaScript code as a string
+ * @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::String* EvaluateJavascriptN(const Tizen::Base::String& scriptCode);
* @since 2.0
*
* @return An error code
- * @param[in] level The zoom-out level @n
- * The value ranges between @c 0.3 and @c 2.0. When the page view is at its original size, the level is @c 1.0. @n If the
- * specified level is less than @c 1.0, the page view is reduced. @n If the specified level is greater than @c 1.0, the page view is
- * magnified.
+ * @param[in] level The zoom-out level @n
+ * The value lies between the range @c 0.3 and @c 2.0. When the page view is at its original size, the level is @c 1.0. @n If the
+ * specified level is less than @c 1.0, the page view is reduced. @n If the specified level is greater than @c 1.0, the page view is
+ * magnified.
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c level is less than @c 0.3 or greater than @c 2.0.
+ * @exception E_OUT_OF_RANGE The specified @c level is either less than @c 0.3 or greater than @c 2.0.
*/
result SetZoomLevel(float level);
*
* @since 2.0
*
- * @return The value ranges between @c 0.3 and @c 2.0
+ * @return The value lies between the range @c 0.3 and @c 2.0
*/
float GetZoomLevel(void) const;
* @since 2.0
*
* @return @c true if the specified MIME type is supported, @n
- * else @c false
+ * else @c false
* @param[in] mime The MIME type
*/
bool IsMimeSupported(const Tizen::Base::String& mime) const;
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] pLoadingListener The listener receives the events that occurs while loading the data
- * @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] pLoadingListener The listener receives the events that occur while loading the data
+ * @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetLoadingListener(Tizen::Web::Controls::ILoadingListener* pLoadingListener);
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] pDownLoadListener The listener to receive the data from a network incrementally
- * @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] pDownLoadListener The listener to receive the data from a network incrementally
+ * @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetDownloadListener(Tizen::Web::Controls::IWebDownloadListener* pDownLoadListener);
* @since 2.0
*
* @return An error code
- * @param[in] startPoint The starting point for the text selection block
+ * @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 specified starting point.
*/
* @since 2.1
*
* @return An error code
- * @param[in] startPoint The starting point for the text selection block
+ * @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 specified starting point.
*/
* @since 2.0
*
* @return An error code
- * @param[out] startPoint The starting point of the selected text block
- * @param[out] endPoint The ending point of the selected text block
+ * @param[out] startPoint The starting point of the selected text block
+ * @param[out] endPoint The ending point of the selected text block
* @exception E_SUCCESS The method is successful.
*/
result GetBlockRange(Tizen::Graphics::Point& startPoint, Tizen::Graphics::Point& endPoint) const;
* @since 2.1
*
* @return An error code
- * @param[out] startPoint The starting point of the selected text block
- * @param[out] endPoint The ending point of the selected text block
+ * @param[out] startPoint The starting point of the selected text block
+ * @param[out] endPoint The ending point of the selected text block
* @exception E_SUCCESS The method is successful.
*/
result GetBlockRange(Tizen::Graphics::FloatPoint& startPoint, Tizen::Graphics::FloatPoint& endPoint) const;
* @since 2.0
*
* @return The selected text, @n
- * else an empty string if there is no selection block
+ * else an empty string if there is no selection block
*/
Tizen::Base::String GetTextFromBlock(void) const;
*
* @since 2.0
*
- * @param[in] enable Set to @c true to enable the scrolling of the web page, @n
+ * @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 does not affect javascript touch event.
+ * @remarks This method does not affect the JavaScript touch event.
*/
result SetScrollEnabled(bool enable);
* @since 2.0
*
* @return @c true if the web page scroll is enabled, @n
- * else @c false
+ * else @c false
*/
bool IsScrollEnabled(void) const;
* @since 2.0
*
* @return @c true if private browsing is enabled, @n
- * else @c false
+ * else @c false
*/
bool IsPrivateBrowsingEnabled(void) const;
* @privilege %http://tizen.org/privilege/web.service
*
* @return The result of setting the private browsing
- * @param[in] enable Set to @c true to enable private browsing, @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.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @param[in] enable Set to @c true to enable private browsing, @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.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
*/
result SetPrivateBrowsingEnabled(bool enable);
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @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.
+ * @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 has blocked the application from calling this method.
* @see CanGoBack()
* @see CanGoForward()
* @see GoBack()
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @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 has blocked the application from calling this method. @b Since: @b 2.1
*/
result ClearCache(void);
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @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 has blocked the application from calling this method. @b Since: @b 2.1
*/
result ClearCookie(void);
/**
- * Clears the application's all stored form datas.
+ * Clears the application's all stored form data.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @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.
+ * @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 has blocked the application from calling this method.
*/
result ClearFormData(void);
/**
- * Clears the application's all stored ID/password datas.
+ * Clears the application's all stored ID/password data.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @return An error code
- * @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.
+ * @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 has blocked the application from calling this method.
*/
result ClearLoginFormData(void);
/**
- * Checks whether the %Web control allows cookie. @n
- * Returns @c true if cookie is enabled.
+ * Checks whether the %Web control allows cookies. @n
*
* @since 2.0
*
- * @return @c true if cookie is allowed, @n
- * else @c false
+ * @return @c true if the cookie is allowed, @n
+ * else @c false
*/
bool IsCookieEnabled(void) const;
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @return The result of enabling or disabling cookie
- * @param[in] enable Set to @c true if the web control allows a cookie, @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.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @return The result of enabling or disabling a cookie
+ * @param[in] enable Set to @c true if the web control allows a cookie, @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.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
*/
result SetCookieEnabled(bool enable);
/**
- * Saves the current web page as a pdf file. @n The size parameter is used to set size of the pdf file using millimeter.
+ * Saves the current web page as a pdf file. @n
+ * The size parameter is used to set the size of a pdf file using millimeters.
*
* @since 2.0
*
* @return An error code
- * @param[in] filePath The path of the pdf file that is created
- * @param[in] pSize The width and height of the pdf file in millimeter. The width and height must be greater than @c 0. @n
- * If the parameter contains @c null, the method uses the default size of the web page that is shown on the screen.
+ * @param[in] filePath The path of the pdf file that is created
+ * @param[in] pSize The width and height of the pdf file in millimeters. The width and height must be greater than @c 0. @n
+ * If the parameter contains @c null, the method uses the default size of the web page that is shown on the screen.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG Either of the following conditions has occurred: @n
* - The specified path is invalid.
* @since 2.0
*
* @return An error code
- * @param[in] jsBridge The JavaScript bridge to add
+ * @param[in] jsBridge The JavaScript bridge to add
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST A JavaScript bridge with the same name already exists.
*/
* @since 2.0
*
* @return An error code
- * @param[in] jsBridge The JavaScript bridge to remove
+ * @param[in] jsBridge The JavaScript bridge to remove
* @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified element is not found.
+ * @exception E_OBJ_NOT_FOUND The specified element is not found.
*/
result RemoveJavaScriptBridge(const IJavaScriptBridge& jsBridge);
/**
* Registers a keypad event listener. @n
- * The registered listener is notified when the keypad associated with <input> tag or with <textarea> tag is opened or closed.
+ * The registered listener is notified when the keypad associated with <input> tag or <textarea> tag is opened or closed.
*
* @since 2.0
*
void SetWebKeypadEventListener(IWebKeypadEventListener* pKeypadEventListener);
/**
- * Searches for all instances of the text on the current page and then highlights them. @n
- * The current matched block will indicate the first match.
+ * Searches for all the instances of the text on the current page and then highlights them. @n
+ * The current matched block indicates the first match.
*
* @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
+ * @param[in] text The string to search for
+ * @param[in] caseSensitive Set to @c true to search for the text in the case-sensitive mode, @n
+ * else @c false to search for the text in the backward direction from the current position
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified @c text is invalid.
* @remarks This method operates asynchronously.
* @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.
+ * @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.
* @exception E_INVALID_OPERATION The SearchTextAllAsync() method is not called.
* @remarks This method operates asynchronously.
* @see Tizen::Web::Controls::ITextSearchListener::OnTextFound()
void SetTextSearchListener(ITextSearchListener* pTextSearchListener);
/**
- * Gets the favicon image from current page.
+ * Gets the favicon image from the current page.
*
* @since 2.0
*
void Pause(void);
/**
- * Informs the browser engine to resume the handling of screen operations.
+ * Informs the browser engine to resume the handling of the screen operations.
*
* @since 2.0
*/
*
* @since 2.1
*
- * @return The size of the current web page
- * @remarks If an application want to get the displayed size, the return value should be multiplied by the zoom factor.
+ * @return The size of the current web page
+ * @remarks If an application wants to get the displayed size, the return value should be multiplied by the zoom factor.
* @see GetZoomLevel()
*/
Tizen::Graphics::Dimension GetPageSize(void) const;
enum CertificateErrorHandlingMode
{
WEB_CERTIFICATE_ERROR_HANDLING_MODE_USER_CONFIRM, /**< The web certificate error handling mode: The confirm popup is displayed to get the user confirmation */
- WEB_CERTIFICATE_ERROR_HANDLING_MODE_CANCEL, /**< The web certificate error handling mode: The confirm popup is not displayed and the request is canceled */
- WEB_CERTIFICATE_ERROR_HANDLING_MODE_CONTINUE /**< The web certificate error handling mode: The confirm popup is not displayed and the request proceeds */
+ WEB_CERTIFICATE_ERROR_HANDLING_MODE_CANCEL, /**< The web certificate error handling mode: The confirm popup is not displayed and the request is cancelled */
+ WEB_CERTIFICATE_ERROR_HANDLING_MODE_CONTINUE /**< The web certificate error handling mode: The confirm popup is not displayed and the request proceeds */
};
/**
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] mode A cache mode
- * @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] mode The cache mode
+ * @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetCacheControl(CacheMode mode);
* @since 2.0
*
* @param[in] enable Set to @c true if the %Web control uses JavaScript, @n
- * else @c false
+ * else @c false
*/
void SetJavascriptEnabled(bool enable);
*
* @since 2.0
*
- * @param[in] enable Set to @c true if the %Web control must load images included in the content, @n
- * else @c false
+ * @param[in] enable Set to @c true if the %Web control loads images included in the content, @n
+ * else @c false
*/
void SetAutoImageLoadEnabled(bool enable);
*
* @since 2.0
*
- * @param[in] inputStyle The input style of keypad
+ * @param[in] inputStyle The input style of the keypad
* @remarks If an application sets the input style to @c INPUT_STYLE_OVERLAY, the application must implement IWebKeypadEventListener to rearrange the layout of the current Form.
*
*/
/**
* Gets the font size of the content. @n
- * The default size is @c 17.
+ * The default size is @c 16.
*
* @since 2.0
*
* @since 2.0
*
* @return @c true if JavaScript is enabled and used by a %Web control, @n
- * else @c false
+ * else @c false
*/
bool IsJavascriptEnabled(void) const;
* @since 2.0
*
* @return @c true if auto image loading is enabled, @n
- * else @c false
+ * else @c false
*/
bool IsAutoImageLoadEnabled(void) const;
*
* @since 2.0
*
- * @return The input style of keypad
+ * @return The input style of the keypad
*/
Tizen::Ui::Controls::InputStyle GetInputStyle(void) const;
/**
- * Sets a certificate error handling mode for a %Web control.
+ * Sets the certificate error handling mode for a %Web control.
*
* @since 2.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] mode A certificate error handling mode
- * @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] mode The certificate error handling mode
+ * @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 has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetCertificateErrorHandlingMode(CertificateErrorHandlingMode mode);
*
* @since 2.0
*
- * @return A certificate error handling mode
+ * @return The certificate error handling mode
*/
CertificateErrorHandlingMode GetCertificateErrorHandlingMode(void) const;
/**
- * Sets a user agent for a %Web control.
+ * Sets the user agent for a %Web control.
*
* @since 2.0
*
void SetUserAgent(const Tizen::Base::String& agent);
/**
- * Gets a value of user agent for a %Web control.
+ * Gets the value of the user agent for a %Web control.
*
* @since 2.0
*
- * @return The value of user agent
+ * @return The value of the user agent
*/
Tizen::Base::String GetUserAgent(void) const;
/**
- * Decides if a %Web control loads the resized contents to fit width automatically.
+ * Decides if a %Web control loads the resized contents to fit the width automatically.
*
* @since 2.0
*
- * @param[in] enable Set to @c true if the %Web control should load contents to fit width, @n
- * else @c false
+ * @param[in] enable Set to @c true if the %Web control should load contents to fit the width, @n
+ * else @c false
*/
void SetAutoFittingEnabled(bool enable);
/**
- * Checks whether a %Web control loads the resize contents to fit width. @n
+ * Checks whether a %Web control loads the resized contents to fit the width. @n
* The default value is @c true.
*
* @since 2.0
*
* @return @c true if auto fitting is enabled, @n
- * else @c false
+ * else @c false
*/
bool IsAutoFittingEnabled(void) const;
/**
- * Decides if a %Web control allows JavaScript to open new window.
+ * Decides if a %Web control allows JavaScript to open a new window.
*
* @since 2.0
*
- * @param[in] enable Set to @c true if the %Web control should allow JavaScript to open new window, @n
- * else @c false
+ * @param[in] enable Set to @c true if the %Web control should allow JavaScript to open a new window, @n
+ * else @c false
*/
void SetJavaScriptPopupEnabled(bool enable);
/**
- * Checks whether a %Web control allows JavaScript to open new window. @n Returns @c true if opening new window by JavaScript is enabled.
+ * Checks whether a %Web control allows JavaScript to open a new window.
* The default value is @c true.
*
* @since 2.0
*
- * @return @c true if opening new window by JavaScript is enabled, @n
- * else @c false
+ * @return @c true if opening a new window by JavaScript is enabled, @n
+ * else @c false
*/
bool IsJavaScriptPopupEnabled(void) const;
/**
- * Decides if a %Web control supports html5 geolocation feature.
+ * Decides if a %Web control supports the HTML5 geolocation feature.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] enable Set to @c true if the %Web control should support html5 geolocation 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.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
+ * @param[in] enable Set to @c true if the %Web control should support the HTML5 geolocation 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.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetGeolocationEnabled(bool enable);
/**
- * Checks whether a %Web control supports html5 geolocation feature. @n Returns @c true if html5 geolocation feature is enabled.
+ * Checks whether a %Web control supports the HTML5 geolocation feature.
* The default value is @c true.
*
* @since 2.0
*
- * @return @c true if html5 geolocation feature is enabled, @n
- * else @c false
+ * @return @c true if the HTML5 geolocation feature is enabled, @n
+ * else @c false
*/
bool IsGeolocationEnabled(void) const;
/**
- * Decides if a %Web control saves form data automatically and supports autocomplete feature.
+ * Decides if a %Web control saves the form data automatically and supports the autocomplete 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 form data automatically and supports autocomplete 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.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method.
+ * @param[in] enable Set to @c true if the %Web control should save the form data automatically and supports the autocomplete 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.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetAutoFormDataShowEnabled(bool enable);
/**
- * Checks whether %Web control saves form data automatically and supports autocomplete feature. @n Returns @c true if those are enabled.
+ * Checks whether a %Web control saves the form data automatically and supports the autocomplete feature.
* The default value is @c true.
*
* @since 2.1
*
- * @return @c true if saving form data and autocomplete feature are enabled, @n
- * else @c false
+ * @return @c true if the %Web control saves the form data and enables the autocomplete feature, @n
+ * else @c false
*/
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 the ID/password for a login form automatically and supports the 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
- * 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.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method.
+ * @param[in] enable Set to @c true if the %Web control should save the login ID/password automatically and supports the 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.
+ * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void SetAutoLoginFormFillEnabled(bool enable);
/**
- * Checks whether %Web control saves ID/password for login form automatically and supports autofill feature. @n Returns @c true if those are enabled.
+ * Checks whether a %Web control saves the ID/password for a login form automatically and supports the autofill feature.
* 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
- * else @c false
+ * @return @c true if the %Web control saves the ID/password for a login form and enables the autofill feature, @n
+ * else @c false
*/
bool IsAutoLoginFormFillEnabled(void) const;
* @since 2.0
*
* @return @c true if the two instances match, @n
- * else @c false
+ * else @c false
* @param[in] obj The object to compare with the current instance
* @remarks This method returns @c true if and only if the two instances contain the same elements.
* @see Tizen::Base::Object::Equals()
*
* @since 2.0
*
- * @param[in] setting The instance of the %WebSetting class to assign from
+ * @param[in] setting The instance of the %WebSetting class to assign
*/
WebSetting& operator =(const WebSetting& setting);
\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
* @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 @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
Tizen::Base::Collection::IList* GetOriginListN(WebStorageType storageType) const;\r
\r
/**\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
+ * 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
* @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 @c storageType is not supported.\r
\r
\r
/**\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
+ * 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
* @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 @c storageType is not supported.\r
long GetQuotaForOrigin(WebStorageType storageType, const Tizen::Base::String& origin);\r
\r
/**\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
+ * 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
* @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 @c storageType is not supported.\r
long GetUsageForOrigin(WebStorageType storageType, const Tizen::Base::String& origin) const;\r
\r
/**\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
+ * 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
* @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 @c storageType is not supported.\r
result Remove(WebStorageType storageType, const Tizen::Base::String& origin);\r
\r
/**\r
- * Removes all data for a given storage type.\r
+ * Removes all the data of a given storage type.\r
*\r
* @since 2.1\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 @c storageType is not supported.\r
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.\r
* @since 2.1\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
/**
* @class HistoryItem
- * @brief This class is used for accessing a history item stored in the PageNavigationList class or the WebHistory class.
+ * @brief This class is used for accessing a history item stored in the %PageNavigationList class or the %WebHistory class.
*
* @since 2.0
*
* The %HistoryItem class provides access to the Controls::PageNavigationList class item and the WebHistory class.
- * Each item contains the title and the URL of the page visited.
+ * Each item contains the title and URL of the page visited.
*/
class _OSP_EXPORT_ HistoryItem
: public Tizen::Base::Object
* @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
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Graphics::Bitmap* GetFaviconN(void) const;
/**
* @class WebBookmark
- * @brief This class provides methods to manage bookmark items of the browser.
+ * @brief This class provides methods to manage the 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 %WebBookmark class provides methods to get the browser's bookmark information and organize it.
+ * The bookmark system has a 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
* @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[in] title The title of a bookmark item
+ * @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
* @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] title The title of a bookmark item
+ * @param[in] url The URL of a 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 @c title is an empty string. @n
* @privilege %http://tizen.org/privilege/bookmark.write
*
* @return An error code
- * @param[in] bookmarkId The bookmark ID
- * @param[in] favicon The favicon image
+ * @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 @c bookmarkId is invalid.
* @exception E_INVALID_DATA The specified @c favicon data is invalid.
result SetFavicon(RecordId bookmarkId, const Tizen::Graphics::Bitmap& favicon);
/**
- * Gets the bookmark item pointed to by the specified @c index.
+ * Gets the bookmark item that the specified @c index points to.
*
* @since 2.1
* @privlevel platform
* @privilege %http://tizen.org/privilege/bookmark.read
*
* @return The bookmark item at the specified @c index
- * @param[in] index The index of an element @n
- * The value of the @c index must be greater than or equal to @c 0.
+ * @param[in] index The index of the element @n
+ * 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 @c index is out of range.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of the valid 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.
*/
int GetItemCount(void) const;
/**
- * Removes all elements.
+ * Removes all the elements.
*
* @since 2.1
* @privlevel platform
result Construct(void);
/**
- * Gets the history item pointed to by the specified @c index.
+ * Gets the history item that the specified @c index points to.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/web.privacy
*
* @return The history 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.
+ * @param[in] index The index of the element @n
+ * The value of the index must be greater than or equal to @c 0.
* @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is out of range.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of the valid 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.
*/
projects / framework / osp / web.git / commitdiff