X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fdevel-api%2Fadaptor-framework%2Fweb-engine.h;h=9b479e4f3b536add4f67a72ed976834069a04ff1;hb=aadc3293fd8e560de900b542f5fe92a77db8c3f5;hp=e9b604e6acd6d0f34df02d980728df9f317e9297;hpb=47be116ae1779bc3008d3a16e21ed9dddd865ced;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git diff --git a/dali/devel-api/adaptor-framework/web-engine.h b/dali/devel-api/adaptor-framework/web-engine.h old mode 100644 new mode 100755 index e9b604e..9b479e4 --- a/dali/devel-api/adaptor-framework/web-engine.h +++ b/dali/devel-api/adaptor-framework/web-engine.h @@ -2,7 +2,7 @@ #define DALI_WEB_ENGINE_H /* - * Copyright (c) 2018 Samsung Electronics Co., Ltd. + * Copyright (c) 2021 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. @@ -27,13 +27,11 @@ namespace Dali { - namespace Internal { - namespace Adaptor { - class WebEngine; +class WebEngine; } // namespace Adaptor } // namespace Internal @@ -47,7 +45,6 @@ namespace Adaptor class DALI_ADAPTOR_API WebEngine : public BaseHandle { public: - /** * @brief Constructor. */ @@ -68,7 +65,7 @@ public: * * @param[in] WebEngine WebEngine to copy. The copied WebEngine will point at the same implementation */ - WebEngine( const WebEngine& WebEngine ); + WebEngine(const WebEngine& WebEngine); /** * @brief Assignment operator. @@ -76,7 +73,7 @@ public: * @param[in] WebEngine The WebEngine to assign from. * @return The updated WebEngine. */ - WebEngine& operator=( const WebEngine& WebEngine ); + WebEngine& operator=(const WebEngine& WebEngine); /** * @brief Downcast a handle to WebEngine handle. @@ -87,7 +84,7 @@ public: * @param[in] handle Handle to an object * @return Handle to a WebEngine or an uninitialized handle */ - static WebEngine DownCast( BaseHandle handle ); + static WebEngine DownCast(BaseHandle handle); /** * @brief Creates WebEngine instance. @@ -97,7 +94,17 @@ public: * @param [in] locale The locale of Web * @param [in] timezoneId The timezoneID of Web */ - void Create( int width, int height, const std::string& locale, const std::string& timezoneId ); + void Create(int width, int height, const std::string& locale, const std::string& timezoneId); + + /** + * @brief Creates WebEngine instance. + * + * @param [in] width The width of Web + * @param [in] height The height of Web + * @param [in] argc The count of application arguments + * @param [in] argv The string array of application arguments + */ + void Create(int width, int height, int argc, char** argv); /** * @brief Destroys WebEngine instance. @@ -110,11 +117,45 @@ public: NativeImageInterfacePtr GetNativeImageSource(); /** + * @brief Get settings of WebEngine. + */ + Dali::WebEngineSettings& GetSettings() const; + + /** + * @brief Get context of WebEngine. + */ + Dali::WebEngineContext& GetContext() const; + + /** + * @brief Get cookie manager of WebEngine. + */ + Dali::WebEngineCookieManager& GetCookieManager() const; + + /** + * @brief Get back-forward list of WebEngine. + */ + Dali::WebEngineBackForwardList& GetBackForwardList() const; + + /** * @brief Loads a web page based on a given URL. * * @param [in] url The URL of the resource to load */ - void LoadUrl( const std::string& url ); + void LoadUrl(const std::string& url); + + /** + * @brief Returns the title of the Web. + * + * @return The title of web page + */ + std::string GetTitle() const; + + /** + * @brief Returns the Favicon of the Web. + * + * @return FavIcon of Dali::PixelData& type + */ + Dali::PixelData GetFavicon() const; /** * @brief Gets the url. @@ -126,7 +167,31 @@ public: * * @param [in] htmlString The string to use as the contents of the web page */ - void LoadHTMLString( const std::string& htmlString ); + void LoadHtmlString(const std::string& htmlString); + + /** + * @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 Requests 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 Reloads the Web. @@ -134,6 +199,11 @@ public: void Reload(); /** + * @brief Reloads the current page's document without cache + */ + bool ReloadWithoutCache(); + + /** * @brief Stops loading web contents on the current page. */ void StopLoading(); @@ -149,6 +219,89 @@ public: void Resume(); /** + * @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 Scrolls web page of view by deltaX and deltaY. + * + * @param[in] deltaX horizontal offset to scroll + * @param[in] deltaY vertical offset to scroll + */ + void ScrollBy(int deltaX, int deltaY); + + /** + * @brief Scrolls 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); + + /** + * @brief Sets an absolute scroll of the given view. + */ + void SetScrollPosition(int x, int y); + + /** + * @brief Gets the current scroll position of the given view. + */ + Dali::Vector2 GetScrollPosition() const; + + /** + * @brief Gets the possible scroll size of the given view. + */ + Dali::Vector2 GetScrollSize() const; + + /** + * @brief Gets the last known content's size. + */ + Dali::Vector2 GetContentSize() const; + + /** * @brief Returns whether forward is possible. * * @return True if forward is possible, false otherwise @@ -178,7 +331,7 @@ public: * @param[in] script The JavaScript code * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result. */ - void EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler ); + void EvaluateJavaScript(const std::string& script, std::function resultHandler); /** * @brief Add a message handler into JavaScript. @@ -186,50 +339,55 @@ public: * @param[in] exposedObjectName The name of exposed object * @param[in] handler The callback function */ - void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler ); + void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function handler); /** - * @brief Clears the history of Web. + * @brief Register a callback for JavaScript alert. + * + * @param[in] callback The callback function */ - void ClearHistory(); + void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback); /** - * @brief Clears the cache of Web. + * @brief Reply for JavaScript alert. */ - void ClearCache(); + void JavaScriptAlertReply(); /** - * @brief Clears all the cookies of Web. + * @brief Register a callback for JavaScript confirm. + * + * @param[in] callback The callback function */ - void ClearCookies(); + void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback); /** - * @brief Get cache model option. The default is DOCUMENT_VIEWER. - * - * @return The cache model option + * @brief Reply for JavaScript confirm. + * @param[in] confirmed True if confirmed, false otherwise. */ - Dali::WebEnginePlugin::CacheModel GetCacheModel() const; + void JavaScriptConfirmReply(bool confirmed); /** - * @brief Set cache model option. The default is DOCUMENT_VIEWER. + * @brief Register a callback for JavaScript prompt. * - * @param[in] cacheModel The cache model option + * @param[in] callback The callback function */ - void SetCacheModel( Dali::WebEnginePlugin::CacheModel cacheModel ); + void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback); /** - * @brief Gets the cookie acceptance policy. The default is NO_THIRD_PARTY. - * - * @return The cookie acceptance policy + * @brief Reply for JavaScript prompt. + * @param[in] result The result returned from input-field in prompt popup. */ - Dali::WebEnginePlugin::CookieAcceptPolicy GetCookieAcceptPolicy() const; + void JavaScriptPromptReply(const std::string& result); /** - * @brief Sets the cookie acceptance policy. The default is NO_THIRD_PARTY. - * - * @param[in] policy The cookie acceptance policy + * @brief Clears the history of Web. + */ + void ClearHistory(); + + /** + * @brief Clears all tiles resources of Web. */ - void SetCookieAcceptPolicy( Dali::WebEnginePlugin::CookieAcceptPolicy policy ); + void ClearAllTilesResources(); /** * @brief Get user agent string. @@ -243,108 +401,297 @@ public: * * @param[in] userAgent The string value of user agent */ - void SetUserAgent( const std::string& userAgent ); + void SetUserAgent(const std::string& userAgent); /** - * @brief Returns whether JavaScript can be executable. The default is true. + * @brief Sets the size of Web Pages. + */ + void SetSize(int width, int height); + + /** + * @brief Sets background color of web page. * - * @return true if JavaScript executing is enabled, false otherwise + * @param[in] color Background color */ - bool IsJavaScriptEnabled() const; + void SetDocumentBackgroundColor(Dali::Vector4 color); /** - * @brief Enables/disables JavaScript executing. The default is enabled. + * @brief Clears tiles when hidden. * - * @param[in] enabled True if JavaScript executing is enabled, false otherwise + * @param[in] cleared Whether tiles are cleared or not */ - void EnableJavaScript( bool enabled ); + void ClearTilesWhenHidden(bool cleared); /** - * @brief Returns whether JavaScript can be executable. The default is true. + * @brief Sets multiplier of cover area of tile. * - * @return true if images are loaded automatically, false otherwise + * @param[in] multiplier The multiplier of cover area */ - bool AreImagesAutomaticallyLoaded() const; + void SetTileCoverAreaMultiplier(float multiplier); /** - * @brief Enables/disables auto loading of images. The default is enabled. + * @brief Enables cursor by client. * - * @param[in] automatic True if images are loaded automatically, false otherwise + * @param[in] enabled Whether cursor is enabled or not */ - void LoadImagesAutomatically( bool automatic ); + void EnableCursorByClient(bool enabled); /** - * @brief Gets the default text encoding name. + * @brief Gets the selected text. * - * @return The default text encoding name + * @return the selected text */ - const std::string& GetDefaultTextEncodingName() const; + std::string GetSelectedText() const; /** - * @brief Sets the default text encoding name. + * @brief Sends Touch Events. + */ + bool SendTouchEvent(const TouchEvent& touch); + + /** + * @brief Sends key Events. + */ + bool SendKeyEvent(const KeyEvent& event); + + /** + * @brief Set focus. + * @param[in] focused True if web view is focused, false otherwise + */ + void SetFocus(bool focused); + + /** + * @brief Enables/disables mouse events. The default is enabled. * - * @param[in] defaultTextEncodingName The default text encoding name + * @param[in] enabled True if mouse events are enabled, false otherwise */ - void SetDefaultTextEncodingName( const std::string& defaultTextEncodingName ); + void EnableMouseEvents( bool enabled ); /** - * @brief Returns the default font size in pixel. The default value is 16. + * @brief Enables/disables key events. The default is enabled. * - * @return The default font size + * @param[in] enabled True if key events are enabled, false otherwise + */ + void EnableKeyEvents( bool enabled ); + + /** + * @brief Sets zoom factor of the current page. + * @param[in] zoomFactor a new factor to be set. + */ + void SetPageZoomFactor(float zoomFactor); + + /** + * @brief Queries the current zoom factor of the page。 + * @return The current page zoom factor. + */ + float GetPageZoomFactor() const; + + /** + * @brief Sets the current text zoom level。. + * @param[in] zoomFactor a new factor to be set. + */ + void SetTextZoomFactor(float zoomFactor); + + /** + * @brief Gets the current text zoom level. + * @return The current text zoom factor. + */ + float GetTextZoomFactor() const; + + /** + * @brief Gets the current load progress of the page. + * @return The load progress of the page. + */ + float GetLoadProgressPercentage() const; + + /** + * @brief Scales the current page, centered at the given point. + * @param[in] scaleFactor a new factor to be scaled. + * @param[in] point a center coordinate. */ - int GetDefaultFontSize() const; + void SetScaleFactor(float scaleFactor, Dali::Vector2 point); /** - * @brief Sets the default font size in pixel. The default value is 16. + * @brief Gets 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 Request to set the current page's visibility. + * @param[in] visible Visible or not. * - * @param[in] defaultFontSize A new default font size to set + * @return true if changed successfully, false otherwise */ - void SetDefaultFontSize( int defaultFontSize ); + bool SetVisibility(bool visible); /** - * @brief Sets the size of Web Pages. + * @brief Searches 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 */ - void SetSize( int width, int height ); + bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount); /** - * @brief Sends Touch Events. + * @brief Add dynamic certificate path. + * @param[in] host host that required client authentication + * @param[in] certPath the file path stored certificate */ - bool SendTouchEvent( const TouchData& touch ); + void AddDynamicCertificatePath(const std::string& host, const std::string& certPath); /** - * @brief Sends key Events. + * @brief Get snapshot of the specified viewArea of page. + * + * @param[in] viewArea The rectangle of screen shot + * @param[in] scaleFactor The scale factor + * + * @return pixel data of screen shot + */ + Dali::PixelData 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, Dali::WebEnginePlugin::ScreenshotCapturedCallback 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 Sets callback which alled upon geolocation permission request. + * + * @param[in] callback The callback for requesting geolocation permission */ - bool SendKeyEvent( const KeyEvent& event ); + void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback); + + /** + * @brief Update display area. + * @param[in] displayArea The area to display web page + */ + void UpdateDisplayArea(Dali::Rect displayArea); + + /** + * @brief Enable video hole. + * @param[in] enabled True if video hole is enabled, false otherwise + */ + void EnableVideoHole(bool enabled); + + /** + * @brief Sends hover events. + * @param[in] event The hover event would be sent. + */ + bool SendHoverEvent( const HoverEvent& event ); + + /** + * @brief Sends wheel events. + * @param[in] event The wheel event would be sent. + */ + bool SendWheelEvent( const WheelEvent& event ); /** * @brief Connects to this signal to be notified when page loading is started. * - * @return A signal object to connect with. + * @return A signal object to connect with */ Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal(); /** + * @brief Connects to this signal to be notified when page loading is in progress. + * + * @return A signal object to connect with + */ + Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadInProgressSignal(); + + /** * @brief Connects to this signal to be notified when page loading is finished. * - * @return A signal object to connect with. + * @return A signal object to connect with */ Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal(); /** * @brief Connects to this signal to be notified when an error occurs in page loading. * - * @return A signal object to connect with. + * @return A signal object to connect with */ Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal(); -private: // Not intended for application developers + /** + * @brief Connects to this signal to be notified when scroll edge is reached. + * + * @return A signal object to connect with + */ + Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal(); + + /** + * @brief Connects to this signal to be notified when url is changed. + * + * @return A signal object to connect with + */ + Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& UrlChangedSignal(); /** + * @brief Connects to this signal to be notified when form repost decision is requested. + * + * @return A signal object to connect with. + */ + Dali::WebEnginePlugin::WebEngineFormRepostDecisionSignalType& FormRepostDecisionSignal(); + + /** + * @brief Connects to this signal to be notified when frame is rendered. + * + * @return A signal object to connect with. + */ + Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& FrameRenderedSignal(); + + /** + * @brief Connects to this signal to be notified when http request need be intercepted. + * + * @return A signal object to connect with. + */ + Dali::WebEnginePlugin::WebEngineRequestInterceptorSignalType& RequestInterceptorSignal(); + + /** + * @brief Connects to this signal to be notified when console message will be logged. + * + * @return A signal object to connect with. + */ + Dali::WebEnginePlugin::WebEngineConsoleMessageSignalType& ConsoleMessageSignal(); + + /** + * @brief Connects to this signal to be notified when new policy would be decided. + * + * @return A signal object to connect with. + */ + Dali::WebEnginePlugin::WebEnginePolicyDecisionSignalType& PolicyDecisionSignal(); + +private: // Not intended for application developers + /** * @brief Internal constructor */ - explicit DALI_INTERNAL WebEngine( Internal::Adaptor::WebEngine* internal ); + explicit DALI_INTERNAL WebEngine(Internal::Adaptor::WebEngine* internal); }; -} // namespace Dali; +} // namespace Dali #endif // DALI_WEB_ENGINE_H