#define DALI_WEB_ENGINE_IMPL_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.
#include <dali/public-api/object/base-object.h>
// INTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/web-engine.h>
#include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
+#include <dali/devel-api/adaptor-framework/web-engine.h>
namespace Dali
{
+// forward declaration
+class WebEngineBackForwardList;
+class WebEngineContext;
+class WebEngineCookieManager;
+class WebEngineSettings;
namespace Internal
{
-
namespace Adaptor
{
-
class WebEngine;
-typedef IntrusivePtr< WebEngine > WebEnginePtr;
+typedef IntrusivePtr<WebEngine> WebEnginePtr;
/**
* @brief WebEngine class is used for Web.
class WebEngine : public Dali::BaseObject
{
public:
-
/**
- * @brief Creates a new WebEngine handle
+ * @brief Create a new WebEngine handle
*
* @return WebEngine pointer
*/
/**
* @copydoc Dali::WebEngine::Create()
*/
- void Create( int width, int height, const std::string& locale, const std::string& timezoneId );
+ void Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId);
+
+ /**
+ * @copydoc Dali::WebEngine::Create()
+ */
+ void Create(uint32_t width, uint32_t height, uint32_t argc, char** argv);
/**
* @copydoc Dali::WebEngine::Destroy()
Dali::NativeImageInterfacePtr GetNativeImageSource();
/**
+ * @copydoc Dali::WebEngine::GetSettings()
+ */
+ Dali::WebEngineSettings& GetSettings() const;
+
+ /**
+ * @copydoc Dali::WebEngine::GetContext()
+ */
+ Dali::WebEngineContext& GetContext() const;
+
+ /**
+ * @copydoc Dali::WebEngine::GetCookieManager()
+ */
+ Dali::WebEngineCookieManager& GetCookieManager() const;
+
+ /**
+ * @copydoc Dali::WebEngine::GetBackForwardList()
+ */
+ Dali::WebEngineBackForwardList& GetBackForwardList() const;
+
+ /**
* @copydoc Dali::WebEngine::LoadUrl()
*/
- void LoadUrl( const std::string& url );
+ void LoadUrl(const std::string& url);
+
+ /**
+ * @copydoc Dali::WebEngine::GetTitle()
+ */
+ std::string GetTitle() const;
+
+ /**
+ * @copydoc Dali::WebEngine::GetFavicon()
+ */
+ Dali::PixelData GetFavicon() const;
/**
* @copydoc Dali::WebEngine::GetUrl()
*/
- const std::string& GetUrl();
+ std::string GetUrl() const;
+
+ /**
+ * @copydoc Dali::WebEngine::GetUserAgent()
+ */
+ std::string GetUserAgent() const;
+
+ /**
+ * @copydoc Dali::WebEngine::SetUserAgent()
+ */
+ void SetUserAgent(const std::string& userAgent);
+
+ /**
+ * @copydoc Dali::WebEngine::LoadHtmlString()
+ */
+ void LoadHtmlString(const std::string& htmlString);
+
+ /**
+ * @copydoc Dali::WebEngine::LoadHtmlStringOverrideCurrentEntry()
+ */
+ bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
/**
- * @copydoc Dali::WebEngine::LoadHTMLString()
+ * @copydoc Dali::WebEngine::LoadContents()
*/
- void LoadHTMLString( const std::string& htmlString );
+ bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
/**
* @copydoc Dali::WebEngine::Reload()
void Reload();
/**
+ * @copydoc Dali::WebEngine::ReloadWithoutCache()
+ */
+ bool ReloadWithoutCache();
+
+ /**
* @copydoc Dali::WebEngine::StopLoading()
*/
void StopLoading();
void Resume();
/**
+ * @copydoc Dali::WebEngine::SuspendNetworkLoading()
+ */
+ void SuspendNetworkLoading();
+
+ /**
+ * @copydoc Dali::WebEngine::ResumeNetworkLoading()
+ */
+ void ResumeNetworkLoading();
+
+ /**
+ * @copydoc Dali::WebEngine::AddCustomHeader()
+ */
+ bool AddCustomHeader(const std::string& name, const std::string& value);
+
+ /**
+ * @copydoc Dali::WebEngine::RemoveCustomHeader()
+ */
+ bool RemoveCustomHeader(const std::string& name);
+
+ /**
+ * @copydoc Dali::WebEngine::StartInspectorServer()
+ */
+ uint32_t StartInspectorServer(uint32_t port);
+
+ /**
+ * @copydoc Dali::WebEngine::StopInspectorServer()
+ */
+ bool StopInspectorServer();
+
+ /**
+ * @copydoc Dali::WebEngine::ScrollBy()
+ */
+ void ScrollBy(int32_t deltaX, int32_t deltaY);
+
+ /**
+ * @copydoc Dali::WebEngine::ScrollEdgeBy()
+ */
+ bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY);
+
+ /**
+ * @copydoc Dali::WebEngine::SetScrollPosition()
+ */
+ void SetScrollPosition(int32_t x, int32_t y);
+
+ /**
+ * @copydoc Dali::WebEngine::GetScrollPosition()
+ */
+ Dali::Vector2 GetScrollPosition() const;
+
+ /**
+ * @copydoc Dali::WebEngine::GetScrollSize()
+ */
+ Dali::Vector2 GetScrollSize() const;
+
+ /**
+ * @copydoc Dali::WebEngine::GetContentSize()
+ */
+ Dali::Vector2 GetContentSize() const;
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterJavaScriptAlertCallback()
+ */
+ void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::JavaScriptAlertReply()
+ */
+ void JavaScriptAlertReply();
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterJavaScriptConfirmCallback()
+ */
+ void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::JavaScriptConfirmReply()
+ */
+ void JavaScriptConfirmReply(bool confirmed);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterJavaScriptPromptCallback()
+ */
+ void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::JavaScriptPromptReply()
+ */
+ void JavaScriptPromptReply(const std::string& result);
+
+ /**
+ * @copydoc Dali::WebEngine::CreateHitTest()
+ */
+ std::unique_ptr<Dali::WebEngineHitTest> CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode);
+
+ /**
+ * @copydoc Dali::WebEngine::CreateHitTestAsynchronously()
+ */
+ bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback);
+
+ /**
* @copydoc Dali::WebEngine::CanGoForward()
*/
bool CanGoForward();
/**
* @copydoc Dali::WebEngine::EvaluateJavaScript()
*/
- void EvaluateJavaScript( const std::string& script, std::function< void(const std::string&) > resultHandler );
+ void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler);
/**
* @copydoc Dali::WebEngine::AddJavaScriptMessageHandler()
*/
- void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void(const std::string&) > handler );
+ void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler);
+
+ /**
+ * @copydoc Dali::WebEngine::ClearAllTilesResources()
+ */
+ void ClearAllTilesResources();
/**
* @copydoc Dali::WebEngine::ClearHistory()
void ClearHistory();
/**
- * @copydoc Dali::WebEngine::ClearCache()
+ * @copydoc Dali::WebEngine::SetSize()
*/
- void ClearCache();
+ void SetSize(uint32_t width, uint32_t height);
/**
- * @copydoc Dali::WebEngine::ClearCookies()
+ * @copydoc Dali::WebEngine::EnableMouseEvents()
*/
- void ClearCookies();
+ void EnableMouseEvents(bool enabled);
/**
- * @copydoc Dali::WebEngine::GetCacheModel()
+ * @copydoc Dali::WebEngine::EnableKeyEvents()
*/
- Dali::WebEnginePlugin::CacheModel GetCacheModel() const;
+ void EnableKeyEvents(bool enabled);
/**
- * @copydoc Dali::WebEngine::SetCacheModel()
+ * @copydoc Dali::WebEngine::SetDocumentBackgroundColor()
*/
- void SetCacheModel( Dali::WebEnginePlugin::CacheModel cacheModel );
+ void SetDocumentBackgroundColor(Dali::Vector4 color);
/**
- * @copydoc Dali::WebEngine::GetCookieAcceptPolicy()
+ * @copydoc Dali::WebEngine::ClearTilesWhenHidden()
*/
- Dali::WebEnginePlugin::CookieAcceptPolicy GetCookieAcceptPolicy() const;
+ void ClearTilesWhenHidden(bool cleared);
/**
- * @copydoc Dali::WebEngine::SetCookieAcceptPolicy()
+ * @copydoc Dali::WebEngine::SetTileCoverAreaMultiplier()
*/
- void SetCookieAcceptPolicy( Dali::WebEnginePlugin::CookieAcceptPolicy policy );
+ void SetTileCoverAreaMultiplier(float multiplier);
/**
- * @copydoc Dali::WebEngine::GetUserAgent()
+ * @copydoc Dali::WebEngine::EnableCursorByClient()
*/
- const std::string& GetUserAgent() const;
+ void EnableCursorByClient(bool enabled);
/**
- * @copydoc Dali::WebEngine::SetUserAgent()
+ * @copydoc Dali::WebEngine::GetSelectedText()
*/
- void SetUserAgent( const std::string& userAgent );
+ std::string GetSelectedText() const;
/**
- * @copydoc Dali::WebEngine::IsJavaScriptEnabled()
+ * @copydoc Dali::WebEngine::SendTouchEvent()
*/
- bool IsJavaScriptEnabled() const;
+ bool SendTouchEvent(const Dali::TouchEvent& touch);
/**
- * @copydoc Dali::WebEngine::EnableJavaScript()
+ * @copydoc Dali::WebEngine::SendKeyEvent()
*/
- void EnableJavaScript( bool enabled );
+ bool SendKeyEvent(const Dali::KeyEvent& event);
/**
- * @copydoc Dali::WebEngine::AreImagesAutomaticallyLoaded()
+ * @copydoc Dali::WebEngine::SetFocus()
*/
- bool AreImagesAutomaticallyLoaded() const;
+ void SetFocus(bool focused);
/**
- * @copydoc Dali::WebEngine::LoadImagesAutomatically()
+ * @copydoc Dali::WebEngine::SetPageZoomFactor()
*/
- void LoadImagesAutomatically( bool automatic );
+ void SetPageZoomFactor(float zoomFactor);
/**
- * @copydoc Dali::WebEngine::GetDefaultTextEncodingName()
+ * @copydoc Dali::WebEngine::GetPageZoomFactor()
*/
- const std::string& GetDefaultTextEncodingName() const;
+ float GetPageZoomFactor() const;
/**
- * @copydoc Dali::WebEngine::SetDefaultTextEncodingName()
+ * @copydoc Dali::WebEngine::SetTextZoomFactor()
*/
- void SetDefaultTextEncodingName( const std::string& defaultTextEncodingName );
+ void SetTextZoomFactor(float zoomFactor);
/**
- * @copydoc Dali::WebEngine::GetDefaultFontSize()
+ * @copydoc Dali::WebEngine::GetTextZoomFactor()
*/
- int GetDefaultFontSize() const;
+ float GetTextZoomFactor() const;
/**
- * @copydoc Dali::WebEngine::SetDefaultFontSize()
+ * @copydoc Dali::WebEngine::GetLoadProgressPercentage()
*/
- void SetDefaultFontSize( int defaultFontSize );
+ float GetLoadProgressPercentage() const;
/**
- * @copydoc Dali::WebEngine::SetSize()
+ * @copydoc Dali::WebEngine::SetScaleFactor()
*/
- void SetSize( int width, int height );
+ void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
/**
- * @copydoc Dali::WebEngine::SendTouchEvent()
+ * @copydoc Dali::WebEngine::GetScaleFactor()
*/
- bool SendTouchEvent( const Dali::TouchData& touch );
+ float GetScaleFactor() const;
/**
- * @copydoc Dali::WebEngine::SendKeyEvent()
+ * @copydoc Dali::WebEngine::ActivateAccessibility()
*/
- bool SendKeyEvent( const Dali::KeyEvent& event );
+ void ActivateAccessibility(bool activated);
/**
- * @copydoc Dali::WebEngine::PageLoadStartedSignal()
+ * @copydoc Dali::WebEngine::SetVisibility()
*/
- Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
+ bool SetVisibility(bool visible);
/**
- * @copydoc Dali::WebEngine::PageLoadFinishedSignal()
+ * @copydoc Dali::WebEngine::HighlightText()
*/
- Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
+ bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
/**
- * @copydoc Dali::WebEngine::PageLoadErrorSignal()
+ * @copydoc Dali::WebEngine::AddDynamicCertificatePath()
*/
- Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
+ void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
-private:
+ /**
+ * @copydoc Dali::WebEngine::GetScreenshot()
+ */
+ Dali::PixelData GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor);
+
+ /**
+ * @copydoc Dali::WebEngine::GetScreenshotAsync()
+ */
+ bool GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::IsVideoPlaying()
+ */
+ bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterGeolocationPermissionCallback()
+ */
+ void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::UpdateDisplayArea()
+ */
+ void UpdateDisplayArea(Dali::Rect<int32_t> displayArea);
+
+ /**
+ * @copydoc Dali::WebEngine::EnableVideoHole()
+ */
+ void EnableVideoHole(bool enabled);
+
+ /**
+ * @copydoc Dali::WebEngine::SendHoverEvent()
+ */
+ bool SendHoverEvent(const Dali::HoverEvent& event);
+
+ /**
+ * @copydoc Dali::WebEngine::SendWheelEvent()
+ */
+ bool SendWheelEvent(const Dali::WheelEvent& event);
+
+ /**
+ * @copydoc Dali::WebEngine::FrameRenderedSignal()
+ */
+ Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& FrameRenderedSignal();
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterPageLoadStartedCallback()
+ */
+ void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
/**
+ * @copydoc Dali::WebEngine::RegisterPageLoadInProgressCallback()
+ */
+ void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterPageLoadFinishedCallback()
+ */
+ void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterPageLoadErrorCallback()
+ */
+ void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterScrollEdgeReachedCallback()
+ */
+ void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterUrlChangedCallback()
+ */
+ void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterFormRepostDecidedCallback()
+ */
+ void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterRequestInterceptorCallback()
+ */
+ void RegisterRequestInterceptorCallback(Dali::WebEnginePlugin::WebEngineRequestInterceptorCallback callback);
+
+ /**
+ @copydoc Dali::WebEngine::RegisterConsoleMessageReceivedCallback()
+ */
+ void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback);
+
+ /**
+ @copydoc Dali::WebEngine::RegisterResponsePolicyDecidedCallback()
+ */
+ void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterCertificateConfirmedCallback()
+ */
+ void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterSslCertificateChangedCallback()
+ */
+ void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterHttpAuthHandlerCallback()
+ */
+ void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterContextMenuShownCallback()
+ */
+ void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::RegisterContextMenuHiddenCallback()
+ */
+ void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback);
+
+ /**
+ * @copydoc Dali::WebEngine::GetPlainTextAsynchronously()
+ */
+ void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
+
+private:
+ /**
* @brief Constructor.
*/
WebEngine();
virtual ~WebEngine();
// Undefined copy constructor
- WebEngine( const WebEngine& WebEngine );
+ WebEngine(const WebEngine& WebEngine);
// Undefined assignment operator
- WebEngine& operator=( const WebEngine& WebEngine );
+ WebEngine& operator=(const WebEngine& WebEngine);
/**
- * @brief Initializes member data.
+ * @brief Initialize member data.
*
* @return Whether the initialization succeed or not.
*/
bool Initialize();
/**
- * @brief Initializes library handle by loading web engine plugin.
+ * @brief Initialize library handle by loading web engine plugin.
*
* @return Whether the initialization succeed or not.
*/
bool InitializePluginHandle();
private:
-
typedef Dali::WebEnginePlugin* (*CreateWebEngineFunction)();
- typedef void (*DestroyWebEngineFunction)( Dali::WebEnginePlugin* plugin );
+ typedef void (*DestroyWebEngineFunction)(Dali::WebEnginePlugin* plugin);
- Dali::WebEnginePlugin* mPlugin; ///< WebEnginePlugin instance
- void* mHandle; ///< Handle for the loaded library
- CreateWebEngineFunction mCreateWebEnginePtr; ///< Function to create plugin instance
- DestroyWebEngineFunction mDestroyWebEnginePtr; ///< Function to destroy plugin instance
+ Dali::WebEnginePlugin* mPlugin; ///< WebEnginePlugin instance
+ void* mHandle; ///< Handle for the loaded library
+ CreateWebEngineFunction mCreateWebEnginePtr; ///< Function to create plugin instance
+ DestroyWebEngineFunction mDestroyWebEnginePtr; ///< Function to destroy plugin instance
};
} // namespace Adaptor
} // namespace Internal
-inline static Internal::Adaptor::WebEngine& GetImplementation( Dali::WebEngine& webEngine )
+inline static Internal::Adaptor::WebEngine& GetImplementation(Dali::WebEngine& webEngine)
{
- DALI_ASSERT_ALWAYS( webEngine && "WebEngine handle is empty." );
+ DALI_ASSERT_ALWAYS(webEngine && "WebEngine handle is empty.");
BaseObject& handle = webEngine.GetBaseObject();
- return static_cast< Internal::Adaptor::WebEngine& >( handle );
+ return static_cast<Internal::Adaptor::WebEngine&>(handle);
}
-inline static const Internal::Adaptor::WebEngine& GetImplementation( const Dali::WebEngine& webEngine )
+inline static const Internal::Adaptor::WebEngine& GetImplementation(const Dali::WebEngine& webEngine)
{
- DALI_ASSERT_ALWAYS( webEngine && "WebEngine handle is empty." );
+ DALI_ASSERT_ALWAYS(webEngine && "WebEngine handle is empty.");
const BaseObject& handle = webEngine.GetBaseObject();
- return static_cast< const Internal::Adaptor::WebEngine& >( handle );
+ return static_cast<const Internal::Adaptor::WebEngine&>(handle);
}
-} // namespace Dali;
+} // namespace Dali
#endif
-
projects / platform / core / uifw / dali-adaptor.git / blobdiff