X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fweb-view%2Fweb-view.h;h=1fb893fe241bc99a1ded7fe960e943bee37411c2;hp=8c842b7bc72c774c21bbdce0f83e33b9bb9503da;hb=2f810b8a969d39e569b39107a02dfaf35c0c48bc;hpb=d0b0cfa4a44953be9af9128885eb6ef5d83a214e diff --git a/dali-toolkit/devel-api/controls/web-view/web-view.h b/dali-toolkit/devel-api/controls/web-view/web-view.h old mode 100644 new mode 100755 index 8c842b7..1fb893f --- a/dali-toolkit/devel-api/controls/web-view/web-view.h +++ b/dali-toolkit/devel-api/controls/web-view/web-view.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_WEB_VIEW_H /* - * Copyright (c) 2021 Samsung Electronics Co., Ltd. + * Copyright (c) 2022 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -20,10 +20,11 @@ // EXTERNAL INCLUDES #include +#include // INTERNAL INCLUDES #include -#include +#include namespace Dali { @@ -114,52 +115,84 @@ public: /** * @brief Whether video hole is enabled or not. * @details name "videoHoleEnabled", type Property::BOOLEAN. - * @note The value is read-only. + * @note False by default. */ VIDEO_HOLE_ENABLED, - }; - }; - /** - * @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 Whether mouse event is enabled. + * @details name "mouseEventsEnabled", type Property::BOOLEAN. + * @note Default is true. + */ + MOUSE_EVENTS_ENABLED, - /** - * @brief WebView signal type related with page loading. - */ - using WebViewPageLoadSignalType = Signal; + /** + * @brief Whether key event is enabled. + * @details name "keyEventsEnabled", type Property::BOOLEAN. + * @note Default is true. + */ + KEY_EVENTS_ENABLED, - /** - * @brief WebView signal type related with page loading error. - */ - using WebViewPageLoadErrorSignalType = Signal; + /** + * @brief The background color of web page. + * @details name "documentBackgroundColor", type Property::VECTOR4. + */ + DOCUMENT_BACKGROUND_COLOR, + + /** + * @brief Whether tiles can be cleared or not when hidden. + * @details name "tilesClearedWhenHidden", type BOOLEAN. + */ + TILES_CLEARED_WHEN_HIDDEN, + + /** + * @brief The multiplier of cover area of tile when rendering web page. + * @details name "tileCoverAreaMultiplier", type FLOAT. + */ + TILE_COVER_AREA_MULTIPLIER, + + /** + * @brief Whether cursor is enabled or not by client. + * @details name "cursorEnabledByClient", type BOOLEAN. + */ + CURSOR_ENABLED_BY_CLIENT, + + /** + * @brief The selected text of web page. + * @details name "selectedText", type Property::STRING. + * @note The value is read-only. + */ + SELECTED_TEXT, + + /** + * @brief Zoom factor of web page. + * @details name "pageZoomFactor", type Property::FLOAT. + */ + PAGE_ZOOM_FACTOR, + + /** + * @brief Zoom factor of text. + * @details name "textZoomFactor", type Property::FLOAT. + */ + TEXT_ZOOM_FACTOR, + + /** + * @brief progress percentage of loading a web page. + * @details name "loadProgressPercentage", type Property::FLOAT. + * @note The value is read-only. + */ + LOAD_PROGRESS_PERCENTAGE, + }; + }; /** - * @brief WebView signal type related with scroll edge reached. + * @brief WebView callback related with screen-shot captured. */ - using WebViewScrollEdgeReachedSignalType = Signal; + using WebViewScreenshotCapturedCallback = std::function; 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 @@ -167,7 +200,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 @@ -175,15 +208,30 @@ 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 Find web view by web engine plugin. + */ + static Toolkit::WebView FindWebView(Dali::WebEnginePlugin* plugin); + + /** + * @brief Get context of web engine. + */ + static Dali::WebEngineContext* GetContext(); + + /** + * @brief Get cookie manager of web engine. + */ + static Dali::WebEngineCookieManager* GetCookieManager(); + + /** + * @brief Create an uninitialized WebView. */ WebView(); @@ -210,7 +258,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. @@ -226,102 +274,176 @@ public: Dali::Toolkit::WebSettings* GetSettings() const; /** - * @brief Get WebContext of WebEngine. - */ - Dali::Toolkit::WebContext* GetContext() const; - - /** - * @brief Get CookieManager of WebEngine. - */ - Dali::Toolkit::WebCookieManager* GetCookieManager() const; - - /** * @brief Get WebBackForwardList of WebEngine. */ Dali::Toolkit::WebBackForwardList* GetBackForwardList() const; /** - * @brief Get Favicon of web page. + * @brief Get favicon of web page. * - * @return Handle to a fav icon + * @return Handle to a favicon */ - Dali::Toolkit::ImageView& GetFavicon(); + Dali::Toolkit::ImageView GetFavicon() const; /** - * @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 */ void LoadHtmlString(const std::string& htmlString); /** - * @brief Reloads the Web. + * @brief Load the specified html string as the content of the view overriding current history entry + * + * @param[in] html HTML data to load + * @param[in] basicUri Base URL used for relative paths to external objects + * @param[in] unreachableUrl URL that could not be reached + * + * @return true if successfully loaded, false otherwise + */ + bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl); + + /** + * @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) + * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed + * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed + * @param[in] baseUri The base URI to use for relative resources + * + * @return true if successfully request, false otherwise + */ + bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri); + + /** + * @brief Reload the Web. */ void Reload(); /** - * @brief Stops loading web contents on the current page. + * @brief Reload the current page's document without cache + */ + bool ReloadWithoutCache(); + + /** + * @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(); /** - * @brief Scrolls the webpage of view by deltaX and deltaY. + * @brief To suspend all url loading + */ + void SuspendNetworkLoading(); + + /** + * @brief To resume new url network loading + */ + void ResumeNetworkLoading(); + + /** + * @brief Add custom header + * + * @param[in] name custom header name to add the custom header + * @param[in] value custom header value to add the custom header + * + * @return true if succeeded, false otherwise + */ + bool AddCustomHeader(const std::string& name, const std::string& value); + + /** + * @brief Remove custom header + * + * @param[in] name custom header name to remove the custom header + * + * @return true if succeeded, false otherwise + */ + bool RemoveCustomHeader(const std::string& name); + + /** + * @brief Start the inspector server + * + * @param[in] port port number + * + * @return the port number + */ + uint32_t StartInspectorServer(uint32_t port); + + /** + * @brief Stop the inspector server + * + * @return true if succeeded, false otherwise + */ + bool StopInspectorServer(); + + /** + * @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 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(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. + * @param[in] resultHandler The callback to be called by the JavaScript runtime. This carries evaluation result */ - void EvaluateJavaScript(const std::string& script, std::function resultHandler); + void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler); /** - * @brief Evaluates JavaScript code represented as a string. + * @brief Evaluate JavaScript code represented as a string. * * @param[in] script The JavaScript code */ @@ -351,57 +473,289 @@ public: * @param[in] exposedObjectName The name of exposed object * @param[in] handler The callback function */ - void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function handler); + void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler); /** - * @brief Clears all tiles resources of Web. + * @brief Register alert callback for javascript. + * + * @param[in] callback The callback function to be called by the JavaScript runtime. */ - void ClearAllTilesResources(); + void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback); + + /** + * @brief Reply for JavaScript alert. + */ + void JavaScriptAlertReply(); /** - * @brief Clears the history of Web. + * @brief Register confirm callback for javascript. + * + * @param[in] callback The callback function to be called by the JavaScript runtime. + */ + void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback); + + /** + * @brief Reply for JavaScript confirm. + * @param[in] confirmed True if confirmed, false otherwise + */ + void JavaScriptConfirmReply(bool confirmed); + + /** + * @brief Register prompt callback for javascript. + * + * @param[in] callback The callback function to be called by the JavaScript runtime. + */ + void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback); + + /** + * @brief Reply for JavaScript prompt. + * @param[in] result The result from input-field of prompt popup. + */ + void JavaScriptPromptReply(const std::string& result); + + /** + * @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 Connects to this signal to be notified when page loading is started. + * @brief Clear all tiles resources of Web. + */ + void ClearAllTilesResources(); + + /** + * @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 Get the current scale factor of the page. + * @return The current scale factor. + */ + float GetScaleFactor() const; + + /** + * @brief Request to activate/deactivate the accessibility usage set by web app. + * @param[in] activated Activate accessibility or not. + */ + void ActivateAccessibility(bool activated); + + /** + * @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 + * + * @return true if found & highlighted, false otherwise + */ + bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount); + + /** + * @brief Add dynamic certificate path. + * @param[in] host host that required client authentication + * @param[in] certPath the file path stored certificate + */ + void AddDynamicCertificatePath(const std::string& host, const std::string& certPath); + + /** + * @brief Get snapshot of the specified viewArea of page. + * + * @param[in] viewArea The rectangle of screen shot + * @param[in] scaleFactor The scale factor + * + * @return image view of screen shot + */ + Dali::Toolkit::ImageView GetScreenshot(Dali::Rect viewArea, float scaleFactor); + + /** + * @brief Request to get snapshot of the specified viewArea of page asynchronously. + * + * @param[in] viewArea The rectangle of screen shot + * @param[in] scaleFactor The scale factor + * @param[in] callback The callback for screen shot + * + * @return true if requested successfully, false otherwise + */ + bool GetScreenshotAsynchronously(Dali::Rect viewArea, float scaleFactor, WebViewScreenshotCapturedCallback callback); + + /** + * @brief Asynchronous request to check if there is a video playing in the given view. + * + * @param[in] callback The callback called after checking if video is playing or not + * + * @return true if requested successfully, false otherwise + */ + bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback); + + /** + * @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 Set or unset TTS focus of the webview. + * @param[in] focused True if it is gained, false lost. + * @note It only works when the webview does not have keyinput focus. If it has keyinput focus, the TTS focus is set automatically. + */ + void SetTtsFocus(bool focused); + + /** + * @brief Callback to be called when page loading is started. + * + * @param[in] callback + */ + void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback); + + /** + * @brief Callback to be called when page loading is in progress. + * + * @param[in] callback + */ + void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback); + + /** + * @brief Callback to be called when page loading is finished. + * + * @param[in] callback + */ + void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback); + + /** + * @brief Callback to be called when an error occurs in page loading. + * + * @param[in] callback + */ + void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback); + + /** + * @brief Callback to be called when scroll edge is reached. + * + * @param[in] callback + */ + void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback); + + /** + * @brief Callback to be called when url is changed. + * + * @param[in] callback + */ + void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback); + + /** + * @brief Callback to be called when form repost decision is requested. + * + * @param[in] callback + */ + void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback); + + /** + * @brief Callback to be called when frame is rendered. + * + * @param[in] callback + */ + void RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback); + + /** + * @brief Callback to be called when console message will be logged. + * + * @param[in] callback + */ + void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback); + + /** + * @brief Callback to be called when response policy would be decided. + * + * @param[in] callback + */ + void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback); + + /** + * @brief Callback to be called when navigation policy would be decided. + * + * @param[in] callback + */ + void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback); + + /** + * @brief Callback to be called when certificate need be confirmed. + * + * @param[in] callback + */ + void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback); + + /** + * @brief Callback to be called when ssl certificate is changed. + * + * @param[in] callback + */ + void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback); + + /** + * @brief Callback to be called when http authentication need be confirmed. * - * @return A signal object to connect with + * @param[in] callback */ - WebViewPageLoadSignalType& PageLoadStartedSignal(); + void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback); /** - * @brief Connects to this signal to be notified when page loading is finished. + * @brief Callback to be called when context menu would be shown. * - * @return A signal object to connect with + * @param[in] callback */ - WebViewPageLoadSignalType& PageLoadFinishedSignal(); + void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback); /** - * @brief Connects to this signal to be notified when an error occurs in page loading. + * @brief Callback to be called when context menu would be hidden. * - * @return A signal object to connect with. + * @param[in] callback */ - WebViewPageLoadErrorSignalType& PageLoadErrorSignal(); + void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback); /** - * @brief Connects to this signal to be notified when scroll edge is reached. + * @brief Get a plain text of current web page asynchronously. * - * @return A signal object to connect with. + * @param[in] callback The callback function called asynchronously. */ - WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal(); + void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback); 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 */