Update position & size of web engine.
[platform/core/uifw/dali-adaptor.git] / dali / devel-api / adaptor-framework / web-engine.h
old mode 100644 (file)
new mode 100755 (executable)
index f3622ab..102ea8c
@@ -97,6 +97,16 @@ public:
   void Create(int width, int height, const std::string& locale, const std::string& timezoneId);
 
   /**
+   * @brief Creates WebEngine instance.
+   *
+   * @param [in] width The width of Web
+   * @param [in] height The height of Web
+   * @param [in] argc The count of application arguments
+   * @param [in] argv The string array of application arguments
+   */
+  void Create( int width, int height, int argc, char** argv );
+
+  /**
    * @brief Destroys WebEngine instance.
    */
   void Destroy();
@@ -107,6 +117,26 @@ public:
   NativeImageInterfacePtr GetNativeImageSource();
 
   /**
+   * @brief Get settings of WebEngine.
+   */
+  Dali::WebEngineSettings& GetSettings() const;
+
+  /**
+   * @brief Get context of WebEngine.
+   */
+  Dali::WebEngineContext& GetContext() const;
+
+  /**
+   * @brief Get cookie manager of WebEngine.
+   */
+  Dali::WebEngineCookieManager& GetCookieManager() const;
+
+  /**
+   * @brief Get back-forward list of WebEngine.
+   */
+  Dali::WebEngineBackForwardList& GetBackForwardList() const;
+
+  /**
    * @brief Loads a web page based on a given URL.
    *
    * @param [in] url The URL of the resource to load
@@ -114,6 +144,20 @@ public:
   void LoadUrl(const std::string& url);
 
   /**
+   * @brief Returns the title of the Web.
+   *
+   * @return The title of web page
+   */
+  std::string GetTitle() const;
+
+  /**
+   * @brief Returns the Favicon of the Web.
+   *
+   * @return FavIcon of Dali::PixelData& type
+   */
+  Dali::PixelData GetFavicon() const;
+
+  /**
    * @brief Gets the url.
    */
   const std::string& GetUrl();
@@ -123,7 +167,7 @@ public:
    *
    * @param [in] htmlString The string to use as the contents of the web page
    */
-  void LoadHTMLString(const std::string& htmlString);
+  void LoadHtmlString(const std::string& htmlString);
 
   /**
    * @brief Reloads the Web.
@@ -146,6 +190,31 @@ public:
   void Resume();
 
   /**
+   * @brief Scrolls the webpage of view by deltaX and deltaY.
+   */
+  void ScrollBy( int deltaX, int deltaY );
+
+  /**
+   * @brief Sets an absolute scroll of the given view.
+   */
+  void SetScrollPosition( int x, int y );
+
+  /**
+   * @brief Gets the current scroll position of the given view.
+   */
+  Dali::Vector2 GetScrollPosition() const;
+
+  /**
+   * @brief Gets the possible scroll size of the given view.
+   */
+  Dali::Vector2 GetScrollSize() const;
+
+  /**
+   * @brief Gets the last known content's size.
+   */
+  Dali::Vector2 GetContentSize() const;
+
+  /**
    * @brief Returns whether forward is possible.
    *
    * @return True if forward is possible, false otherwise
@@ -186,47 +255,14 @@ public:
   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
 
   /**
-   * @brief Clears the history of Web.
-   */
-  void ClearHistory();
-
-  /**
-   * @brief Clears the cache of Web.
-   */
-  void ClearCache();
-
-  /**
-   * @brief Clears all the cookies of Web.
-   */
-  void ClearCookies();
-
-  /**
-   * @brief Get cache model option. The default is DOCUMENT_VIEWER.
-   *
-   * @return The cache model option
-   */
-  Dali::WebEnginePlugin::CacheModel GetCacheModel() const;
-
-  /**
-   * @brief Set cache model option. The default is DOCUMENT_VIEWER.
-   *
-   * @param[in] cacheModel The cache model option
-   */
-  void SetCacheModel(Dali::WebEnginePlugin::CacheModel cacheModel);
-
-  /**
-   * @brief Gets the cookie acceptance policy. The default is NO_THIRD_PARTY.
-   *
-   * @return The cookie acceptance policy
+   * @brief Clears all tiles resources of Web.
    */
-  Dali::WebEnginePlugin::CookieAcceptPolicy GetCookieAcceptPolicy() const;
+  void ClearAllTilesResources();
 
   /**
-   * @brief Sets the cookie acceptance policy. The default is NO_THIRD_PARTY.
-   *
-   * @param[in] policy The cookie acceptance policy
+   * @brief Clears the history of Web.
    */
-  void SetCookieAcceptPolicy(Dali::WebEnginePlugin::CookieAcceptPolicy policy);
+  void ClearHistory();
 
   /**
    * @brief Get user agent string.
@@ -243,62 +279,6 @@ public:
   void SetUserAgent(const std::string& userAgent);
 
   /**
-   * @brief Returns whether JavaScript can be executable. The default is true.
-   *
-   * @return true if JavaScript executing is enabled, false otherwise
-   */
-  bool IsJavaScriptEnabled() const;
-
-  /**
-   * @brief Enables/disables JavaScript executing. The default is enabled.
-   *
-   * @param[in] enabled True if JavaScript executing is enabled, false otherwise
-   */
-  void EnableJavaScript(bool enabled);
-
-  /**
-   * @brief Returns whether JavaScript can be executable. The default is true.
-   *
-   * @return true if images are loaded automatically, false otherwise
-   */
-  bool AreImagesAutomaticallyLoaded() const;
-
-  /**
-   * @brief Enables/disables auto loading of images. The default is enabled.
-   *
-   * @param[in] automatic True if images are loaded automatically, false otherwise
-   */
-  void LoadImagesAutomatically(bool automatic);
-
-  /**
-   * @brief Gets the default text encoding name.
-   *
-   * @return The default text encoding name
-   */
-  const std::string& GetDefaultTextEncodingName() const;
-
-  /**
-   * @brief Sets the default text encoding name.
-   *
-   * @param[in] defaultTextEncodingName The default text encoding name
-   */
-  void SetDefaultTextEncodingName(const std::string& defaultTextEncodingName);
-
-  /**
-   * @brief Returns the default font size in pixel. The default value is 16.
-   *
-   * @return The default font size
-   */
-  int GetDefaultFontSize() const;
-
-  /**
-   * @brief Sets the default font size in pixel. The default value is 16.
-   *
-   * @param[in] defaultFontSize A new default font size to set
-   */
-  void SetDefaultFontSize(int defaultFontSize);
-
-  /**
    * @brief Sets the size of Web Pages.
    */
   void SetSize(int width, int height);
@@ -315,10 +295,23 @@ public:
 
   /**
    * @brief Set focus.
+   * @param[in] focused True if web view is focused, false otherwise
    */
   void SetFocus( bool focused );
 
   /**
+   * @brief Update display area.
+   * @param[in] displayArea The area to display web page.
+   */
+  void UpdateDisplayArea( Dali::Rect< int > displayArea );
+
+  /**
+   * @brief Enable video hole.
+   * @param[in] enabled True if video hole is enabled, false otherwise
+   */
+  void EnableVideoHole( bool enabled );
+
+  /**
    * @brief Connects to this signal to be notified when page loading is started.
    *
    * @return A signal object to connect with.
@@ -339,6 +332,13 @@ public:
    */
   Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
 
+  /**
+   * @brief Connects to this signal to be notified when scroll edge is reached.
+   *
+   * @return A signal object to connect with.
+   */
+  Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
+
 private: // Not intended for application developers
   /**
    * @brief Internal constructor