1 #ifndef DALI_TOOLKIT_WEB_VIEW_H
2 #define DALI_TOOLKIT_WEB_VIEW_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
26 #include <dali-toolkit/public-api/controls/control.h>
27 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
34 class WebBackForwardList;
36 class WebCookieManager;
37 class WebFormRepostDecision;
40 namespace Internal DALI_INTERNAL
43 } // namespace DALI_INTERNAL
46 * @addtogroup dali_toolkit_controls_web_view
51 * @brief WebView is a control for displaying web content.
53 * This enables embedding web pages in the application.
55 * For working WebView, a web engine plugin for a platform should be provided.
58 class DALI_TOOLKIT_API WebView : public Control
62 * @brief Enumeration for the start and end property ranges for this control.
66 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
67 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000,
71 * @brief Enumeration for the instance of properties belonging to the WebView class.
78 * @brief The url to load.
79 * @details name "url", type Property::STRING.
81 URL = PROPERTY_START_INDEX,
84 * @brief The user agent string.
85 * @details name "userAgent", type Property::STRING.
90 * @brief The current position of scroll.
91 * @details name "scrollPosition", type Property::VECTOR2.
96 * @brief The current size of scroll.
97 * @details name "scrollSize", type Property::VECTOR2.
98 * @note The value is read-only.
103 * @brief The current size of content.
104 * @details name "contentSize", type Property::VECTOR2.
105 * @note The value is read-only.
110 * @brief The title of web page.
111 * @details name "title", type Property::STRING.
112 * @note The value is read-only.
117 * @brief Whether video hole is enabled or not.
118 * @details name "videoHoleEnabled", type Property::BOOLEAN.
119 * @note The value is read-only.
124 * @brief Whether mouse event is enabled.
125 * @details name "mouseEventsEnabled", type Property::BOOLEAN.
126 * @note Default is true.
128 MOUSE_EVENTS_ENABLED,
131 * @brief Whether key event is enabled.
132 * @details name "keyEventsEnabled", type Property::BOOLEAN.
133 * @note Default is true.
138 * @brief The background color of web page.
139 * @details name "documentBackgroundColor", type Property::VECTOR4.
141 DOCUMENT_BACKGROUND_COLOR,
144 * @brief Whether tiles can be cleared or not when hidden.
145 * @details name "tilesClearedWhenHidden", type BOOLEAN.
147 TILES_CLEARED_WHEN_HIDDEN,
150 * @brief The multiplier of cover area of tile when rendering web page.
151 * @details name "tileCoverAreaMultiplier", type FLOAT.
153 TILE_COVER_AREA_MULTIPLIER,
156 * @brief Whether cursor is enabled or not by client.
157 * @details name "cursorEnabledByClient", type BOOLEAN.
159 CURSOR_ENABLED_BY_CLIENT,
162 * @brief The selected text of web page.
163 * @details name "selectedText", type Property::STRING.
164 * @note The value is read-only.
169 * @brief Zoom factor of web page.
170 * @details name "pageZoomFactor", type Property::FLOAT.
175 * @brief Zoom factor of text.
176 * @details name "textZoomFactor", type Property::FLOAT.
181 * @brief progress percentage of loading a web page.
182 * @details name "loadProgressPercentage", type Property::FLOAT.
183 * @note The value is read-only.
185 LOAD_PROGRESS_PERCENTAGE,
190 * @brief Enumeration for indicating error code of page loading.
192 enum class LoadErrorCode
194 UNKNOWN = 0, ///< Unknown.
195 CANCELED, ///< User canceled.
196 CANT_SUPPORT_MIMETYPE, ///< Can't show the page for this MIME type.
197 FAILED_FILE_IO, ///< File IO error.
198 CANT_CONNECT, ///< Cannot connect to the network.
199 CANT_LOOKUP_HOST, ///< Fail to look up host from the DNS.
200 FAILED_TLS_HANDSHAKE, ///< Fail to SSL/TLS handshake.
201 INVALID_CERTIFICATE, ///< Received certificate is invalid.
202 REQUEST_TIMEOUT, ///< Connection timeout.
203 TOO_MANY_REDIRECTS, ///< Too many redirects.
204 TOO_MANY_REQUESTS, ///< Too many requests during this load.
205 BAD_URL, ///< Malformed URL.
206 UNSUPPORTED_SCHEME, ///< Unsupported scheme.
207 AUTHENTICATION, ///< User authentication failed on the server.
208 INTERNAL_SERVER ///< Web server has an internal server error.
212 * @brief WebView callback related with screen-shot captured.
214 using WebViewScreenshotCapturedCallback = std::function<void(Dali::Toolkit::ImageView)>;
217 * @brief WebView signal type related with page loading.
219 using WebViewPageLoadSignalType = Signal<void(WebView, const std::string&)>;
222 * @brief WebView signal type related with page loading error.
224 using WebViewPageLoadErrorSignalType = Signal<void(WebView, const std::string&, LoadErrorCode)>;
227 * @brief WebView signal type related with scroll edge reached.
229 using WebViewScrollEdgeReachedSignalType = Signal<void(WebView, Dali::WebEnginePlugin::ScrollEdge)>;
232 * @brief WebView signal type related with url changed.
234 using WebViewUrlChangedSignalType = Signal<void(WebView, const std::string&)>;
237 * @brief WebView signal type related with form repost decision.
239 using WebViewFormRepostDecisionSignalType = Signal<void(WebView, std::shared_ptr<Dali::Toolkit::WebFormRepostDecision>)>;
242 * @brief WebView signal type related with frame rendered.
244 using WebViewFrameRenderedSignalType = Signal<void(WebView)>;
248 * @brief Creates an initialized WebView.
249 * @return A handle to a newly allocated Dali WebView
251 * @note WebView will not display anything
253 static WebView New();
256 * @brief Creates an initialized WebView.
258 * @param [in] locale The locale of Web
259 * @param [in] timezoneId The timezoneId of Web
261 static WebView New(const std::string& locale, const std::string& timezoneId);
264 * @brief Creates an initialized WebView.
266 * @param [in] argc The count of arguments of Applications
267 * @param [in] argv The string array of arguments of Applications
269 static WebView New(int argc, char** argv);
272 * @brief Creates an uninitialized WebView.
279 * This is non-virtual since derived Handel types must not contain data or virtual methods.
284 * @brief Copy constructor.
286 * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation
288 WebView(const WebView& WebView);
291 * @brief Assignment operator.
293 * @param[in] WebView The WebView to assign from
294 * @return The updated WebView
296 WebView& operator=(const WebView& WebView);
299 * @brief Downcasts a handle to WebView handle.
301 * If handle points to a WebView, the downcast produces valid handle.
302 * If not, the returned handle is left uninitialized.
304 * @param[in] handle Handle to an object
305 * @return Handle to a WebView or an uninitialized handle
307 static WebView DownCast(BaseHandle handle);
310 * @brief Get WebSettings of WebEngine.
312 Dali::Toolkit::WebSettings* GetSettings() const;
315 * @brief Get WebContext of WebEngine.
317 Dali::Toolkit::WebContext* GetContext() const;
320 * @brief Get CookieManager of WebEngine.
322 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
325 * @brief Get WebBackForwardList of WebEngine.
327 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
330 * @brief Get Favicon of web page.
332 * @return Handle to a fav icon
334 Dali::Toolkit::ImageView& GetFavicon();
337 * @brief Loads a web page based on a given URL.
339 * @param [in] url The URL of the resource to load
341 void LoadUrl(const std::string& url);
344 * @brief Loads a given string as web contents.
346 * @param [in] htmlString The string to use as the contents of the web page
348 void LoadHtmlString(const std::string& htmlString);
351 * @brief Load the specified html string as the content of the view overriding current history entry
353 * @param[in] html HTML data to load
354 * @param[in] basicUri Base URL used for relative paths to external objects
355 * @param[in] unreachableUrl URL that could not be reached
357 * @return true if successfully loaded, false otherwise
359 bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
362 * @brief Requests loading the given contents by MIME type into the view object
364 * @param[in] contents The content to load
365 * @param[in] contentSize The size of contents (in bytes)
366 * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
367 * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
368 * @param[in] baseUri The base URI to use for relative resources
370 * @return true if successfully request, false otherwise
372 bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
375 * @brief Reloads the Web.
380 * @brief Reloads the current page's document without cache
382 bool ReloadWithoutCache();
385 * @brief Stops loading web contents on the current page.
390 * @brief Suspends the operation associated with the view.
395 * @brief Resumes the operation associated with the view object after calling Suspend().
400 * @brief To suspend all url loading
402 void SuspendNetworkLoading();
405 * @brief To resume new url network loading
407 void ResumeNetworkLoading();
410 * @brief Add custom header
412 * @param[in] name custom header name to add the custom header
413 * @param[in] value custom header value to add the custom header
415 * @return true if succeeded, false otherwise
417 bool AddCustomHeader(const std::string& name, const std::string& value);
420 * @brief Remove custom header
422 * @param[in] name custom header name to remove the custom header
424 * @return true if succeeded, false otherwise
426 bool RemoveCustomHeader(const std::string& name);
429 * @brief Start the inspector server
431 * @param[in] port port number
433 * @return the port number
435 uint32_t StartInspectorServer(uint32_t port);
438 * @brief Stop the inspector server
440 * @return true if succeeded, false otherwise
442 bool StopInspectorServer();
445 * @brief Scrolls web page of view by deltaX and deltaY.
446 * @param[in] deltaX The delta x of scroll
447 * @param[in] deltaY The delta y of scroll
449 void ScrollBy(int deltaX, int deltaY);
452 * @brief Scrolls edge of view by deltaX and deltaY.
454 * @param[in] deltaX horizontal offset to scroll
455 * @param[in] deltaY vertical offset to scroll
457 * @return true if succeeded, false otherwise
459 bool ScrollEdgeBy(int deltaX, int deltaY);
462 * @brief Returns whether forward is possible.
464 * @return True if forward is possible, false otherwise
469 * @brief Goes forward in the navigation history.
474 * @brief Returns whether backward is possible.
476 * @return True if backward is possible, false otherwise
481 * @brief Goes back in the navigation history.
486 * @brief Evaluates JavaScript code represented as a string.
488 * @param[in] script The JavaScript code
489 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result
491 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
494 * @brief Evaluates JavaScript code represented as a string.
496 * @param[in] script The JavaScript code
498 void EvaluateJavaScript(const std::string& script);
501 * @brief Inject a JavaScript object with a message handler into the WebView.
503 * @note The injected object will appear in the JavaScript context to be loaded next.
509 * webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
510 * printf( "Received a message from JS: %s", message.c_str() );
513 * // Start WebView by loading URL
514 * webview.LoadUrl( url );
518 * myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
521 * @param[in] exposedObjectName The name of exposed object
522 * @param[in] handler The callback function
524 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
527 * @brief Register alert callback for javascript.
529 * @param[in] callback The callback function to be called by the JavaScript runtime.
531 void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
534 * @brief Reply for JavaScript alert.
536 void JavaScriptAlertReply();
539 * @brief Register confirm callback for javascript.
541 * @param[in] callback The callback function to be called by the JavaScript runtime.
543 void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
546 * @brief Reply for JavaScript confirm.
547 * @param[in] confirmed True if confirmed, false otherwise
549 void JavaScriptConfirmReply(bool confirmed);
552 * @brief Register prompt callback for javascript.
554 * @param[in] callback The callback function to be called by the JavaScript runtime.
556 void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
559 * @brief Reply for JavaScript prompt.
560 * @param[in] result The result from input-field of prompt popup.
562 void JavaScriptPromptReply(const std::string& result);
565 * @brief Clears the history of Web.
570 * @brief Clears all tiles resources of Web.
572 void ClearAllTilesResources();
575 * @brief Scales the current page, centered at the given point.
576 * @param[in] scaleFactor a new factor to be scaled.
577 * @param[in] point a center coordinate.
579 void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
582 * @brief Gets the current scale factor of the page.
583 * @return The current scale factor.
585 float GetScaleFactor() const;
588 * @brief Request to activate/deactivate the accessibility usage set by web app.
589 * @param[in] activated Activate accessibility or not.
591 void ActivateAccessibility(bool activated);
594 * @brief Searches and highlights the given string in the document.
595 * @param[in] text The text to find
596 * @param[in] options The options to find
597 * @param[in] maxMatchCount The maximum match count to find
599 * @return true if found & highlighted, false otherwise
601 bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
604 * @brief Add dynamic certificate path.
605 * @param[in] host host that required client authentication
606 * @param[in] certPath the file path stored certificate
608 void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
611 * @brief Get snapshot of the specified viewArea of page.
613 * @param[in] viewArea The rectangle of screen shot
614 * @param[in] scaleFactor The scale factor
616 * @return image view of screen shot
618 Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor);
621 * @brief Request to get snapshot of the specified viewArea of page asynchronously.
623 * @param[in] viewArea The rectangle of screen shot
624 * @param[in] scaleFactor The scale factor
625 * @param[in] callback The callback for screen shot
627 * @return true if requested successfully, false otherwise
629 bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, WebViewScreenshotCapturedCallback callback);
632 * @brief Asynchronous request to check if there is a video playing in the given view.
634 * @param[in] callback The callback called after checking if video is playing or not
636 * @return true if requested successfully, false otherwise
638 bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
641 * @brief Sets callback which will be called upon geolocation permission request.
643 * @param[in] callback The callback for requesting geolocation permission
645 void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
648 * @brief Connects to this signal to be notified when page loading is started.
650 * @return A signal object to connect with
652 WebViewPageLoadSignalType& PageLoadStartedSignal();
655 * @brief Connects to this signal to be notified when page loading is in progress.
657 * @return A signal object to connect with
659 WebViewPageLoadSignalType& PageLoadInProgressSignal();
662 * @brief Connects to this signal to be notified when page loading is finished.
664 * @return A signal object to connect with
666 WebViewPageLoadSignalType& PageLoadFinishedSignal();
669 * @brief Connects to this signal to be notified when an error occurs in page loading.
671 * @return A signal object to connect with
673 WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
676 * @brief Connects to this signal to be notified when scroll edge is reached.
678 * @return A signal object to connect with
680 WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
683 * @brief Connects to this signal to be notified when url is changed.
685 * @return A signal object to connect with
687 WebViewUrlChangedSignalType& UrlChangedSignal();
690 * @brief Connects to this signal to be notified when form repost decision is requested.
692 * @return A signal object to connect with.
694 WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal();
697 * @brief Connects to this signal to be notified when frame is rendered.
699 * @return A signal object to connect with.
701 WebViewFrameRenderedSignalType& FrameRenderedSignal();
703 public: // Not intended for application developers
706 * @brief Creates a handle using the Toolkit::Internal implementation.
708 * @param[in] implementation The WebView implementation
710 DALI_INTERNAL WebView(Internal::WebView& implementation);
713 * @brief Allows the creation of this WebView from an Internal::CustomActor pointer.
715 * @param[in] internal A pointer to the internal CustomActor
717 explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal);
725 } // namespace Toolkit
729 #endif // DALI_TOOLKIT_WEB_VIEW_H