Init Tizen 2.2.1
[framework/osp/web.git] / inc / FWebCtrlILoadingListener.h
old mode 100755 (executable)
new mode 100644 (file)
index caf32b7..3858f92
@@ -56,9 +56,9 @@ enum WebNavigationType
 {
        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 */
 };
 
@@ -71,16 +71,16 @@ enum WebNavigationType
  */
 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 */
 };
 
 /**
@@ -92,9 +92,9 @@ enum LoadingErrorType
  */
 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 */
 };
 
 /**
@@ -104,7 +104,7 @@ enum DecisionPolicy
  * @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>.
@@ -114,7 +114,8 @@ class _OSP_EXPORT_ ILoadingListener
 {
 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
         */
@@ -128,8 +129,8 @@ public:
         * @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;
@@ -160,11 +161,11 @@ public:
        *
        * @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;
 
@@ -199,10 +200,10 @@ public:
         *
         * @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;
 
@@ -214,7 +215,7 @@ public:
         *
         * @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
         */
@@ -222,7 +223,7 @@ public:
 
        /**
         * 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
         *