Add APIs for ssl certificate and http authentication.
[platform/core/uifw/dali-adaptor.git] / dali / internal / web-engine / common / web-engine-impl.h
index a2a6571..b572c76 100755 (executable)
@@ -2,7 +2,7 @@
 #define DALI_WEB_ENGINE_IMPL_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.
 #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;
@@ -36,13 +35,11 @@ class WebEngineSettings;
 
 namespace Internal
 {
-
 namespace Adaptor
 {
-
 class WebEngine;
 
-typedef IntrusivePtr< WebEngine > WebEnginePtr;
+typedef IntrusivePtr<WebEngine> WebEnginePtr;
 
 /**
  * @brief WebEngine class is used for Web.
@@ -50,7 +47,6 @@ typedef IntrusivePtr< WebEngine > WebEnginePtr;
 class WebEngine : public Dali::BaseObject
 {
 public:
-
   /**
    * @brief Creates a new WebEngine handle
    *
@@ -61,12 +57,12 @@ public:
   /**
    * @copydoc Dali::WebEngine::Create()
    */
-  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);
 
   /**
    * @copydoc Dali::WebEngine::Create()
    */
-  void Create( int width, int height, int argc, char** argv );
+  void Create(int width, int height, int argc, char** argv);
 
   /**
    * @copydoc Dali::WebEngine::Destroy()
@@ -101,7 +97,7 @@ public:
   /**
    * @copydoc Dali::WebEngine::LoadUrl()
    */
-  void LoadUrl( const std::string& url );
+  void LoadUrl(const std::string& url);
 
   /**
    * @copydoc Dali::WebEngine::GetTitle()
@@ -126,12 +122,22 @@ public:
   /**
    * @copydoc Dali::WebEngine::SetUserAgent()
    */
-  void SetUserAgent( const std::string& userAgent );
+  void SetUserAgent(const std::string& userAgent);
 
   /**
    * @copydoc Dali::WebEngine::LoadHtmlString()
    */
-  void LoadHtmlString( const std::string& htmlString );
+  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::LoadContents()
+   */
+  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()
@@ -139,6 +145,11 @@ public:
   void Reload();
 
   /**
+   * @copydoc Dali::WebEngine::ReloadWithoutCache()
+   */
+  bool ReloadWithoutCache();
+
+  /**
    * @copydoc Dali::WebEngine::StopLoading()
    */
   void StopLoading();
@@ -154,29 +165,94 @@ public:
   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( int deltaX, int deltaY );
+  void ScrollBy(int deltaX, int deltaY);
+
+  /**
+   * @copydoc Dali::WebEngine::ScrollEdgeBy()
+   */
+  bool ScrollEdgeBy(int deltaX, int deltaY);
 
   /**
    * @copydoc Dali::WebEngine::SetScrollPosition()
    */
-  void SetScrollPosition( int x, int y );
+  void SetScrollPosition(int x, int y);
 
   /**
    * @copydoc Dali::WebEngine::GetScrollPosition()
    */
-  void GetScrollPosition( int& x, int& y ) const;
+  Dali::Vector2 GetScrollPosition() const;
 
   /**
    * @copydoc Dali::WebEngine::GetScrollSize()
    */
-  void GetScrollSize( int& width, int& height ) const;
+  Dali::Vector2 GetScrollSize() const;
 
   /**
    * @copydoc Dali::WebEngine::GetContentSize()
    */
-  void GetContentSize( int& width, int& height ) const;
+  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::CanGoForward()
@@ -201,12 +277,12 @@ public:
   /**
    * @copydoc Dali::WebEngine::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::WebEngine::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::WebEngine::ClearAllTilesResources()
@@ -221,22 +297,152 @@ public:
   /**
    * @copydoc Dali::WebEngine::SetSize()
    */
-  void SetSize( int width, int height );
+  void SetSize(int width, int height);
+
+  /**
+   * @copydoc Dali::WebEngine::EnableMouseEvents()
+   */
+  void EnableMouseEvents(bool enabled);
+
+  /**
+   * @copydoc Dali::WebEngine::EnableKeyEvents()
+   */
+  void EnableKeyEvents(bool enabled);
+
+  /**
+   * @copydoc Dali::WebEngine::SetDocumentBackgroundColor()
+   */
+  void SetDocumentBackgroundColor(Dali::Vector4 color);
+
+  /**
+   * @copydoc Dali::WebEngine::ClearTilesWhenHidden()
+   */
+  void ClearTilesWhenHidden(bool cleared);
+
+  /**
+   * @copydoc Dali::WebEngine::SetTileCoverAreaMultiplier()
+   */
+  void SetTileCoverAreaMultiplier(float multiplier);
+
+  /**
+   * @copydoc Dali::WebEngine::EnableCursorByClient()
+   */
+  void EnableCursorByClient(bool enabled);
+
+  /**
+   * @copydoc Dali::WebEngine::GetSelectedText()
+   */
+  std::string GetSelectedText() const;
 
   /**
    * @copydoc Dali::WebEngine::SendTouchEvent()
    */
-  bool SendTouchEvent( const Dali::TouchEvent& touch );
+  bool SendTouchEvent(const Dali::TouchEvent& touch);
 
   /**
    * @copydoc Dali::WebEngine::SendKeyEvent()
    */
-  bool SendKeyEvent( const Dali::KeyEvent& event );
+  bool SendKeyEvent(const Dali::KeyEvent& event);
 
   /**
    * @copydoc Dali::WebEngine::SetFocus()
    */
-  void SetFocus( bool focused );
+  void SetFocus(bool focused);
+
+  /**
+   * @copydoc Dali::WebEngine::SetPageZoomFactor()
+   */
+  void SetPageZoomFactor(float zoomFactor);
+
+  /**
+   * @copydoc Dali::WebEngine::GetPageZoomFactor()
+   */
+  float GetPageZoomFactor() const;
+
+  /**
+   * @copydoc Dali::WebEngine::SetTextZoomFactor()
+   */
+  void SetTextZoomFactor(float zoomFactor);
+
+  /**
+   * @copydoc Dali::WebEngine::GetTextZoomFactor()
+   */
+  float GetTextZoomFactor() const;
+
+  /**
+   * @copydoc Dali::WebEngine::GetLoadProgressPercentage()
+   */
+  float GetLoadProgressPercentage() const;
+
+  /**
+   * @copydoc Dali::WebEngine::SetScaleFactor()
+   */
+  void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
+
+  /**
+   * @copydoc Dali::WebEngine::GetScaleFactor()
+   */
+  float GetScaleFactor() const;
+
+  /**
+   * @copydoc Dali::WebEngine::ActivateAccessibility()
+   */
+  void ActivateAccessibility(bool activated);
+
+  /**
+   * @copydoc Dali::WebEngine::SetVisibility()
+   */
+  bool SetVisibility(bool visible);
+
+  /**
+   * @copydoc Dali::WebEngine::HighlightText()
+   */
+  bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
+
+  /**
+   * @copydoc Dali::WebEngine::AddDynamicCertificatePath()
+   */
+  void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
+
+  /**
+   * @copydoc Dali::WebEngine::GetScreenshot()
+   */
+  Dali::PixelData GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor);
+
+  /**
+   * @copydoc Dali::WebEngine::GetScreenshotAsync()
+   */
+  bool GetScreenshotAsynchronously(Dali::Rect<int> 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<int> 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::PageLoadStartedSignal()
@@ -244,6 +450,11 @@ public:
   Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
 
   /**
+   * @copydoc Dali::WebEngine::PageLoadProgressSignal()
+   */
+  Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadInProgressSignal();
+
+  /**
    * @copydoc Dali::WebEngine::PageLoadFinishedSignal()
    */
   Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
@@ -258,9 +469,53 @@ public:
    */
   Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
 
-private:
+  /**
+   * @copydoc Dali::WebEngine::UrlChangedSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& UrlChangedSignal();
+
+  /**
+   * @copydoc Dali::WebEngine::FormRepostDecisionSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineFormRepostDecisionSignalType& FormRepostDecisionSignal();
 
   /**
+   * @copydoc Dali::WebEngine::FrameRenderedSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& FrameRenderedSignal();
+
+  /**
+   * @copydoc Dali::WebEngine::RequestInterceptorSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineRequestInterceptorSignalType& RequestInterceptorSignal();
+
+  /**
+   @copydoc Dali::WebEngine::ConsoleMessageSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineConsoleMessageSignalType& ConsoleMessageSignal();
+
+  /**
+   @copydoc Dali::WebEngine::PolicyDecisionSignal()
+   */
+  Dali::WebEnginePlugin::WebEnginePolicyDecisionSignalType& PolicyDecisionSignal();
+
+  /**
+   * @copydoc Dali::WebEngine::CertificateConfirmSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineCertificateSignalType& CertificateConfirmSignal();
+
+  /**
+   * @copydoc Dali::WebEngine::SslCertificateChangedSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineCertificateSignalType& SslCertificateChangedSignal();
+
+  /**
+   * @copydoc Dali::WebEngine::HttpAuthHandlerSignal()
+   */
+  Dali::WebEnginePlugin::WebEngineHttpAuthHandlerSignalType& HttpAuthHandlerSignal();
+
+private:
+  /**
    * @brief Constructor.
    */
   WebEngine();
@@ -271,10 +526,10 @@ private:
   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.
@@ -291,38 +546,36 @@ private:
   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
-