Implement some new ewk apis in web engine.
[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / web-engine-plugin.h
index c3b9389..fbf8d1c 100755 (executable)
@@ -27,6 +27,10 @@ namespace Dali
 {
 class KeyEvent;
 class TouchEvent;
+class WebEngineBackForwardList;
+class WebEngineContext;
+class WebEngineCookieManager;
+class WebEngineSettings;
 
 /**
  * @brief WebEnginePlugin is an abstract interface, used by dali-adaptor to access WebEngine plugin.
@@ -54,48 +58,6 @@ public:
   typedef Signal< void( const ScrollEdge )> WebEngineScrollEdgeReachedSignalType;
 
   /**
-   * @brief Enumeration for cache model options.
-   */
-  enum class CacheModel
-  {
-    /**
-     * @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 Enumeration for the cookies accept policies.
-   */
-  enum class CookieAcceptPolicy
-  {
-    /**
-     * @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 scroll edge.
    */
   enum class ScrollEdge
@@ -132,6 +94,26 @@ public:
   virtual void Destroy() = 0;
 
   /**
+   * @brief Get settings of WebEngine.
+   */
+  virtual WebEngineSettings& GetSettings() const = 0;
+
+  /**
+   * @brief Get context of WebEngine.
+   */
+  virtual WebEngineContext& GetContext() const = 0;
+
+  /**
+   * @brief Get cookie manager of WebEngine.
+   */
+  virtual WebEngineCookieManager& GetCookieManager() const = 0;
+
+  /**
+   * @brief Get back-forward list of WebEngine.
+   */
+  virtual WebEngineBackForwardList& GetBackForwardList() const = 0;
+
+  /**
    * @brief Loads a web page based on a given URL.
    *
    * @param [in] url The URL of the resource to load
@@ -155,7 +137,7 @@ public:
    *
    * @param [in] htmlString The string to use as the contents of the web page
    */
-  virtual void LoadHTMLString(const std::string& htmlString) = 0;
+  virtual void LoadHtmlString(const std::string& htmlString) = 0;
 
   /**
    * @brief Reloads the Web.
@@ -248,44 +230,6 @@ public:
   virtual void ClearHistory() = 0;
 
   /**
-   * @brief Clears the cache of Web.
-   */
-  virtual void ClearCache() = 0;
-
-  /**
-   * @brief Clears all the cookies of Web.
-   */
-  virtual void ClearCookies() = 0;
-
-  /**
-   * @brief Get cache model option. The default is DOCUMENT_VIEWER.
-   *
-   * @return The cache model option
-   */
-  virtual CacheModel GetCacheModel() const = 0;
-
-  /**
-   * @brief Set cache model option. The default is DOCUMENT_VIEWER.
-   *
-   * @param[in] cacheModel The cache model option
-   */
-  virtual void SetCacheModel(CacheModel cacheModel) = 0;
-
-  /**
-   * @brief Gets the cookie acceptance policy. The default is NO_THIRD_PARTY.
-   *
-   * @return The cookie acceptance policy
-   */
-  virtual CookieAcceptPolicy GetCookieAcceptPolicy() const = 0;
-
-  /**
-   * @brief Sets the cookie acceptance policy. The default is NO_THIRD_PARTY.
-   *
-   * @param[in] policy The cookie acceptance policy
-   */
-  virtual void SetCookieAcceptPolicy(CookieAcceptPolicy policy) = 0;
-
-  /**
    * @brief Get user agent string.
    *
    * @return The string value of user agent
@@ -300,62 +244,6 @@ public:
   virtual void SetUserAgent(const std::string& userAgent) = 0;
 
   /**
-   * @brief Returns whether JavaScript can be executable. The default is true.
-   *
-   * @return true if JavaScript executing is enabled, false otherwise
-   */
-  virtual bool IsJavaScriptEnabled() const = 0;
-
-  /**
-   * @brief Enables/disables JavaScript executing. The default is enabled.
-   *
-   * @param[in] enabled True if JavaScript executing is enabled, false otherwise
-   */
-  virtual void EnableJavaScript(bool enabled) = 0;
-
-  /**
-   * @brief Returns whether images can be loaded automatically. The default is true.
-   *
-   * @return true if images are loaded automatically, false otherwise
-   */
-  virtual bool AreImagesAutomaticallyLoaded() const = 0;
-
-  /**
-   * @brief Enables/disables auto loading of images. The default is enabled.
-   *
-   * @param[in] automatic True if images are loaded automatically, false otherwise
-   */
-  virtual void LoadImagesAutomatically(bool automatic) = 0;
-
-  /**
-   * @brief Gets the default text encoding name (e.g. UTF-8).
-   *
-   * @return The default text encoding name
-   */
-  virtual const std::string& GetDefaultTextEncodingName() const = 0;
-
-  /**
-   * @brief Sets the default text encoding name (e.g. UTF-8).
-   *
-   * @param[in] defaultTextEncodingName The default text encoding name
-   */
-  virtual void SetDefaultTextEncodingName(const std::string& defaultTextEncodingName) = 0;
-
-  /**
-   * @brief Returns the default font size in pixel. The default value is 16.
-   *
-   * @return The default font size
-   */
-  virtual int GetDefaultFontSize() const = 0;
-
-  /**
-   * @brief Sets the default font size in pixel. The default value is 16.
-   *
-   * @param[in] defaultFontSize A new default font size to set
-   */
-  virtual void SetDefaultFontSize(int defaultFontSize) = 0;
-
-  /**
    * @brief Sets size of Web Page.
    */
   virtual void SetSize(int width, int height) = 0;