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 WebView callback related with screen-shot captured.
192 using WebViewScreenshotCapturedCallback = std::function<void(Dali::Toolkit::ImageView)>;
195 * @brief WebView signal type related with page loading.
197 using WebViewPageLoadSignalType = Signal<void(WebView, const std::string&)>;
200 * @brief WebView signal type related with page loading error.
202 using WebViewPageLoadErrorSignalType = Signal<void(WebView, std::shared_ptr<Dali::WebEngineLoadError>)>;
205 * @brief WebView signal type related with scroll edge reached.
207 using WebViewScrollEdgeReachedSignalType = Signal<void(WebView, Dali::WebEnginePlugin::ScrollEdge)>;
210 * @brief WebView signal type related with url changed.
212 using WebViewUrlChangedSignalType = Signal<void(WebView, const std::string&)>;
215 * @brief WebView signal type related with form repost decision.
217 using WebViewFormRepostDecisionSignalType = Signal<void(WebView, std::shared_ptr<Dali::Toolkit::WebFormRepostDecision>)>;
220 * @brief WebView signal type related with frame rendered.
222 using WebViewFrameRenderedSignalType = Signal<void(WebView)>;
225 * @brief WebView signal type related with http request interceptor.
227 using WebViewRequestInterceptorSignalType = Signal<void(WebView, std::shared_ptr<Dali::WebEngineRequestInterceptor>)>;
230 * @brief WebView signal type related with console message.
232 using WebViewConsoleMessageSignalType = Signal<void(WebView, std::shared_ptr<Dali::WebEngineConsoleMessage>)>;
236 * @brief Creates an initialized WebView.
237 * @return A handle to a newly allocated Dali WebView
239 * @note WebView will not display anything
241 static WebView New();
244 * @brief Creates an initialized WebView.
246 * @param [in] locale The locale of Web
247 * @param [in] timezoneId The timezoneId of Web
249 static WebView New(const std::string& locale, const std::string& timezoneId);
252 * @brief Creates an initialized WebView.
254 * @param [in] argc The count of arguments of Applications
255 * @param [in] argv The string array of arguments of Applications
257 static WebView New(int argc, char** argv);
260 * @brief Creates an uninitialized WebView.
267 * This is non-virtual since derived Handel types must not contain data or virtual methods.
272 * @brief Copy constructor.
274 * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation
276 WebView(const WebView& WebView);
279 * @brief Assignment operator.
281 * @param[in] WebView The WebView to assign from
282 * @return The updated WebView
284 WebView& operator=(const WebView& WebView);
287 * @brief Downcasts a handle to WebView handle.
289 * If handle points to a WebView, the downcast produces valid handle.
290 * If not, the returned handle is left uninitialized.
292 * @param[in] handle Handle to an object
293 * @return Handle to a WebView or an uninitialized handle
295 static WebView DownCast(BaseHandle handle);
298 * @brief Get WebSettings of WebEngine.
300 Dali::Toolkit::WebSettings* GetSettings() const;
303 * @brief Get WebContext of WebEngine.
305 Dali::Toolkit::WebContext* GetContext() const;
308 * @brief Get CookieManager of WebEngine.
310 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
313 * @brief Get WebBackForwardList of WebEngine.
315 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
318 * @brief Get Favicon of web page.
320 * @return Handle to a fav icon
322 Dali::Toolkit::ImageView& GetFavicon();
325 * @brief Loads a web page based on a given URL.
327 * @param [in] url The URL of the resource to load
329 void LoadUrl(const std::string& url);
332 * @brief Loads a given string as web contents.
334 * @param [in] htmlString The string to use as the contents of the web page
336 void LoadHtmlString(const std::string& htmlString);
339 * @brief Load the specified html string as the content of the view overriding current history entry
341 * @param[in] html HTML data to load
342 * @param[in] basicUri Base URL used for relative paths to external objects
343 * @param[in] unreachableUrl URL that could not be reached
345 * @return true if successfully loaded, false otherwise
347 bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
350 * @brief Requests loading the given contents by MIME type into the view object
352 * @param[in] contents The content to load
353 * @param[in] contentSize The size of contents (in bytes)
354 * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
355 * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
356 * @param[in] baseUri The base URI to use for relative resources
358 * @return true if successfully request, false otherwise
360 bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
363 * @brief Reloads the Web.
368 * @brief Reloads the current page's document without cache
370 bool ReloadWithoutCache();
373 * @brief Stops loading web contents on the current page.
378 * @brief Suspends the operation associated with the view.
383 * @brief Resumes the operation associated with the view object after calling Suspend().
388 * @brief To suspend all url loading
390 void SuspendNetworkLoading();
393 * @brief To resume new url network loading
395 void ResumeNetworkLoading();
398 * @brief Add custom header
400 * @param[in] name custom header name to add the custom header
401 * @param[in] value custom header value to add the custom header
403 * @return true if succeeded, false otherwise
405 bool AddCustomHeader(const std::string& name, const std::string& value);
408 * @brief Remove custom header
410 * @param[in] name custom header name to remove the custom header
412 * @return true if succeeded, false otherwise
414 bool RemoveCustomHeader(const std::string& name);
417 * @brief Start the inspector server
419 * @param[in] port port number
421 * @return the port number
423 uint32_t StartInspectorServer(uint32_t port);
426 * @brief Stop the inspector server
428 * @return true if succeeded, false otherwise
430 bool StopInspectorServer();
433 * @brief Scrolls web page of view by deltaX and deltaY.
434 * @param[in] deltaX The delta x of scroll
435 * @param[in] deltaY The delta y of scroll
437 void ScrollBy(int deltaX, int deltaY);
440 * @brief Scrolls edge of view by deltaX and deltaY.
442 * @param[in] deltaX horizontal offset to scroll
443 * @param[in] deltaY vertical offset to scroll
445 * @return true if succeeded, false otherwise
447 bool ScrollEdgeBy(int deltaX, int deltaY);
450 * @brief Returns whether forward is possible.
452 * @return True if forward is possible, false otherwise
457 * @brief Goes forward in the navigation history.
462 * @brief Returns whether backward is possible.
464 * @return True if backward is possible, false otherwise
469 * @brief Goes back in the navigation history.
474 * @brief Evaluates JavaScript code represented as a string.
476 * @param[in] script The JavaScript code
477 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result
479 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
482 * @brief Evaluates JavaScript code represented as a string.
484 * @param[in] script The JavaScript code
486 void EvaluateJavaScript(const std::string& script);
489 * @brief Inject a JavaScript object with a message handler into the WebView.
491 * @note The injected object will appear in the JavaScript context to be loaded next.
497 * webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
498 * printf( "Received a message from JS: %s", message.c_str() );
501 * // Start WebView by loading URL
502 * webview.LoadUrl( url );
506 * myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
509 * @param[in] exposedObjectName The name of exposed object
510 * @param[in] handler The callback function
512 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
515 * @brief Register alert callback for javascript.
517 * @param[in] callback The callback function to be called by the JavaScript runtime.
519 void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
522 * @brief Reply for JavaScript alert.
524 void JavaScriptAlertReply();
527 * @brief Register confirm callback for javascript.
529 * @param[in] callback The callback function to be called by the JavaScript runtime.
531 void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
534 * @brief Reply for JavaScript confirm.
535 * @param[in] confirmed True if confirmed, false otherwise
537 void JavaScriptConfirmReply(bool confirmed);
540 * @brief Register prompt callback for javascript.
542 * @param[in] callback The callback function to be called by the JavaScript runtime.
544 void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
547 * @brief Reply for JavaScript prompt.
548 * @param[in] result The result from input-field of prompt popup.
550 void JavaScriptPromptReply(const std::string& result);
553 * @brief Clears the history of Web.
558 * @brief Clears all tiles resources of Web.
560 void ClearAllTilesResources();
563 * @brief Scales the current page, centered at the given point.
564 * @param[in] scaleFactor a new factor to be scaled.
565 * @param[in] point a center coordinate.
567 void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
570 * @brief Gets the current scale factor of the page.
571 * @return The current scale factor.
573 float GetScaleFactor() const;
576 * @brief Request to activate/deactivate the accessibility usage set by web app.
577 * @param[in] activated Activate accessibility or not.
579 void ActivateAccessibility(bool activated);
582 * @brief Searches and highlights the given string in the document.
583 * @param[in] text The text to find
584 * @param[in] options The options to find
585 * @param[in] maxMatchCount The maximum match count to find
587 * @return true if found & highlighted, false otherwise
589 bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
592 * @brief Add dynamic certificate path.
593 * @param[in] host host that required client authentication
594 * @param[in] certPath the file path stored certificate
596 void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
599 * @brief Get snapshot of the specified viewArea of page.
601 * @param[in] viewArea The rectangle of screen shot
602 * @param[in] scaleFactor The scale factor
604 * @return image view of screen shot
606 Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor);
609 * @brief Request to get snapshot of the specified viewArea of page asynchronously.
611 * @param[in] viewArea The rectangle of screen shot
612 * @param[in] scaleFactor The scale factor
613 * @param[in] callback The callback for screen shot
615 * @return true if requested successfully, false otherwise
617 bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, WebViewScreenshotCapturedCallback callback);
620 * @brief Asynchronous request to check if there is a video playing in the given view.
622 * @param[in] callback The callback called after checking if video is playing or not
624 * @return true if requested successfully, false otherwise
626 bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
629 * @brief Sets callback which will be called upon geolocation permission request.
631 * @param[in] callback The callback for requesting geolocation permission
633 void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
636 * @brief Connects to this signal to be notified when page loading is started.
638 * @return A signal object to connect with
640 WebViewPageLoadSignalType& PageLoadStartedSignal();
643 * @brief Connects to this signal to be notified when page loading is in progress.
645 * @return A signal object to connect with
647 WebViewPageLoadSignalType& PageLoadInProgressSignal();
650 * @brief Connects to this signal to be notified when page loading is finished.
652 * @return A signal object to connect with
654 WebViewPageLoadSignalType& PageLoadFinishedSignal();
657 * @brief Connects to this signal to be notified when an error occurs in page loading.
659 * @return A signal object to connect with
661 WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
664 * @brief Connects to this signal to be notified when scroll edge is reached.
666 * @return A signal object to connect with
668 WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
671 * @brief Connects to this signal to be notified when url is changed.
673 * @return A signal object to connect with
675 WebViewUrlChangedSignalType& UrlChangedSignal();
678 * @brief Connects to this signal to be notified when form repost decision is requested.
680 * @return A signal object to connect with.
682 WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal();
685 * @brief Connects to this signal to be notified when frame is rendered.
687 * @return A signal object to connect with.
689 WebViewFrameRenderedSignalType& FrameRenderedSignal();
692 * @brief Connects to this signal to be notified when http request need be intercepted.
694 * @return A signal object to connect with.
696 WebViewRequestInterceptorSignalType& RequestInterceptorSignal();
699 * @brief Connects to this signal to be notified when console message will be logged.
701 * @return A signal object to connect with.
703 WebViewConsoleMessageSignalType& ConsoleMessageSignal();
705 public: // Not intended for application developers
708 * @brief Creates a handle using the Toolkit::Internal implementation.
710 * @param[in] implementation The WebView implementation
712 DALI_INTERNAL WebView(Internal::WebView& implementation);
715 * @brief Allows the creation of this WebView from an Internal::CustomActor pointer.
717 * @param[in] internal A pointer to the internal CustomActor
719 explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal);
727 } // namespace Toolkit
731 #endif // DALI_TOOLKIT_WEB_VIEW_H