Updates following web-engine devel header location change
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / devel-api / controls / web-view / web-context.h
index 531ec00..ebdbae0 100755 (executable)
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_WEB_CONTEXT_H
 
 /*
- * Copyright (c) 2021 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2022 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.
@@ -19,7 +19,7 @@
  */
 
 // EXTERNAL INCLUDES
-#include <dali/devel-api/adaptor-framework/web-engine-context.h>
+#include <dali/devel-api/adaptor-framework/web-engine/web-engine-context.h>
 #include <string>
 
 // INTERNAL INCLUDES
@@ -79,6 +79,28 @@ public:
   void SetProxyUri(const std::string& uri);
 
   /**
+   * @brief Get the proxy URI from the network backend of specific context.
+   *
+   * @return current proxy URI or null string if it's not set
+   */
+  std::string GetProxyUri() const;
+
+  /**
+   * @brief Set the given proxy to network backend of specific context.
+   *
+   * @param[in] proxy URI to set
+   * @param[in] bypass rule to set
+   */
+  void SetProxyBypassRule(const std::string& proxy, const std::string& bypass);
+
+  /**
+   * @brief Get the proxy bypass rule from the network backend of specific context.
+   *
+   * @return current proxy bypass rule or null string if it's not set
+   */
+  std::string GetProxyBypassRule() const;
+
+  /**
    * @brief Add CA certificates to persistent NSS certificate database
    *
    * Function accepts a path to a CA certificate file, a path to a directory
@@ -91,6 +113,15 @@ public:
   void SetCertificateFilePath(const std::string& certificatePath);
 
   /**
+   * @brief Get CA certifcate file path
+   *
+   * It returns an internal string and should not be modified.
+   *
+   * @return certificate_file path which is set during ewk_context_certificate_file_set or null string otherwise
+   */
+  std::string GetCertificateFilePath() const;
+
+  /**
    * @brief Set a proxy auth credential to network backend of specific context.
    *
    * @param[in] username username to set
@@ -198,6 +229,13 @@ public:
   void RegisterMimeOverriddenCallback(Dali::WebEngineContext::WebEngineMimeOverriddenCallback callback);
 
   /**
+   * @brief Callback to be called when http request need be intercepted.
+   *
+   * @param[in] callback
+   */
+  void RegisterRequestInterceptedCallback(Dali::WebEngineContext::WebEngineRequestInterceptedCallback callback);
+
+  /**
    * @brief Toggle the cache to be enabled or disabled
    *
    * @param[in] cacheEnabled enable or disable cache
@@ -207,34 +245,25 @@ public:
   /**
    * @brief Query if the cache is enabled
    *
-   * @return @c true is cache is enabled or @c false otherwise
+   * @return true is cache is enabled or false otherwise
    */
   bool IsCacheEnabled() const;
 
   /**
-   * @brief Get CA certifcate file path
-   *
-   * It returns an internal string and should not be modified.
-   *
-   * @return @c certificate_file is path which is set during ewk_context_certificate_file_set or @c null string otherwise
-   */
-  std::string GetContextCertificateFile() const;
-
-  /**
-   * @brief Set application id for @a context.
+   * @brief Set application id for context.
    *
-   * @param[in] appID application id
+   * @param[in] appId application id
    */
-  void SetContextAppId(const std::string& appID);
+  void SetAppId(const std::string& appId);
 
   /**
-   * @brief Set application version for @a context.
+   * @brief Set application version for context.
    *
    * @param[in] appVersion application version
    *
-   * @return @c true if successful, @c false otherwise
+   * @return true if successful, false otherwise
    */
-  bool SetContextAppVersion(const std::string& appVersion);
+  bool SetAppVersion(const std::string& appVersion);
 
   /**
    * @brief To declare application type
@@ -242,14 +271,14 @@ public:
    * @param[in] applicationType The Application_Type enum
    *
    */
-  void SetContextApplicationType(const Dali::WebEngineContext::ApplicationType applicationType);
+  void SetApplicationType(const Dali::WebEngineContext::ApplicationType applicationType);
 
   /**
    * @brief Set time offset
    *
    * @param[in] timeOffset The value will be added to system time as offset
    */
-  void SetContextTimeOffset(float timeOffset);
+  void SetTimeOffset(float timeOffset);
 
   /**
    * @brief Set timezone offset
@@ -257,39 +286,39 @@ public:
    * @param[in] timeZoneOffset offset for time zone.
    * @param[in] daylightSavingTime The value is for daylight saving time use.
    */
-  void SetContextTimeZoneOffset(float timeZoneOffset, float daylightSavingTime);
+  void SetTimeZoneOffset(float timeZoneOffset, float daylightSavingTime);
 
   /**
-   * @brief Register url schemes as CORS enabled
-   *
-   * @param[in] schemes The URL schemes list which will be added to web security policy
+   * @brief Set default zoom factor
    *
+   * @param[in] zoomFactor default zoom factor
    */
-  void RegisterUrlSchemesAsCorsEnabled(const std::vector<std::string>& schemes);
+  void SetDefaultZoomFactor(float zoomFactor);
 
   /**
-   * @brief Register JS plugin mime types.
+   * @brief Get default zoom factor
    *
-   * @param[in] mimeTypes The MIME types will be checked by the renderer frame loader
-   * to skip creating default frame for the object tags with the registered MIME type.
+   * Gets default zoom factor for all pages opened with this context.
+   *
+   * @return default zoom factor or negative value on error
    */
-  void RegisterJsPluginMimeTypes(const std::vector<std::string>& mimeTypes);
+  float GetDefaultZoomFactor() const;
 
   /**
-   * @brief Set default zoom factor
+   * @brief Register url schemes as CORS enabled
+   *
+   * @param[in] schemes The URL schemes list which will be added to web security policy
    *
-   * @param[in] zoomFactor default zoom factor
    */
-  void SetDefaultZoomFactor(float zoomFactor);
+  void RegisterUrlSchemesAsCorsEnabled(const std::vector<std::string>& schemes);
 
   /**
-   * @brief Get default zoom factor
-   *
-   * Gets default zoom factor for all pages opened with this context.
+   * @brief Register JS plugin mime types.
    *
-   * @return @c default zoom factor or negative value on error
+   * @param[in] mimeTypes The MIME types will be checked by the renderer frame loader
+   * to skip creating default frame for the object tags with the registered MIME type.
    */
-  float GetContextDefaultZoomFactor() const;
+  void RegisterJsPluginMimeTypes(const std::vector<std::string>& mimeTypes);
 
   /**
    * @brief Request for deleting all web application caches.
@@ -323,28 +352,6 @@ public:
   void DeleteAllFormCandidateData();
 
   /**
-   * @brief Get the proxy URI from the network backend of specific context.
-   *
-   * @return current proxy URI or @c null string if it's not set
-   */
-  std::string GetContextProxy() const;
-
-  /**
-   * @brief Set the given proxy to network backend of specific context.
-   *
-   * @param[in] proxy URI to set
-   * @param[in] bypass rule to set
-   */
-  void SetContextProxy(const std::string& proxy, const std::string& bypass);
-
-  /**
-   * @brief Get the proxy bypass rule from the network backend of specific context.
-   *
-   * @return current proxy bypass rule or @c null string if it's not set
-   */
-  std::string GetProxyBypassRule() const;
-
-  /**
    * @brief Notify low memory to free unused memory.
    *
    * @return @c true on success or @c false otherwise.