*
* The following example demonstrates how to use the %Web class.
* @code
-// Sample code for WebSample.h
+// Sample code using Form for WebSample.h
#include <FUi.h>
#include <FWeb.h>
virtual result OnInitializing(void);
};
-// Sample code for WebSample.cpp
+// Sample code using Form for WebSample.cpp
#include "WebSample.h"
using namespace Tizen::Ui;
{
result r = E_SUCCESS;
+ // Constucts a Form
+ ...
+
__pWeb = new Web();
__pWeb->Construct(GetClientAreaBounds());
- AddControl(*__pWeb);
+ AddControl(__pWeb);
+
LoadUrl();
return r;
void
WebSample::LoadUrl(void)
{
- Tizen::Base::String url(L"http://www.tizen.org");
+ Tizen::Base::String url(L"http://www.tizen.org/about/");
__pWeb->LoadUrl(url);
}
* @endcode
*
+ * @code
+// Sample code using Window for WebSample.h
+#include <FApp.h>
+#include <FUi.h>
+#include <FWeb.h>
+
+class WebSample :
+ public Tizen::Ui::Window
+{
+public:
+ WebSample(void) {};
+ virtual ~WebSample(void) {};
+
+protected:
+ void LoadUrl(void);
+
+private:
+ Tizen::Web::Controls::Web *__pWeb;
+
+public:
+ virtual result OnInitializing(void);
+};
+
+// Sample code using Window for WebSample.cpp
+#include "WebSample.h"
+
+using namespace Tizen::App;
+using namespace Tizen::Ui;
+using namespace Tizen::Ui::Controls;
+using namespace Tizen::Web::Controls;
+
+result
+WebSample::OnInitializing(void)
+{
+ result r = E_SUCCESS;
+
+ // Constucts a Window
+ ...
+
+ Frame *pFrame = UiApp::GetInstance()->GetAppFrame()->GetFrame();
+ SetOwner(pFrame->GetCurrentForm());
+
+ __pWeb = new Web();
+ __pWeb->Construct(GetClientAreaBounds());
+ AddControl(__pWeb);
+
+ Show();
+ LoadUrl();
+
+ return r;
+}
+
+// Calls LoadUrl() with the URL of the Web content to display it on the Web control
+void
+WebSample::LoadUrl(void)
+{
+ Tizen::Base::String url(L"http://www.tizen.org/about/");
+
+ __pWeb->LoadUrl(url);
+}
+ * @endcode
*/
class _OSP_EXPORT_ Web
: public Tizen::Ui::Container
{
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
*
* @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.
+ * @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);
* Initializes this instance of the %Web control with the specified parameters.
*
* @since 2.1
- *
* @privlevel public
* @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.
+ * @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);
* Loads the resource specified by the URL.
*
* @since 2.0
- *
* @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.
+ * @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 the 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.
+ * @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);
/**
- * Load the resource specified by the URL with the 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.
+ * @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);
* Loads the content of the specified buffer.
*
* @since 2.0
- *
* @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.
+ * @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");
* Stops the current loading operation.
*
* @since 2.0
- *
* @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_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);
* Reloads the current page.
*
* @since 2.0
- *
* @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_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;
* Goes to the back history of the current %Web control.
*
* @since 2.0
- *
* @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_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);
* Goes to the forward history of the current %Web control.
*
* @since 2.0
- *
* @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_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);
* It fails to change the setting during data load.
*
* @since 2.0
- *
* @privlevel public
* @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.
+ * @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;
* Evaluates the JavaScript string and returns the result.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.service
*
* @return The result of the evaluated JavaScript, @n
- * else an empty string 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.
+ * 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;
* Sets a load event listener.
*
* @since 2.0
- *
* @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.
+ * @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);
* Sets a download event listener.
*
* @since 2.0
- *
* @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.
+ * @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 starting point specified.
+ * @exception E_INVALID_ARG There is nothing to select from the specified starting point.
*/
result SetBlockSelectionPosition(const Tizen::Graphics::Point& startPoint);
* @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 starting point specified.
+ * @exception E_INVALID_ARG There is nothing to select from the specified starting point.
*/
result SetBlockSelectionPosition(const Tizen::Graphics::FloatPoint& startPoint);
* @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 doesn't 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;
* Sets the private browsing and returns the result.
*
* @since 2.0
- *
* @privlevel public
* @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.
+ * @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);
* Clears the back and forward navigation list.
*
* @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_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()
* Clears the application's cache.
*
* @since 2.0
- *
* @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_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);
* Clears the application's cookie.
*
* @since 2.0
- *
* @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_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_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_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;
* Enables or disables a cookie.
*
* @since 2.0
- *
* @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.
+ * @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
*/
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
*
- * @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;
projects / framework / osp / web.git / blobdiff