namespace Dali
{
-
namespace Internal
{
-
namespace Adaptor
{
- class WebEngine;
+class WebEngine;
} // namespace Adaptor
} // namespace Internal
class DALI_ADAPTOR_API WebEngine : public BaseHandle
{
public:
-
/**
* @brief Constructor.
*/
*
* @param[in] WebEngine WebEngine to copy. The copied WebEngine will point at the same implementation
*/
- WebEngine( const WebEngine& WebEngine );
+ WebEngine(const WebEngine& WebEngine);
/**
* @brief Assignment operator.
* @param[in] WebEngine The WebEngine to assign from.
* @return The updated WebEngine.
*/
- WebEngine& operator=( const WebEngine& WebEngine );
+ WebEngine& operator=(const WebEngine& WebEngine);
/**
* @brief Downcast a handle to WebEngine handle.
* @param[in] handle Handle to an object
* @return Handle to a WebEngine or an uninitialized handle
*/
- static WebEngine DownCast( BaseHandle handle );
+ static WebEngine DownCast(BaseHandle handle);
/**
* @brief Creates WebEngine instance.
* @param [in] locale The locale of Web
* @param [in] timezoneId The timezoneID of Web
*/
- 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);
+
+ /**
+ * @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.
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
*/
- void LoadUrl( const std::string& url );
+ 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.
*
* @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.
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
* @param[in] script The JavaScript code
* @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
*/
- 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);
/**
* @brief Add a message handler into JavaScript.
* @param[in] exposedObjectName The name of exposed object
* @param[in] handler The callback function
*/
- 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);
/**
- * @brief Clears the history of Web.
+ * @brief Clears all tiles resources of Web.
*/
- void ClearHistory();
-
- /**
- * @brief Clears the cache of Web.
- */
- void ClearCache();
+ void ClearAllTilesResources();
/**
- * @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
- */
- Dali::WebEnginePlugin::CookieAcceptPolicy GetCookieAcceptPolicy() const;
-
- /**
- * @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.
*
* @param[in] userAgent The string value of user agent
*/
- 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;
+ void SetUserAgent(const std::string& userAgent);
/**
- * @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
+ * @brief Sets the size of Web Pages.
*/
- void SetDefaultTextEncodingName( const std::string& defaultTextEncodingName );
+ void SetSize(int width, int height);
/**
- * @brief Returns the default font size in pixel. The default value is 16.
- *
- * @return The default font size
+ * @brief Sends Touch Events.
*/
- int GetDefaultFontSize() const;
+ bool SendTouchEvent(const TouchEvent& touch);
/**
- * @brief Sets the default font size in pixel. The default value is 16.
- *
- * @param[in] defaultFontSize A new default font size to set
+ * @brief Sends key Events.
*/
- void SetDefaultFontSize( int defaultFontSize );
+ bool SendKeyEvent(const KeyEvent& event);
/**
- * @brief Sets the size of Web Pages.
+ * @brief Set focus.
+ * @param[in] focused True if web view is focused, false otherwise
*/
- void SetSize( int width, int height );
+ void SetFocus( bool focused );
/**
- * @brief Sends Touch Events.
+ * @brief Update display area.
+ * @param[in] displayArea The area to display web page.
*/
- bool SendTouchEvent( const TouchEvent& touch );
+ void UpdateDisplayArea( Dali::Rect< int > displayArea );
/**
- * @brief Sends key Events.
+ * @brief Enable video hole.
+ * @param[in] enabled True if video hole is enabled, false otherwise
*/
- bool SendKeyEvent( const KeyEvent& event );
+ void EnableVideoHole( bool enabled );
/**
* @brief Connects to this signal to be notified when page loading is started.
*/
Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
-private: // Not intended for application developers
+ /**
+ * @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
*/
- explicit DALI_INTERNAL WebEngine( Internal::Adaptor::WebEngine* internal );
+ explicit DALI_INTERNAL WebEngine(Internal::Adaptor::WebEngine* internal);
};
-} // namespace Dali;
+} // namespace Dali
#endif // DALI_WEB_ENGINE_H