/**
*
- * @class AuthenticationChallenge
+ * @class AuthenticationChallenge
* @brief This class handles the HyperText Transfer Protocol (HTTP) authentication requests.
*
* @since 2.0
*
* @since 2.0
*
- * @privlevel public
- * @privilege %http://tizen.org/privilege/web.privacy
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/web.privacy
*
- * @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.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @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.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
void Process(const UserId& userId, const Tizen::Base::String& password);
*
* @since 2.0
*
- * @privlevel public
- * @privilege %http://tizen.org/privilege/web.privacy
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/web.privacy
*
- * @exception E_SUCCESS The method is successful.
- * @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.
+ * @exception E_SUCCESS The method is successful.
+ * @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.
*/
void Cancel(void);
*\r
* @since 2.0\r
*\r
- * @privlevel platform\r
+ * @privlevel platform\r
* @privilege %http://tizen.org/privilege/geolocationpermission.read\r
*\r
- * @return A pointer to IList containing 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
+ * @return A pointer to Tizen::Base::Collection::IList containing 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_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
+ * @remarks The specific error code can be accessed using the GetLastResult() method.\r
*/\r
Tizen::Base::Collection::IList* GetOriginListN(void) const;\r
\r
{
/**
- * @class HitElementResult
+ * @class HitElementResult
* @brief This class provides methods to retrieve information from the HyperText Markup Language (HTML) element, pointed by the x and y coordinates.
*
- * @since 2.0
+ * @since 2.0
*
* The %HitElementResult class provides methods to retrieve information from the HTML element, such as tag name, attributes and content.
* @n
*
* @since 2.0
*
- * @return The URL linked to the element
+ * @return The URL linked to the element
*/
Tizen::Base::String GetUrl(void) const;
*
* @since 2.0
*
- * @return @c true if the element is an image element, @n
+ * @return @c true if the element is an image element, @n
* else @c false
*/
bool HasImage(void) const;
*
* @since 2.0
*
- * @return @c true if there is a URL linked to the element, @n
+ * @return @c true if there is a URL linked to the element, @n
* else @c false
*/
bool HasUrl(void) const;
* @brief This is the header file for the %IJavaScriptBridge interface.
*
* This header file contains the declarations of the %IJavaScriptBridge interface.
- * @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>.
- *
*/
#ifndef _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_
#define _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_
*
* @since 2.0
*
- * The %IJavaScriptBridge interface provides a communication channel between JavaScript and C++ object.
+ * The %IJavaScriptBridge interface provides a communication channel between JavaScript and 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>.
+ *
*/
class _OSP_EXPORT_ IJavaScriptBridge
{
/**
* 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.
*
- * @since 2.0
+ * @since 2.0
*/
virtual ~IJavaScriptBridge(void) {}
/**
* Called asynchronously on invocation request from JavaScript side through the requestToNative() method.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] pArg The parameters delivered by JavaScript
+ * @param[in] pArg The parameters delivered by JavaScript
*/
virtual void HandleJavaScriptRequestN(Tizen::Web::Json::IJsonValue* pArg) = 0;
*
* @since 2.0
*
- * @return The name of %IJavaScriptBridge
+ * @return The name of %IJavaScriptBridge
*/
virtual Tizen::Base::String GetName(void) = 0;
*
* Defines the type of %Web navigation.
*
- * @since 2.0
+ * @since 2.0
*/
enum WebNavigationType
{
*
* Defines the types of loading errors.
*
- * @since 2.0
+ * @since 2.0
*/
enum LoadingErrorType
{
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 failed */
+ 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 */
};
*
* Defines the decision policy.
*
- * @since 2.0
+ * @since 2.0
*/
enum DecisionPolicy
{
* @interface ILoadingListener
* @brief This interface is for receiving the events that occur during the loading of data.
*
- * @since 2.0
+ * @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
/**
* Called when an authentication is requested.
*
- * @since 2.0
+ * @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
+ * 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] authentication The handler to send a user response to the server that requested the authentication
+ * @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;
/**
* Called when the authentication request is cancelled.
*
- * @since 2.0
+ * @since 2.0
*/
virtual void OnHttpAuthenticationCanceled(void) = 0;
/**
* Called when the loading operation starts.
*
- * @since 2.0
+ * @since 2.0
*/
virtual void OnLoadingStarted(void) = 0;
/**
* Called when the loading operation is cancelled.
*
- * @since 2.0
+ * @since 2.0
*/
virtual void OnLoadingCanceled(void) = 0;
/**
* Called when the loading operation fails.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] error The error that occurred during loading
- * @param[in] reason The reason for the loading failure, @n
- * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404" @n
- * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported @n
- * - @c WEB_BAD_URL: The URL is incorrect
+ * @param[in] error The error that occurred during loading
+ * @param[in] reason The reason for the loading failure, @n
+ * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404" @n
+ * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported @n
+ * - @c WEB_BAD_URL: The URL is incorrect
*/
virtual void OnLoadingErrorOccurred(LoadingErrorType error, const Tizen::Base::String& reason) = 0;
/**
* Called when the loading operation is completed.
*
- * @since 2.0
+ * @since 2.0
*/
virtual void OnLoadingCompleted(void) = 0;
* Called when the loading progress for the current page is requested. @n
* The progress rate is displayed as a percentage.
*
- * @since 2.0
+ * @since 2.0
*
* @param[in] progress The progress rate ranging from [@c 0 ~ @c 100]
*/
/**
* Called when the title of the new page has been received.
*
- * @since 2.0
+ * @since 2.0
*/
virtual void OnPageTitleReceived(const Tizen::Base::String& title) = 0;
*
* @since 2.0
*
- * @return DecisionPolicy 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
*/
virtual void OnFaviconReceived(const Tizen::Graphics::Bitmap& favicon) {}
protected:
-
//
// This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application.
//
virtual ~IWebKeypadEventListener(void) {}
/**
- * Called when the keypad is about to be shown on the screen. @n
- * 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.
+ * Called when the keypad is about to be shown on the screen.
*
* @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.
* @see Tizen::Ui::Controls::Form::GetClientAreaBounds()
*/
virtual void OnWebKeypadWillOpen(Tizen::Web::Controls::Web& source) = 0;
/**
- * Called when the keypad is shown on the screen. @n
- * 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.
+ * Called when the keypad is shown on the screen.
*
* @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.
* @see Tizen::Ui::Controls::Form::GetClientAreaBounds()
*/
virtual void OnWebKeypadOpened(Tizen::Web::Controls::Web& source) = 0;
/**
* Called when a request for closing the window is received. @n
* This event is called from the parent window's listener that invoked the child window. @n
- * The application must free the resource allocated for the %Web Control.
+ * The application must free the resource allocated for the Web Control.
*
* @since 2.0
*
*
* @since 2.0
*
- * The %PageNavigationList class provides the back and forward list for a Web control.
+ * The %PageNavigationList class provides the back and forward list for a %Web control.
* @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>.
*/
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.
+ * 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.
*
* @since 2.0
/**
* Gets the starting point and the ending point of the selected text block. @n
- * When this method is called without the selection block, the startPoint and endPoint have (0,0) values for the x and y coordinates.
+ * When the %GetBlockRange() method is called without the selection block, the @c startPoint and @c endPoint have (0,0) values for the x and y coordinates.
*
* @since 2.0
*
result SetCookieEnabled(bool enable);
/**
- * Saves the current web page as a pdf file. 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 size of the pdf file using millimeter.
*
* @since 2.0
*
result SearchTextAllAsync(const Tizen::Base::String& text, bool caseSensitive);
/**
- * Scrolls the current matched block to the next text matched by SearchTextAllAsync()
+ * Scrolls the current matched block to the next text matched by SearchTextAllAsync().
*
* @since 2.0
*
void Resume(void);
/**
- * Scrolls the web page by the given dx and dy.
+ * Scrolls the web page with the given coordinates.
*
* @since 2.1
*
Tizen::Graphics::Point GetScrollPosition(void) const;
/**
- * Gets the size of current web page.
+ * Gets the size of the current web page.
*
* @since 2.1
*
- * @return The size of current web page.
+ * @return The size of the current web page
*/
Tizen::Graphics::Dimension GetPageSize(void) const;
*
* @since 2.0
*
- * @return @c true if the two instances match, or if and only if the two instances contain the same elements, @n
+ * @return @c true if the two instances match, @n
* else @c false
* @param[in] obj The object to compare with the current instance
- * @see Tizen::Base::Object::Equals()
+ * @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;
Tizen::Base::String GetUrl(void) const;
/**
- * Gets the favicon image from HistoryItem
+ * Gets the favicon image from HistoryItem.
*
* @since 2.0
*
* Gets the history item pointed to by the specified @c index.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.privacy
*
* Gets the total number of items.
*
* @since 2.0
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/web.privacy
*
projects / framework / osp / web.git / commitdiff