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 */
};
/**
* Sets a cache control strategy for a %Web control.
*
* @since 2.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/web.service
*
- * @param[in] mode A cache mode
+ * @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 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 16.
*
* @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
*
* @return @c true if JavaScript is enabled and used by a %Web control, @n
- * else @c false
+ * else @c false
*/
bool IsJavascriptEnabled(void) const;
/**
* 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
*
* @return @c true if auto image loading is enabled, @n
- * else @c false
+ * else @c false
*/
bool IsAutoImageLoadEnabled(void) const;
/**
* 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
*
- * @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
*
- * @param[in] mode A certificate error handling mode
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/web.service
+ *
+ * @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);
/**
* 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
*
- * @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
- * The default is true.
+ * 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. Returns true if opening new window by JavaScript is enabled. @n
- * The default is true.
+ * 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
+ * @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. Returns true if html5 geolocation feature is enabled. @n
- * The default is true.
+ * 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
+ * @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. Returns true if those are enabled. @n
- * The default is true.
+ * 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
+ * @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. Returns true if those are enabled. @n
- * The default is true.
+ * 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()
*/
- virtual bool Equals(const Object& obj) const;
+ virtual bool Equals(const Tizen::Base::Object& obj) const;
/**
* Copying of objects using this copy assignment operator is allowed.
*
* @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);
projects / framework / osp / web.git / blobdiff