#define DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
/*
- * Copyright (c) 2020 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.
// EXTERNAL INCLUDES
#include <dali/devel-api/adaptor-framework/web-engine.h>
#include <dali/public-api/images/image-operations.h>
+#include <dali/public-api/object/property-notification.h>
+#include <memory>
// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/web-view/web-view.h>
#include <dali-toolkit/devel-api/visual-factory/visual-base.h>
#include <dali-toolkit/public-api/controls/control-impl.h>
-#include <dali-toolkit/devel-api/controls/web-view/web-view.h>
+#include <dali-toolkit/public-api/controls/image-view/image-view.h>
namespace Dali
{
-
namespace Toolkit
{
-
class KeyEvent;
class TouchEvent;
+class WebBackForwardList;
+class WebContext;
+class WebCookieManager;
+class WebSettings;
class WebView;
namespace Internal
{
-
class WebView : public Control
{
protected:
-
WebView();
- WebView( const std::string& locale, const std::string& timezoneId );
+ WebView(const std::string& locale, const std::string& timezoneId);
+
+ WebView(int argc, char** argv);
virtual ~WebView();
public:
-
/**
* @copydoc Dali::Toolkit::WebView::New()
*/
/**
* @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
*/
- static Toolkit::WebView New( const std::string& locale, const std::string& timezoneId );
+ static Toolkit::WebView New(const std::string& locale, const std::string& timezoneId);
+
+ /**
+ * @brief Get settings of WebEngine.
+ */
+ Dali::Toolkit::WebSettings* GetSettings() const;
+
+ /**
+ * @brief Get context of WebEngine.
+ */
+ Dali::Toolkit::WebContext* GetContext() const;
+
+ /**
+ * @brief Get cookie manager of WebEngine.
+ */
+ Dali::Toolkit::WebCookieManager* GetCookieManager() const;
+
+ /**
+ * @brief Get WebBackForwardList of WebEngine.
+ */
+ Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
+
+ /**
+ * @copydoc Dali::Toolkit::WebView::New( int, char** )
+ */
+ static Toolkit::WebView New(int argc, char** argv);
+
+ /**
+ * @brief Get Favicon of web page.
+ *
+ * @return Handle to a fav icon
+ */
+ Dali::Toolkit::ImageView& GetFavicon();
/**
* @copydoc Dali::Toolkit::WebView::LoadUrl()
*/
- void LoadUrl( const std::string& url );
+ void LoadUrl(const std::string& url);
/**
* @copydoc Dali::WebEngine::LoadHTMLString()
*/
- void LoadHTMLString( const std::string& htmlString );
+ void LoadHtmlString(const std::string& htmlString);
/**
* @copydoc Dali::Toolkit::WebView::Reload()
void Resume();
/**
+ * @copydoc Dali::Toolkit::WebView::ScrollBy()
+ */
+ void ScrollBy(int deltaX, int deltaY);
+
+ /**
* @copydoc Dali::Toolkit::WebView::CanGoForward()
*/
bool CanGoForward();
/**
* @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
*/
- void EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler );
+ void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
/**
* @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
*/
- void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler );
+ void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
/**
- * @copydoc Dali::Toolkit::WebView::ClearHistory()
+ * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptAlertCallback()
*/
- void ClearHistory();
+ void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
+
+ /**
+ * @copydoc Dali::Toolkit::WebView::JavaScriptAlertReply()
+ */
+ void JavaScriptAlertReply();
+
+ /**
+ * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptConfirmCallback()
+ */
+ void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
+
+ /**
+ * @copydoc Dali::Toolkit::WebView::JavaScriptConfirmReply()
+ */
+ void JavaScriptConfirmReply(bool confirmed);
+
+ /**
+ * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptPromptCallback()
+ */
+ void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
+
+ /**
+ * @copydoc Dali::Toolkit::WebView::JavaScriptPromptReply()
+ */
+ void JavaScriptPromptReply(const std::string& result);
/**
- * @copydoc Dali::Toolkit::WebView::ClearCache()
+ * @copydoc Dali::Toolkit::WebView::ClearHistory()
*/
- void ClearCache();
+ void ClearHistory();
/**
- * @copydoc Dali::Toolkit::WebView::ClearCookies()
+ * @brief Clears all tiles resources of Web.
*/
- void ClearCookies();
+ void ClearAllTilesResources();
/**
* @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
/**
+ * @copydoc Dali::Toolkit::WebView::PageLoadInProgressSignal()
+ */
+ Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadInProgressSignal();
+
+ /**
* @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
*/
Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
*/
Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
-public: // Properties
+ /**
+ * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
+ */
+ Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
/**
+ * @copydoc Dali::Toolkit::WebView::UrlChangedSignal()
+ */
+ Dali::Toolkit::WebView::WebViewUrlChangedSignalType& UrlChangedSignal();
+
+public: // Properties
+ /**
* @brief Called when a property of an object of this type is set.
*
* @param[in] object The object whose property is set.
* @param[in] index The property index.
* @param[in] value The new property value.
*/
- static void SetProperty( Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value );
+ static void SetProperty(Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value);
/**
* @brief Called to retrieve a property of an object of this type.
* @param[in] index The property index.
* @return The current value of the property.
*/
- static Dali::Property::Value GetProperty( Dali::BaseObject* object, Dali::Property::Index propertyIndex );
+ static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
/**
* Connects a callback function with the object's signals.
* @return True if the signal was connected.
* @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
*/
- static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
+ static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
private: // From Control
-
/**
* @copydoc Toolkit::Control::OnInitialize()
*/
Vector3 GetNaturalSize() override;
/**
- * @copydoc Toolkit::Control::OnRelayout()
+ * @copydoc Toolkit::Control::OnKeyEvent()
*/
- void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
+ bool OnKeyEvent(const Dali::KeyEvent& event) override;
/**
- * Signal occurs when the Web View has been touched.
- * @param[in] actor The Actor Touched
- * @param[in] touch The Touch Data.
- * @return Whether to consume event or not.
+ * @copydoc Toolkit::Control::OnKeyInputFocusGained()
*/
- bool OnTouchEvent( Actor actor, const Dali::TouchEvent& touch );
+ void OnKeyInputFocusGained() override;
/**
- * @copydoc Toolkit::Control::OnKeyEvent()
+ * @copydoc Toolkit::Control::OnKeyInputFocusLost()
*/
- bool OnKeyEvent( const Dali::KeyEvent& event ) override;
+ void OnKeyInputFocusLost() override;
-private:
+ /**
+ * @copydoc Toolkit::Control::OnSceneConnection()
+ */
+ void OnSceneConnection(int depth) override;
+private:
// Undefined
- WebView( const WebView& webView );
+ WebView(const WebView& webView);
- WebView& operator=( const WebView& webView );
+ WebView& operator=(const WebView& webView);
/**
- * @brief Get cache model option. The default isToolkit::WebView::CacheModel::DOCUMENT_VIEWER.
- * @see Toolkit::WebView::CacheModel::Type
+ * @brief Sets an absolute scroll of the given view.
+ * @param[in] x The coordinate x of scroll
+ * @param[in] y The coordinate y of scroll
*/
- Toolkit::WebView::CacheModel::Type GetCacheModel() const;
+ void SetScrollPosition(int x, int y);
/**
- * @brief Set cache model option. The default isToolkit::WebView::CacheModel::DOCUMENT_VIEWER.
- * @param[in] cacheModel The cache model option
- * @see Toolkit::WebView::CacheModel::Type
+ * @brief Gets the current scroll position of the given view.
+ * @param[out] x The coordinate x of scroll
+ * @param[out] y The coordinate y of scroll
*/
- void SetCacheModel( Toolkit::WebView::CacheModel::Type cacheModel );
+ Dali::Vector2 GetScrollPosition() const;
/**
- * @brief Gets the cookie acceptance policy. The default is Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY.
- * @see Toolkit::WebView::CookieAcceptPolicy::Type
+ * @brief Gets the possible scroll size of the given view.
+ * @param[out] width The width of scroll size
+ * @param[out] height The height of scroll size
*/
- Toolkit::WebView::CookieAcceptPolicy::Type GetCookieAcceptPolicy() const;
+ Dali::Vector2 GetScrollSize() const;
/**
- * @brief Sets the cookie acceptance policy. The default is Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY.
- * @param[in] policy The cookie acceptance policy
- * @see Toolkit::WebView::CookieAcceptPolicy::Type
+ * @brief Gets the last known content's size.
+ * @param[out] width The width of content's size
+ * @param[out] height The height of content's size
*/
- void SetCookieAcceptPolicy( Toolkit::WebView::CookieAcceptPolicy::Type policy );
+ Dali::Vector2 GetContentSize() const;
/**
- * @brief Get user agent string.
- * @return The string value of user agent
+ * @brief Returns the title of the Web.
+ *
+ * @return The title of web page
*/
- const std::string& GetUserAgent() const;
+ std::string GetTitle() const;
/**
- * @brief Set user agent string.
- * @param[in] userAgent The string value of user agent
+ * @brief Sets the background color of web page.
+ * @param[in] color The value of background color.
*/
- void SetUserAgent( const std::string& userAgent );
+ void SetDocumentBackgroundColor(Dali::Vector4 color);
/**
- * @brief Returns whether JavaScript can be executable. The default is true.
+ * @brief Clears tiles when hidden.
*
- * @return true if JavaScript executing is enabled, false otherwise
+ * @param[in] cleared Whether tiles are cleared or not
*/
- bool IsJavaScriptEnabled() const;
+ void ClearTilesWhenHidden(bool cleared);
/**
- * @brief Enables/disables JavaScript executing. The default is enabled.
+ * @brief Sets multiplier of cover area of tile.
*
- * @param[in] enabled True if JavaScript executing is enabled, false otherwise
+ * @param[in] multiplier The multiplier of cover area
*/
- void EnableJavaScript( bool enabled );
+ void SetTileCoverAreaMultiplier(float multiplier);
/**
- * @brief Returns whether images can be loaded automatically. The default is true.
- *
- * @return true if images are loaded automatically, false otherwise
+ * @brief Enables cursor by client.
+ * @param[in] enabled Whether cursor is enabled or not.
*/
- bool AreImagesAutomaticallyLoaded() const;
+ void EnableCursorByClient(bool enabled);
/**
- * @brief Enables/disables auto loading of images. The default is enabled.
- *
- * @param[in] automatic True if images are loaded automatically, false otherwise
+ * @brief Gets the selected text.
+ * @return The selected text
*/
- void LoadImagesAutomatically( bool automatic );
+ std::string GetSelectedText() const;
/**
- * @brief Gets the default text encoding name (e.g. UTF-8).
- *
- * @return The default text encoding name
+ * @brief Get user agent string.
+ * @return The string value of user agent
*/
- const std::string& GetDefaultTextEncodingName() const;
+ const std::string& GetUserAgent() const;
/**
- * @brief Sets the default text encoding name (e.g. UTF-8).
- *
- * @param[in] defaultTextEncodingName The default text encoding name
+ * @brief Set user agent string.
+ * @param[in] userAgent The string value of user agent
+ */
+ void SetUserAgent(const std::string& userAgent);
+
+ /**
+ * @brief Updates display area of web view.
+ * @param[in] source The soource triggers Notification.
+ */
+ void UpdateDisplayArea(Dali::PropertyNotification& source);
+
+ /**
+ * @brief Enable/Disable video hole for video playing.
+ * @param[in] enabled True if video hole is enabled, false otherwise.
+ */
+ void EnableVideoHole(bool enabled);
+
+ /**
+ * @brief Enable blend mode.
+ * @param[in] blendEnabled True if turn on blend mode, false otherwise.
*/
- void SetDefaultTextEncodingName( const std::string& defaultTextEncodingName );
+ void EnableBlendMode(bool blendEnabled);
/**
- * @brief Returns the default font size in pixel. The default value is 16.
+ * @brief Enables/disables mouse events. The default is enabled.
*
- * @return The default font size
+ * @param[in] enabled True if mouse events are enabled, false otherwise
*/
- int GetDefaultFontSize() const;
+ void EnableMouseEvents(bool enabled);
/**
- * @brief Sets the default font size in pixel. The default value is 16.
+ * @brief Enables/disables key events. The default is enabled.
*
- * @param[in] defaultFontSize A new default font size to set
+ * @param[in] enabled True if key events enabled, false otherwise
*/
- void SetDefaultFontSize( int defaultFontSize );
+ void EnableKeyEvents(bool enabled);
/**
* @brief Callback function to be called when page load started.
* @param[in] url The url currently being loaded
*/
- void OnPageLoadStarted( const std::string& url );
+ void OnPageLoadStarted(const std::string& url);
+
+ /**
+ * @brief Callback function to be called when page is loading in progress.
+ * @param[in] url The url currently being loaded
+ */
+ void OnPageLoadInProgress(const std::string& url);
/**
* @brief Callback function to be called when page load finished.
* @param[in] url The url currently being loaded
*/
- void OnPageLoadFinished( const std::string& url );
+ void OnPageLoadFinished(const std::string& url);
/**
* @brief Callback function to be called when there is an error in page loading.
* @param[in] url The url currently being loaded
* @param[in] errorCode The error code
*/
- void OnPageLoadError( const std::string& url, int errorCode );
+ void OnPageLoadError(const std::string& url, int errorCode);
-private:
+ /**
+ * @brief Callback function to be called when scroll edge is reached.
+ * @param[in] e The scroll edge reached.
+ */
+ void OnScrollEdgeReached(Dali::WebEnginePlugin::ScrollEdge edge);
+
+ /**
+ * @brief Callback function to be called when url is changed.
+ * @param[in] url The url currently being loaded
+ */
+ void OnUrlChanged(const std::string& url);
- std::string mUrl;
- Dali::Toolkit::Visual::Base mVisual;
- Dali::Size mWebViewSize;
- Dali::WebEngine mWebEngine;
+ /**
+ * Signal occurs when the Web View has been touched.
+ * @param[in] actor The Actor Touched
+ * @param[in] touch The Touch Data.
+ * @return Whether to consume event or not.
+ */
+ bool OnTouchEvent(Actor actor, const Dali::TouchEvent& touch);
- Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadStartedSignal;
- Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadFinishedSignal;
- Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType mPageLoadErrorSignal;
+ /**
+ * Signal occurs when the Web View has been hovered.
+ * @param[in] actor The Actor Hovered
+ * @param[in] hover The Hover Data.
+ * @return Whether to consume event or not.
+ */
+ bool OnHoverEvent(Actor actor, const Dali::HoverEvent& hover);
+
+ /**
+ * Signal occurs when the Web View receives wheel event.
+ * @param[in] actor The Actor that receives Wheel event.
+ * @param[in] wheel The Wheel Data.
+ * @return Whether to consume event or not.
+ */
+ bool OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel);
+
+private:
+ std::string mUrl;
+ Dali::Toolkit::Visual::Base mVisual;
+ Dali::Size mWebViewSize;
+ Dali::WebEngine mWebEngine;
+
+ Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadStartedSignal;
+ Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadInProgressSignal;
+ Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadFinishedSignal;
+ Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType mPageLoadErrorSignal;
+ Dali::Toolkit::WebView::WebViewUrlChangedSignalType mUrlChangedSignal;
+ Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType mScrollEdgeReachedSignal;
+
+ std::unique_ptr<Dali::Toolkit::WebContext> mWebContext;
+ std::unique_ptr<Dali::Toolkit::WebCookieManager> mWebCookieManager;
+ std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
+ std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
+ Dali::Toolkit::ImageView mFaviconView;
+
+ Dali::PropertyNotification mPositionUpdateNotification;
+ Dali::PropertyNotification mSizeUpdateNotification;
+ Dali::PropertyNotification mScaleUpdateNotification;
+ bool mVideoHoleEnabled;
+ Dali::Rect<int> mWebViewArea;
+ bool mMouseEventsEnabled;
+ bool mKeyEventsEnabled;
};
} // namespace Internal
-inline Toolkit::Internal::WebView& GetImpl( Toolkit::WebView& handle )
+inline Toolkit::Internal::WebView& GetImpl(Toolkit::WebView& handle)
{
- DALI_ASSERT_ALWAYS( handle );
+ DALI_ASSERT_ALWAYS(handle);
Dali::RefObject& impl = handle.GetImplementation();
- return static_cast< Toolkit::Internal::WebView& >( impl );
+ return static_cast<Toolkit::Internal::WebView&>(impl);
}
-inline const Toolkit::Internal::WebView& GetImpl( const Toolkit::WebView& handle )
+inline const Toolkit::Internal::WebView& GetImpl(const Toolkit::WebView& handle)
{
- DALI_ASSERT_ALWAYS( handle );
+ DALI_ASSERT_ALWAYS(handle);
const Dali::RefObject& impl = handle.GetImplementation();
- return static_cast< const Toolkit::Internal::WebView& >( impl );
+ return static_cast<const Toolkit::Internal::WebView&>(impl);
}
} // namespace Toolkit
projects / platform / core / uifw / dali-toolkit.git / blobdiff