X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fcontrols%2Fweb-view%2Fweb-view.h;h=48e57cecd435d5d3e59911c905a8f6feaf7aad60;hb=8d7facdc053ca256566f8e91c180b9027692ef2a;hp=ad39718069204bc6e3da3bc0927772e753b6ceb3;hpb=b514a4671789bee2f03b0177393b9a21f62ac2c3;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 old mode 100644 new mode 100755 index ad39718..48e57ce --- 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) 2018 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 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. @@ -22,18 +22,23 @@ #include // INTERNAL INCLUDES +#include #include namespace Dali { - namespace Toolkit { +class ImageView; +class WebBackForwardList; +class WebContext; +class WebCookieManager; +class WebSettings; namespace Internal DALI_INTERNAL { - class WebView; -} // namespace Internal +class WebView; +} // namespace DALI_INTERNAL /** * @addtogroup dali_toolkit_controls_web_view @@ -53,66 +58,12 @@ class DALI_TOOLKIT_API WebView : public Control public: /** - * @brief A structure used to contain the cache model enumeration. - */ - struct CacheModel - { - /** - * @brief Enumeration for cache model options. - */ - enum Type - { - /** - * @brief Use the smallest cache capacity. - */ - DOCUMENT_VIEWER, - - /** - * @brief Use the bigger cache capacity than DocumentBrowser. - */ - DOCUMENT_BROWSER, - - /** - * @brief Use the biggest cache capacity. - */ - PRIMARY_WEB_BROWSER - }; - }; - - /** - * @brief A structure used to contain the cookie acceptance policy enumeration. - */ - struct CookieAcceptPolicy - { - /** - * @brief Enumeration for the cookies accept policies. - */ - enum Type - { - /** - * @brief Accepts every cookie sent from any page. - */ - ALWAYS, - - /** - * @brief Rejects all the cookies. - */ - NEVER, - - /** - * @brief Accepts only cookies set by the main document that is loaded. - */ - NO_THIRD_PARTY - }; - }; - - /** * @brief Enumeration for the start and end property ranges for this control. */ enum PropertyRange { PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, - PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, + PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, }; /** @@ -129,54 +80,44 @@ public: URL = PROPERTY_START_INDEX, /** - * @brief The cache model. - * @details Name "cacheModel", type WebView::CacheModel::Type (Property::INTEGER) or Property::STRING. - * @note Default is WebView::CacheModel::DOCUMENT_VIEWER. - * @see WebView::CacheModel::Type - */ - CACHE_MODEL, - - /** - * @brief The cookie acceptance policy. - * @details Name "cookieAcceptPolicy", type WebView::CookieAcceptPolicy::Type (Property::INTEGER) or Property::STRING. - * @note Default is WebView::CookieAcceptPolicy::NO_THIRD_PARTY. - * @see WebView::CookieAcceptPolicy::Type + * @brief The user agent string. + * @details name "userAgent", type Property::STRING. */ - COOKIE_ACCEPT_POLICY, + USER_AGENT, /** - * @brief The user agent string. - * @details Name "userAgent", type Property::STRING. + * @brief The current position of scroll. + * @details name "scrollPosition", type Property::VECTOR2. */ - USER_AGENT, + SCROLL_POSITION, /** - * @brief Whether JavaScript is enabled. - * @details Name "enableJavaScript", type Property::BOOLEAN. - * @note Default is true. + * @brief The current size of scroll. + * @details name "scrollSize", type Property::VECTOR2. + * @note The value is read-only. */ - ENABLE_JAVASCRIPT, + SCROLL_SIZE, /** - * @brief Whether images can be loaded automatically. - * @details Name "loadImagesAutomatically", type Property::BOOLEAN. - * @note Default is true. + * @brief The current size of content. + * @details name "contentSize", type Property::VECTOR2. + * @note The value is read-only. */ - LOAD_IMAGES_AUTOMATICALLY, + CONTENT_SIZE, /** - * @brief The default text encoding name. - * @details Name "defaultTextEncodingName", type Property::STRING. - * @note If the value is not set, the web engine detects web page's text encoding. + * @brief The title of web page. + * @details name "title", type Property::STRING. + * @note The value is read-only. */ - DEFAULT_TEXT_ENCODING_NAME, + TITLE, /** - * @brief The default font size in pixel. - * @details Name "defaultFontSize", type Property::INT. - * @note Default is 16. + * @brief Whether video hole is enabled or not. + * @details name "videoHoleEnabled", type Property::BOOLEAN. + * @note The value is read-only. */ - DEFAULT_FONT_SIZE + VIDEO_HOLE_ENABLED, }; }; @@ -185,94 +126,39 @@ public: */ enum class LoadErrorCode { - /** - * @brief Unknown. - */ - UNKNOWN = 0, - - /** - * @brief User canceled. - */ - CANCELED, - - /** - * @brief Can't show the page for this MIME type. - */ - CANT_SUPPORT_MIMETYPE, - - /** - * @brief File IO error. - */ - FAILED_FILE_IO, - - /** - * @brief Cannot connect to the network. - */ - CANT_CONNECT, - - /** - * @brief Fail to look up host from the DNS. - */ - CANT_LOOKUP_HOST, - - /** - * @brief Fail to SSL/TLS handshake. - */ - FAILED_TLS_HANDSHAKE, - - /** - * @brief Received certificate is invalid. - */ - INVALID_CERTIFICATE, - - /** - * @brief Connection timeout. - */ - REQUEST_TIMEOUT, - - /** - * @brief Too many redirects. - */ - TOO_MANY_REDIRECTS, - - /** - * @brief Too many requests during this load. - */ - TOO_MANY_REQUESTS, - - /** - * @brief Malformed URL. - */ - BAD_URL, - - /** - * @brief Unsupported scheme. - */ - UNSUPPORTED_SCHEME, - - /** - * @brief User authentication failed on the server. - */ - AUTHENTICATION, - - /** - * @brief Web server has an internal server error. - */ - INTERNAL_SERVER + 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 signal type related with page loading. */ - typedef Signal< void ( WebView, const std::string& ) > WebViewPageLoadSignalType; + using WebViewPageLoadSignalType = Signal< void( WebView, const std::string& ) >; /** * @brief WebView signal type related with page loading error. */ - typedef Signal< void ( WebView, const std::string&, LoadErrorCode ) > WebViewPageLoadErrorSignalType; + using WebViewPageLoadErrorSignalType = Signal< void( WebView, const std::string&, LoadErrorCode ) >; -public: + /** + * @brief WebView signal type related with scroll edge reached. + */ + using WebViewScrollEdgeReachedSignalType = Signal< void( WebView, Dali::WebEnginePlugin::ScrollEdge ) >; +public: /** * @brief Creates an initialized WebView. * @return A handle to a newly allocated Dali WebView @@ -287,7 +173,15 @@ public: * @param [in] locale The locale of Web * @param [in] timezoneId The timezoneId of Web */ - static WebView New( const std::string& locale, const std::string& timezoneId ); + static WebView New(const std::string& locale, const std::string& timezoneId); + + /** + * @brief Creates 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 ); /** * @brief Creates an uninitialized WebView. @@ -306,7 +200,7 @@ public: * * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation */ - WebView( const WebView& WebView ); + WebView(const WebView& WebView); /** * @brief Assignment operator. @@ -314,7 +208,7 @@ public: * @param[in] WebView The WebView to assign from * @return The updated WebView */ - WebView& operator=( const WebView& WebView ); + WebView& operator=(const WebView& WebView); /** * @brief Downcasts a handle to WebView handle. @@ -325,21 +219,48 @@ public: * @param[in] handle Handle to an object * @return Handle to a WebView or an uninitialized handle */ - static WebView DownCast( BaseHandle handle ); + static WebView DownCast(BaseHandle handle); + + /** + * @brief Get WebSettings of WebEngine. + */ + 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. + * + * @return Handle to a fav icon + */ + Dali::Toolkit::ImageView& GetFavicon(); /** * @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 Loads 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 ); + void LoadHtmlString(const std::string& htmlString); /** * @brief Reloads the Web. @@ -362,6 +283,13 @@ public: void Resume(); /** + * @brief Scrolls the webpage 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 ); + + /** * @brief Returns whether forward is possible. * * @return True if forward is possible, false otherwise @@ -391,14 +319,14 @@ 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 Evaluates JavaScript code represented as a string. * * @param[in] script The JavaScript code */ - void EvaluateJavaScript( const std::string& script ); + void EvaluateJavaScript(const std::string& script); /** * @brief Inject a JavaScript object with a message handler into the WebView. @@ -424,22 +352,17 @@ 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 ); - - /** - * @brief Clears the history of Web. - */ - void ClearHistory(); + void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function handler); /** - * @brief Clears the cache of Web. + * @brief Clears all tiles resources of Web. */ - void ClearCache(); + void ClearAllTilesResources(); /** - * @brief Clears all the cookies of Web. + * @brief Clears the history of Web. */ - void ClearCookies(); + void ClearHistory(); /** * @brief Connects to this signal to be notified when page loading is started. @@ -462,24 +385,29 @@ public: */ WebViewPageLoadErrorSignalType& PageLoadErrorSignal(); -public: // 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. + */ + WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal(); +public: // Not intended for application developers /// @cond internal /** * @brief Creates a handle using the Toolkit::Internal implementation. * * @param[in] implementation The WebView implementation */ - DALI_INTERNAL WebView( Internal::WebView& implementation ); + DALI_INTERNAL WebView(Internal::WebView& implementation); /** * @brief Allows the creation of this WebView from an Internal::CustomActor pointer. * * @param[in] internal A pointer to the internal CustomActor */ - explicit DALI_INTERNAL WebView( Dali::Internal::CustomActor* internal ); + explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal); /// @endcond - }; /**