X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;ds=sidebyside;f=dali%2Fdevel-api%2Fadaptor-framework%2Fweb-engine.h;h=d68920eec3bc09fd2aeacf4ad53083dd4a5616cb;hb=1ac1dea2dc467462550532ce587aadbd217ca556;hp=1684f02f95d805e0afcb08d05a073b616842fc51;hpb=d98dec8658c95e42988d397b6a3fb252bdd20e9b;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git diff --git a/dali/devel-api/adaptor-framework/web-engine.h b/dali/devel-api/adaptor-framework/web-engine.h index 1684f02..d68920e 100755 --- a/dali/devel-api/adaptor-framework/web-engine.h +++ b/dali/devel-api/adaptor-framework/web-engine.h @@ -56,7 +56,7 @@ public: ~WebEngine(); /** - * @brief Creates a new instance of a WebEngine. + * @brief Create a new instance of a WebEngine. */ static WebEngine New(); @@ -87,34 +87,34 @@ public: static WebEngine DownCast(BaseHandle handle); /** - * @brief Creates WebEngine instance. + * @brief Create WebEngine instance. * * @param [in] width The width of Web * @param [in] height The height of Web * @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(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId); /** - * @brief Creates WebEngine instance. + * @brief Create 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); + void Create(uint32_t width, uint32_t height, uint32_t argc, char** argv); /** - * @brief Destroys WebEngine instance. + * @brief Destroy WebEngine instance. */ void Destroy(); /** - * @brief Gets native image source to render. + * @brief Get native image source to render. */ - NativeImageInterfacePtr GetNativeImageSource(); + NativeImageSourcePtr GetNativeImageSource(); /** * @brief Get settings of WebEngine. @@ -137,33 +137,33 @@ public: Dali::WebEngineBackForwardList& GetBackForwardList() const; /** - * @brief Loads a web page based on a given URL. + * @brief Load a web page based on a given URL. * * @param [in] url The URL of the resource to load */ void LoadUrl(const std::string& url); /** - * @brief Returns the title of the Web. + * @brief Return the title of the Web. * * @return The title of web page */ std::string GetTitle() const; /** - * @brief Returns the Favicon of the Web. + * @brief Return the Favicon of the Web. * * @return FavIcon of Dali::PixelData& type */ Dali::PixelData GetFavicon() const; /** - * @brief Gets the url. + * @brief Get the url. */ - const std::string& GetUrl(); + std::string GetUrl() const; /** - * @brief Loads a given string as web contents. + * @brief Load a given string as web contents. * * @param [in] htmlString The string to use as the contents of the web page */ @@ -181,7 +181,7 @@ public: bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl); /** - * @brief Requests loading the given contents by MIME type into the view object + * @brief Request loading the given contents by MIME type into the view object * * @param[in] contents The content to load * @param[in] contentSize The size of contents (in bytes) @@ -194,27 +194,27 @@ public: bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri); /** - * @brief Reloads the Web. + * @brief Reload the Web. */ void Reload(); /** - * @brief Reloads the current page's document without cache + * @brief Reload the current page's document without cache */ bool ReloadWithoutCache(); /** - * @brief Stops loading web contents on the current page. + * @brief Stop loading web contents on the current page. */ void StopLoading(); /** - * @brief Suspends the operation associated with the view. + * @brief Suspend the operation associated with the view. */ void Suspend(); /** - * @brief Resumes the operation associated with the view object after calling Suspend(). + * @brief Resume the operation associated with the view object after calling Suspend(). */ void Resume(); @@ -264,74 +264,74 @@ public: bool StopInspectorServer(); /** - * @brief Scrolls web page of view by deltaX and deltaY. + * @brief Scroll web page of view by deltaX and deltaY. * * @param[in] deltaX horizontal offset to scroll * @param[in] deltaY vertical offset to scroll */ - void ScrollBy(int deltaX, int deltaY); + void ScrollBy(int32_t deltaX, int32_t deltaY); /** - * @brief Scrolls edge of view by deltaX and deltaY. + * @brief Scroll edge of view by deltaX and deltaY. * * @param[in] deltaX horizontal offset to scroll * @param[in] deltaY vertical offset to scroll * * @return true if succeeded, false otherwise */ - bool ScrollEdgeBy(int deltaX, int deltaY); + bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY); /** - * @brief Sets an absolute scroll of the given view. + * @brief Set an absolute scroll of the given view. */ - void SetScrollPosition(int x, int y); + void SetScrollPosition(int32_t x, int32_t y); /** - * @brief Gets the current scroll position of the given view. + * @brief Get the current scroll position of the given view. */ Dali::Vector2 GetScrollPosition() const; /** - * @brief Gets the possible scroll size of the given view. + * @brief Get the possible scroll size of the given view. */ Dali::Vector2 GetScrollSize() const; /** - * @brief Gets the last known content's size. + * @brief Get the last known content's size. */ Dali::Vector2 GetContentSize() const; /** - * @brief Returns whether forward is possible. + * @brief Return whether forward is possible. * * @return True if forward is possible, false otherwise */ bool CanGoForward(); /** - * @brief Goes to forward. + * @brief Go to forward. */ void GoForward(); /** - * @brief Returns whether backward is possible. + * @brief Return whether backward is possible. * * @return True if backward is possible, false otherwise */ bool CanGoBack(); /** - * @brief Goes to back. + * @brief Go to back. */ void GoBack(); /** - * @brief Evaluates JavaScript code represented as a string. + * @brief Evaluate JavaScript code represented as a string. * * @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 resultHandler); + void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler); /** * @brief Add a message handler into JavaScript. @@ -339,7 +339,7 @@ public: * @param[in] exposedObjectName The name of exposed object * @param[in] handler The callback function */ - void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function handler); + void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler); /** * @brief Register a callback for JavaScript alert. @@ -380,12 +380,35 @@ public: void JavaScriptPromptReply(const std::string& result); /** - * @brief Clears the history of Web. + * @brief Create a new hit test. + * + * @param[in] x the horizontal position to query + * @param[in] y the vertical position to query + * @param[in] mode the mode of hit test + * + * @return a new hit test object + */ + std::unique_ptr CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode); + + /** + * @brief create a hit test asynchronously. + * + * @param[in] x the horizontal position to query + * @param[in] y the vertical position to query + * @param[in] mode the mode of hit test + * @param[in] callback the callback function + * + * @return true if succeeded, false otherwise + */ + bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback); + + /** + * @brief Clear the history of Web. */ void ClearHistory(); /** - * @brief Clears all tiles resources of Web. + * @brief Clear all tiles resources of Web. */ void ClearAllTilesResources(); @@ -394,7 +417,7 @@ public: * * @return The string value of user agent */ - const std::string& GetUserAgent() const; + std::string GetUserAgent() const; /** * @brief Set user agent string. @@ -404,52 +427,52 @@ public: void SetUserAgent(const std::string& userAgent); /** - * @brief Sets the size of Web Pages. + * @brief Set the size of Web Pages. */ - void SetSize(int width, int height); + void SetSize(uint32_t width, uint32_t height); /** - * @brief Sets background color of web page. + * @brief Set background color of web page. * * @param[in] color Background color */ void SetDocumentBackgroundColor(Dali::Vector4 color); /** - * @brief Clears tiles when hidden. + * @brief Clear tiles when hidden. * * @param[in] cleared Whether tiles are cleared or not */ void ClearTilesWhenHidden(bool cleared); /** - * @brief Sets multiplier of cover area of tile. + * @brief Set multiplier of cover area of tile. * * @param[in] multiplier The multiplier of cover area */ void SetTileCoverAreaMultiplier(float multiplier); /** - * @brief Enables cursor by client. + * @brief Enable cursor by client. * * @param[in] enabled Whether cursor is enabled or not */ void EnableCursorByClient(bool enabled); /** - * @brief Gets the selected text. + * @brief Get the selected text. * * @return the selected text */ std::string GetSelectedText() const; /** - * @brief Sends Touch Events. + * @brief Send Touch Events. */ bool SendTouchEvent(const TouchEvent& touch); /** - * @brief Sends key Events. + * @brief Send key Events. */ bool SendKeyEvent(const KeyEvent& event); @@ -460,58 +483,58 @@ public: void SetFocus(bool focused); /** - * @brief Enables/disables mouse events. The default is enabled. + * @brief Enable/disable mouse events. The default is enabled. * * @param[in] enabled True if mouse events are enabled, false otherwise */ - void EnableMouseEvents( bool enabled ); + void EnableMouseEvents(bool enabled); /** - * @brief Enables/disables key events. The default is enabled. + * @brief Enable/disable key events. The default is enabled. * * @param[in] enabled True if key events are enabled, false otherwise */ - void EnableKeyEvents( bool enabled ); + void EnableKeyEvents(bool enabled); /** - * @brief Sets zoom factor of the current page. + * @brief Set zoom factor of the current page. * @param[in] zoomFactor a new factor to be set. */ void SetPageZoomFactor(float zoomFactor); /** - * @brief Queries the current zoom factor of the page。 + * @brief Query the current zoom factor of the page。 * @return The current page zoom factor. */ float GetPageZoomFactor() const; /** - * @brief Sets the current text zoom level。. + * @brief Set the current text zoom level。. * @param[in] zoomFactor a new factor to be set. */ void SetTextZoomFactor(float zoomFactor); /** - * @brief Gets the current text zoom level. + * @brief Get the current text zoom level. * @return The current text zoom factor. */ float GetTextZoomFactor() const; /** - * @brief Gets the current load progress of the page. + * @brief Get the current load progress of the page. * @return The load progress of the page. */ float GetLoadProgressPercentage() const; /** - * @brief Scales the current page, centered at the given point. + * @brief Scale the current page, centered at the given point. * @param[in] scaleFactor a new factor to be scaled. * @param[in] point a center coordinate. */ void SetScaleFactor(float scaleFactor, Dali::Vector2 point); /** - * @brief Gets the current scale factor of the page. + * @brief Get the current scale factor of the page. * @return The current scale factor. */ float GetScaleFactor() const; @@ -531,7 +554,7 @@ public: bool SetVisibility(bool visible); /** - * @brief Searches and highlights the given string in the document. + * @brief Search and highlights the given string in the document. * @param[in] text The text to find * @param[in] options The options to find * @param[in] maxMatchCount The maximum match count to find @@ -555,7 +578,7 @@ public: * * @return pixel data of screen shot */ - Dali::PixelData GetScreenshot(Dali::Rect viewArea, float scaleFactor); + Dali::PixelData GetScreenshot(Dali::Rect viewArea, float scaleFactor); /** * @brief Request to get snapshot of the specified viewArea of page asynchronously. @@ -566,7 +589,7 @@ public: * * @return true if requested successfully, false otherwise */ - bool GetScreenshotAsynchronously(Dali::Rect viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback); + bool GetScreenshotAsynchronously(Dali::Rect viewArea, float scaleFactor, Dali::WebEnginePlugin::ScreenshotCapturedCallback callback); /** * @brief Asynchronous request to check if there is a video playing in the given view. @@ -578,7 +601,7 @@ public: bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback); /** - * @brief Sets callback which alled upon geolocation permission request. + * @brief Set callback which alled upon geolocation permission request. * * @param[in] callback The callback for requesting geolocation permission */ @@ -588,7 +611,7 @@ public: * @brief Update display area. * @param[in] displayArea The area to display web page */ - void UpdateDisplayArea(Dali::Rect displayArea); + void UpdateDisplayArea(Dali::Rect displayArea); /** * @brief Enable video hole. @@ -597,79 +620,135 @@ public: void EnableVideoHole(bool enabled); /** - * @brief Sends hover events. + * @brief Send hover events. * @param[in] event The hover event would be sent. */ - bool SendHoverEvent( const HoverEvent& event ); + bool SendHoverEvent(const HoverEvent& event); /** - * @brief Sends wheel events. + * @brief Send wheel events. * @param[in] event The wheel event would be sent. */ - bool SendWheelEvent( const WheelEvent& event ); + bool SendWheelEvent(const WheelEvent& event); /** - * @brief Connects to this signal to be notified when page loading is started. + * @brief Connect to this signal to be notified when frame is rendered. * - * @return A signal object to connect with + * @return A signal object to connect with. */ - Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal(); + Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& FrameRenderedSignal(); /** - * @brief Connects to this signal to be notified when page loading is in progress. + * @brief Callback to be called when page loading is started. * - * @return A signal object to connect with + * @param[in] callback */ - Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadInProgressSignal(); + void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback); /** - * @brief Connects to this signal to be notified when page loading is finished. + * @brief Callback to be called when page loading is in progress. * - * @return A signal object to connect with + * @param[in] callback */ - Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal(); + void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback); /** - * @brief Connects to this signal to be notified when an error occurs in page loading. + * @brief Callback to be called when page loading is finished. * - * @return A signal object to connect with + * @param[in] callback */ - Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal(); + void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback); /** - * @brief Connects to this signal to be notified when scroll edge is reached. + * @brief Callback to be called when an error occurs in page loading. * - * @return A signal object to connect with + * @param[in] callback */ - Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal(); + void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback); /** - * @brief Connects to this signal to be notified when url is changed. + * @brief Callback to be called when scroll edge is reached. * - * @return A signal object to connect with + * @param[in] callback */ - Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& UrlChangedSignal(); + void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback); /** - * @brief Connects to this signal to be notified when form repost decision is requested. + * @brief Callback to be called when url is changed. * - * @return A signal object to connect with. + * @param[in] callback */ - Dali::WebEnginePlugin::WebEngineFormRepostDecisionSignalType& FormRepostDecisionSignal(); + void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback); /** - * @brief Connects to this signal to be notified when frame is rendered. + * @brief Callback to be called when form repost decision is requested. * - * @return A signal object to connect with. + * @param[in] callback */ - Dali::WebEnginePlugin::WebEngineFrameRenderedSignalType& FrameRenderedSignal(); + void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback); /** - * @brief Connects to this signal to be notified when http request need be intercepted. + * @brief Callback to be called when console message will be logged. * - * @return A signal object to connect with. + * @param[in] callback + */ + void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback); + + /** + * @brief Callback to be called when response policy would be decided. + * + * @param[in] callback + */ + void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback); + + /** + * @brief Callback to be called when navigation policy would be decided. + * + * @param[in] callback + */ + void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback); + + /** + * @brief Callback to be called when certificate need be confirmed. + * + * @param[in] callback + */ + void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback); + + /** + * @brief Callback to be called when ssl certificate is changed. + * + * @param[in] callback + */ + void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback); + + /** + * @brief Callback to be called when http authentication need be confirmed. + * + * @param[in] callback + */ + void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback); + + /** + * @brief Callback to be called when context menu would be shown. + * + * @param[in] callback + */ + void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback); + + /** + * @brief Callback to be called when context menu would be hidden. + * + * @param[in] callback + */ + void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback); + + /** + * @brief Get a plain text of current web page asynchronously. + * + * @param[in] callback The callback function called asynchronously. */ - Dali::WebEnginePlugin::WebEngineRequestInterceptorSignalType& RequestInterceptorSignal(); + void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback); private: // Not intended for application developers /**