X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fweb-view%2Fweb-view.h;h=2ef7d9123e2b48c925bdb0947c66fde0458866e5;hb=b9e642e718049bba5c8ee7df3bd353155581f5a5;hp=716132e1aacc2aa47a0c4cd5ecca263eee351475;hpb=580eea83bb02f8b936dc348ba4c1bee86df2500b;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/devel-api/controls/web-view/web-view.h b/dali-toolkit/devel-api/controls/web-view/web-view.h index 716132e..2ef7d91 100755 --- a/dali-toolkit/devel-api/controls/web-view/web-view.h +++ b/dali-toolkit/devel-api/controls/web-view/web-view.h @@ -33,6 +33,8 @@ namespace Toolkit class ImageView; class WebBackForwardList; class WebContext; +class WebContextMenu; +class WebContextMenuItem; class WebCookieManager; class WebFormRepostDecision; class WebSettings; @@ -187,28 +189,6 @@ public: }; /** - * @brief Enumeration for indicating error code of page loading. - */ - enum class LoadErrorCode - { - UNKNOWN = 0, ///< Unknown. - CANCELED, ///< User canceled. - CANT_SUPPORT_MIMETYPE, ///< Can't show the page for this MIME type. - FAILED_FILE_IO, ///< File IO error. - CANT_CONNECT, ///< Cannot connect to the network. - CANT_LOOKUP_HOST, ///< Fail to look up host from the DNS. - FAILED_TLS_HANDSHAKE, ///< Fail to SSL/TLS handshake. - INVALID_CERTIFICATE, ///< Received certificate is invalid. - REQUEST_TIMEOUT, ///< Connection timeout. - TOO_MANY_REDIRECTS, ///< Too many redirects. - TOO_MANY_REQUESTS, ///< Too many requests during this load. - BAD_URL, ///< Malformed URL. - UNSUPPORTED_SCHEME, ///< Unsupported scheme. - AUTHENTICATION, ///< User authentication failed on the server. - INTERNAL_SERVER ///< Web server has an internal server error. - }; - - /** * @brief WebView callback related with screen-shot captured. */ using WebViewScreenshotCapturedCallback = std::function; @@ -221,7 +201,7 @@ public: /** * @brief WebView signal type related with page loading error. */ - using WebViewPageLoadErrorSignalType = Signal; + using WebViewPageLoadErrorSignalType = Signal)>; /** * @brief WebView signal type related with scroll edge reached. @@ -236,16 +216,51 @@ public: /** * @brief WebView signal type related with form repost decision. */ - using WebViewFormRepostDecisionSignalType = Signal)>; + using WebViewFormRepostDecisionSignalType = Signal)>; /** * @brief WebView signal type related with frame rendered. */ using WebViewFrameRenderedSignalType = Signal; + /** + * @brief WebView signal type related with http request interceptor. + */ + using WebViewRequestInterceptorSignalType = Signal)>; + + /** + * @brief WebView signal type related with console message. + */ + using WebViewConsoleMessageSignalType = Signal)>; + + /** + * @brief WebView signal type related with response policy decision. + */ + using WebViewResponsePolicyDecisionSignalType = Signal)>; + + /** + * @brief WebView signal type related with certificate changed. + */ + using WebViewCertificateSignalType = Signal)>; + + /** + * @brief WebView signal type related with http authentication. + */ + using WebViewHttpAuthHandlerSignalType = Signal)>; + + /** + * @brief WebView signal type related with context menu customized. + */ + using WebViewContextMenuCustomizedSignalType = Signal)>; + + /** + * @brief WebView signal type related with context menu item selected. + */ + using WebViewContextMenuItemSelectedSignalType = Signal)>; + public: /** - * @brief Creates an initialized WebView. + * @brief Create an initialized WebView. * @return A handle to a newly allocated Dali WebView * * @note WebView will not display anything @@ -253,7 +268,7 @@ public: static WebView New(); /** - * @brief Creates an initialized WebView. + * @brief Create an initialized WebView. * * @param [in] locale The locale of Web * @param [in] timezoneId The timezoneId of Web @@ -261,15 +276,15 @@ public: static WebView New(const std::string& locale, const std::string& timezoneId); /** - * @brief Creates an initialized WebView. + * @brief Create an initialized WebView. * * @param [in] argc The count of arguments of Applications * @param [in] argv The string array of arguments of Applications */ - static WebView New(int argc, char** argv); + static WebView New(uint32_t argc, char** argv); /** - * @brief Creates an uninitialized WebView. + * @brief Create an uninitialized WebView. */ WebView(); @@ -296,7 +311,7 @@ public: WebView& operator=(const WebView& WebView); /** - * @brief Downcasts a handle to WebView handle. + * @brief Downcast a handle to WebView handle. * * If handle points to a WebView, the downcast produces valid handle. * If not, the returned handle is left uninitialized. @@ -334,14 +349,14 @@ public: Dali::Toolkit::ImageView& GetFavicon(); /** - * @brief Loads a web page based on a given URL. + * @brief Load a web page based on a given URL. * * @param [in] url The URL of the resource to load */ void LoadUrl(const std::string& url); /** - * @brief Loads a given string as web contents. + * @brief Load a given string as web contents. * * @param [in] htmlString The string to use as the contents of the web page */ @@ -359,7 +374,7 @@ public: bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl); /** - * @brief Requests loading the given contents by MIME type into the view object + * @brief Request loading the given contents by MIME type into the view object * * @param[in] contents The content to load * @param[in] contentSize The size of contents (in bytes) @@ -372,27 +387,27 @@ public: bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri); /** - * @brief Reloads the Web. + * @brief Reload the Web. */ void Reload(); /** - * @brief Reloads the current page's document without cache + * @brief Reload the current page's document without cache */ bool ReloadWithoutCache(); /** - * @brief Stops loading web contents on the current page. + * @brief Stop loading web contents on the current page. */ void StopLoading(); /** - * @brief Suspends the operation associated with the view. + * @brief Suspend the operation associated with the view. */ void Suspend(); /** - * @brief Resumes the operation associated with the view object after calling Suspend(). + * @brief Resume the operation associated with the view object after calling Suspend(). */ void Resume(); @@ -442,48 +457,48 @@ public: bool StopInspectorServer(); /** - * @brief Scrolls web page of view by deltaX and deltaY. + * @brief Scroll web page of view by deltaX and deltaY. * @param[in] deltaX The delta x of scroll * @param[in] deltaY The delta y of scroll */ - void ScrollBy(int deltaX, int deltaY); + void ScrollBy(int32_t deltaX, int32_t deltaY); /** - * @brief Scrolls edge of view by deltaX and deltaY. + * @brief Scroll edge of view by deltaX and deltaY. * * @param[in] deltaX horizontal offset to scroll * @param[in] deltaY vertical offset to scroll * * @return true if succeeded, false otherwise */ - bool ScrollEdgeBy(int deltaX, int deltaY); + bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY); /** - * @brief Returns whether forward is possible. + * @brief Return whether forward is possible. * * @return True if forward is possible, false otherwise */ bool CanGoForward(); /** - * @brief Goes forward in the navigation history. + * @brief Go forward in the navigation history. */ void GoForward(); /** - * @brief Returns whether backward is possible. + * @brief Return whether backward is possible. * * @return True if backward is possible, false otherwise */ bool CanGoBack(); /** - * @brief Goes back in the navigation history. + * @brief Go back in the navigation history. */ void GoBack(); /** - * @brief Evaluates JavaScript code represented as a string. + * @brief Evaluate JavaScript code represented as a string. * * @param[in] script The JavaScript code * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result @@ -491,7 +506,7 @@ public: void EvaluateJavaScript(const std::string& script, std::function resultHandler); /** - * @brief Evaluates JavaScript code represented as a string. + * @brief Evaluate JavaScript code represented as a string. * * @param[in] script The JavaScript code */ @@ -562,24 +577,47 @@ public: void JavaScriptPromptReply(const std::string& result); /** - * @brief Clears the history of Web. + * @brief Create a new hit test. + * + * @param[in] x the horizontal position to query + * @param[in] y the vertical position to query + * @param[in] mode the mode of hit test + * + * @return a new hit test object. + */ + std::unique_ptr CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode); + + /** + * @brief Create a hit test asynchronously. + * + * @param[in] x the horizontal position to query + * @param[in] y the vertical position to query + * @param[in] mode the mode of hit test + * @param[in] callback The callback function + * + * @return true if succeeded, false otherwise. + */ + bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback); + + /** + * @brief Clear the history of Web. */ void ClearHistory(); /** - * @brief Clears all tiles resources of Web. + * @brief Clear all tiles resources of Web. */ void ClearAllTilesResources(); /** - * @brief Scales the current page, centered at the given point. + * @brief Scale the current page, centered at the given point. * @param[in] scaleFactor a new factor to be scaled. * @param[in] point a center coordinate. */ void SetScaleFactor(float scaleFactor, Dali::Vector2 point); /** - * @brief Gets the current scale factor of the page. + * @brief Get the current scale factor of the page. * @return The current scale factor. */ float GetScaleFactor() const; @@ -591,7 +629,7 @@ public: void ActivateAccessibility(bool activated); /** - * @brief Searches and highlights the given string in the document. + * @brief Search and highlights the given string in the document. * @param[in] text The text to find * @param[in] options The options to find * @param[in] maxMatchCount The maximum match count to find @@ -615,7 +653,7 @@ public: * * @return image view of screen shot */ - Dali::Toolkit::ImageView GetScreenshot(Dali::Rect viewArea, float scaleFactor); + Dali::Toolkit::ImageView GetScreenshot(Dali::Rect viewArea, float scaleFactor); /** * @brief Request to get snapshot of the specified viewArea of page asynchronously. @@ -626,7 +664,7 @@ public: * * @return true if requested successfully, false otherwise */ - bool GetScreenshotAsynchronously(Dali::Rect viewArea, float scaleFactor, WebViewScreenshotCapturedCallback callback); + bool GetScreenshotAsynchronously(Dali::Rect viewArea, float scaleFactor, WebViewScreenshotCapturedCallback callback); /** * @brief Asynchronous request to check if there is a video playing in the given view. @@ -638,79 +676,135 @@ public: bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback); /** - * @brief Sets callback which will be called upon geolocation permission request. + * @brief Set callback which will be called upon geolocation permission request. * * @param[in] callback The callback for requesting geolocation permission */ void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback); /** - * @brief Connects to this signal to be notified when page loading is started. + * @brief Connect to this signal to be notified when page loading is started. * * @return A signal object to connect with */ WebViewPageLoadSignalType& PageLoadStartedSignal(); /** - * @brief Connects to this signal to be notified when page loading is in progress. + * @brief Connect to this signal to be notified when page loading is in progress. * * @return A signal object to connect with */ WebViewPageLoadSignalType& PageLoadInProgressSignal(); /** - * @brief Connects to this signal to be notified when page loading is finished. + * @brief Connect to this signal to be notified when page loading is finished. * * @return A signal object to connect with */ WebViewPageLoadSignalType& PageLoadFinishedSignal(); /** - * @brief Connects to this signal to be notified when an error occurs in page loading. + * @brief Connect to this signal to be notified when an error occurs in page loading. * * @return A signal object to connect with */ WebViewPageLoadErrorSignalType& PageLoadErrorSignal(); /** - * @brief Connects to this signal to be notified when scroll edge is reached. + * @brief Connect to this signal to be notified when scroll edge is reached. * * @return A signal object to connect with */ WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal(); /** - * @brief Connects to this signal to be notified when url is changed. + * @brief Connect to this signal to be notified when url is changed. * * @return A signal object to connect with */ WebViewUrlChangedSignalType& UrlChangedSignal(); /** - * @brief Connects to this signal to be notified when form repost decision is requested. + * @brief Connect to this signal to be notified when form repost decision is requested. * * @return A signal object to connect with. */ WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal(); /** - * @brief Connects to this signal to be notified when frame is rendered. + * @brief Connect to this signal to be notified when frame is rendered. * * @return A signal object to connect with. */ WebViewFrameRenderedSignalType& FrameRenderedSignal(); + /** + * @brief Connect to this signal to be notified when http request need be intercepted. + * + * @return A signal object to connect with. + */ + WebViewRequestInterceptorSignalType& RequestInterceptorSignal(); + + /** + * @brief Connect to this signal to be notified when console message will be logged. + * + * @return A signal object to connect with. + */ + WebViewConsoleMessageSignalType& ConsoleMessageSignal(); + + /** + * @brief Connect to this signal to be notified when response policy would be decided. + * + * @return A signal object to connect with. + */ + WebViewResponsePolicyDecisionSignalType& ResponsePolicyDecisionSignal(); + + /** + * @brief Connect to this signal to be notified when certificate need be confirmed. + * + * @return A signal object to connect with. + */ + WebViewCertificateSignalType& CertificateConfirmSignal(); + + /** + * @brief Connect to this signal to be notified when ssl certificate is changed. + * + * @return A signal object to connect with. + */ + WebViewCertificateSignalType& SslCertificateChangedSignal(); + + /** + * @brief Connect to this signal to be notified when http authentication need be confirmed. + * + * @return A signal object to connect with. + */ + WebViewHttpAuthHandlerSignalType& HttpAuthHandlerSignal(); + + /** + * @brief Connect to this signal to be notified when context menu would be customized. + * + * @return A signal object to connect with. + */ + WebViewContextMenuCustomizedSignalType& ContextMenuCustomizedSignal(); + + /** + * @brief Connect to this signal to be notified when context menu item is selected. + * + * @return A signal object to connect with. + */ + WebViewContextMenuItemSelectedSignalType& ContextMenuItemSelectedSignal(); + public: // Not intended for application developers /// @cond internal /** - * @brief Creates a handle using the Toolkit::Internal implementation. + * @brief Create a handle using the Toolkit::Internal implementation. * * @param[in] implementation The WebView implementation */ DALI_INTERNAL WebView(Internal::WebView& implementation); /** - * @brief Allows the creation of this WebView from an Internal::CustomActor pointer. + * @brief Allow the creation of this WebView from an Internal::CustomActor pointer. * * @param[in] internal A pointer to the internal CustomActor */