1 #ifndef DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_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.
22 #include <dali/devel-api/actors/actor-devel.h>
23 #include <dali/devel-api/adaptor-framework/web-engine.h>
24 #include <dali/public-api/images/image-operations.h>
25 #include <dali/public-api/object/property-notification.h>
29 #include <dali-toolkit/devel-api/controls/web-view/web-view.h>
30 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
31 #include <dali-toolkit/public-api/controls/control-impl.h>
32 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
40 class WebBackForwardList;
42 class WebCookieManager;
48 class WebView : public Control
53 WebView(const std::string& locale, const std::string& timezoneId);
55 WebView(int argc, char** argv);
61 * @copydoc Dali::Toolkit::WebView::New()
63 static Toolkit::WebView New();
66 * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
68 static Toolkit::WebView New(const std::string& locale, const std::string& timezoneId);
71 * @copydoc Dali::Toolkit::WebView::New( int, char** )
73 static Toolkit::WebView New(int argc, char** argv);
76 * @brief Get settings of WebEngine.
78 Dali::Toolkit::WebSettings* GetSettings() const;
81 * @brief Get context of WebEngine.
83 Dali::Toolkit::WebContext* GetContext() const;
86 * @brief Get cookie manager of WebEngine.
88 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
91 * @brief Get WebBackForwardList of WebEngine.
93 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
96 * @brief Get Favicon of web page.
98 * @return Handle to a fav icon
100 Dali::Toolkit::ImageView& GetFavicon();
103 * @copydoc Dali::Toolkit::WebView::LoadUrl()
105 void LoadUrl(const std::string& url);
108 * @copydoc Dali::WebEngine::LoadHTMLString()
110 void LoadHtmlString(const std::string& htmlString);
113 * @copydoc Dali::WebEngine::LoadHtmlStringOverrideCurrentEntry()
115 bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
118 * @copydoc Dali::WebEngine::LoadContents()
120 bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
123 * @copydoc Dali::Toolkit::WebView::Reload()
128 * @copydoc Dali::WebEngine::ReloadWithoutCache()
130 bool ReloadWithoutCache();
133 * @copydoc Dali::Toolkit::WebView::StopLoading()
138 * @copydoc Dali::Toolkit::WebView::StopLoading()
143 * @copydoc Dali::Toolkit::WebView::Resume()
148 * @copydoc Dali::WebEngine::SuspendNetworkLoading()
150 void SuspendNetworkLoading();
153 * @copydoc Dali::WebEngine::ResumeNetworkLoading()
155 void ResumeNetworkLoading();
158 * @copydoc Dali::WebEngine::AddCustomHeader()
160 bool AddCustomHeader(const std::string& name, const std::string& value);
163 * @copydoc Dali::WebEngine::RemoveCustomHeader()
165 bool RemoveCustomHeader(const std::string& name);
168 * @copydoc Dali::WebEngine::StartInspectorServer()
170 uint32_t StartInspectorServer(uint32_t port);
173 * @copydoc Dali::WebEngine::StopInspectorServer()
175 bool StopInspectorServer();
178 * @copydoc Dali::Toolkit::WebView::ScrollBy()
180 void ScrollBy(int deltaX, int deltaY);
183 * @copydoc Dali::WebEngine::ScrollEdgeBy()
185 bool ScrollEdgeBy(int deltaX, int deltaY);
188 * @copydoc Dali::Toolkit::WebView::CanGoForward()
193 * @copydoc Dali::Toolkit::WebView::GoForward()
198 * @copydoc Dali::Toolkit::WebView::CanGoBack()
203 * @copydoc Dali::Toolkit::WebView::GoBack()
208 * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
210 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
213 * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
215 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
218 * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptAlertCallback()
220 void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
223 * @copydoc Dali::Toolkit::WebView::JavaScriptAlertReply()
225 void JavaScriptAlertReply();
228 * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptConfirmCallback()
230 void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
233 * @copydoc Dali::Toolkit::WebView::JavaScriptConfirmReply()
235 void JavaScriptConfirmReply(bool confirmed);
238 * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptPromptCallback()
240 void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
243 * @copydoc Dali::Toolkit::WebView::JavaScriptPromptReply()
245 void JavaScriptPromptReply(const std::string& result);
248 * @copydoc Dali::Toolkit::WebView::ClearHistory()
253 * @copydoc Dali::Toolkit::WebView::ClearAllTilesResources()
255 void ClearAllTilesResources();
258 * @copydoc Dali::Toolkit::WebView::SetScaleFactor()
260 void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
263 * @copydoc Dali::Toolkit::WebView::GetScaleFactor()
265 float GetScaleFactor() const;
268 * @copydoc Dali::Toolkit::WebView::ActivateAccessibility()
270 void ActivateAccessibility(bool activated);
273 * @copydoc Dali::Toolkit::WebView::HighlightText()
275 bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
278 * @copydoc Dali::Toolkit::WebView::AddDynamicCertificatePath()
280 void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
283 * @copydoc Dali::Toolkit::WebView::GetScreenshot()
285 Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor);
288 * @copydoc Dali::Toolkit::WebView::GetScreenshotAsynchronously()
290 bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback);
293 * @copydoc Dali::Toolkit::WebView::CheckVideoPlayingAsynchronously()
295 bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
298 * @copydoc Dali::Toolkit::WebView::RegisterGeolocationPermissionCallback()
300 void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
303 * @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
305 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
308 * @copydoc Dali::Toolkit::WebView::PageLoadInProgressSignal()
310 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadInProgressSignal();
313 * @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
315 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
318 * @copydoc Dali::Toolkit::WebView::PageLoadErrorSignal()
320 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
323 * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
325 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
328 * @copydoc Dali::Toolkit::WebView::UrlChangedSignal()
330 Dali::Toolkit::WebView::WebViewUrlChangedSignalType& UrlChangedSignal();
333 * @copydoc Dali::Toolkit::WebView::FormRepostDecisionSignal()
335 Dali::Toolkit::WebView::WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal();
338 * @copydoc Dali::Toolkit::WebView::FrameRenderedSignal()
340 Dali::Toolkit::WebView::WebViewFrameRenderedSignalType& FrameRenderedSignal();
343 * @copydoc Dali::Toolkit::WebView::RequestInterceptorSignal()
345 Dali::Toolkit::WebView::WebViewRequestInterceptorSignalType& RequestInterceptorSignal();
348 * @copydoc Dali::Toolkit::WebView::ConsoleMessageSignal()
350 Dali::Toolkit::WebView::WebViewConsoleMessageSignalType& ConsoleMessageSignal();
352 public: // Properties
354 * @brief Called when a property of an object of this type is set.
356 * @param[in] object The object whose property is set.
357 * @param[in] index The property index.
358 * @param[in] value The new property value.
360 static void SetProperty(Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value);
363 * @brief Called to retrieve a property of an object of this type.
365 * @param[in] object The object whose property is to be retrieved.
366 * @param[in] index The property index.
367 * @return The current value of the property.
369 static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
372 * Connects a callback function with the object's signals.
373 * @param[in] object The object providing the signal.
374 * @param[in] tracker Used to disconnect the signal.
375 * @param[in] signalName The signal to connect to.
376 * @param[in] functor A newly allocated FunctorDelegate.
377 * @return True if the signal was connected.
378 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
380 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
382 private: // From Control
384 * @copydoc Toolkit::Control::OnInitialize()
386 void OnInitialize() override;
389 * @copydoc Toolkit::Control::GetNaturalSize
391 Vector3 GetNaturalSize() override;
394 * @copydoc Toolkit::Control::OnKeyEvent()
396 bool OnKeyEvent(const Dali::KeyEvent& event) override;
399 * @copydoc Toolkit::Control::OnKeyInputFocusGained()
401 void OnKeyInputFocusGained() override;
404 * @copydoc Toolkit::Control::OnKeyInputFocusLost()
406 void OnKeyInputFocusLost() override;
409 * @copydoc Toolkit::Control::OnSceneConnection()
411 void OnSceneConnection(int depth) override;
415 WebView(const WebView& webView);
417 WebView& operator=(const WebView& webView);
420 * @brief Set an absolute scroll of the given view.
421 * @param[in] x The coordinate x of scroll
422 * @param[in] y The coordinate y of scroll
424 void SetScrollPosition(int x, int y);
427 * @brief Gets the current scroll position of the given view.
428 * @param[out] x The coordinate x of scroll
429 * @param[out] y The coordinate y of scroll
431 Dali::Vector2 GetScrollPosition() const;
434 * @brief Get the possible scroll size of the given view.
435 * @param[out] width The width of scroll size
436 * @param[out] height The height of scroll size
438 Dali::Vector2 GetScrollSize() const;
441 * @brief Get the last known content's size.
442 * @param[out] width The width of content's size
443 * @param[out] height The height of content's size
445 Dali::Vector2 GetContentSize() const;
448 * @brief Return the title of the Web.
450 * @return The title of web page
452 std::string GetTitle() const;
455 * @brief Set the background color of web page.
456 * @param[in] color The value of background color.
458 void SetDocumentBackgroundColor(Dali::Vector4 color);
461 * @brief Clear tiles when hidden.
463 * @param[in] cleared Whether tiles are cleared or not
465 void ClearTilesWhenHidden(bool cleared);
468 * @brief Set multiplier of cover area of tile.
470 * @param[in] multiplier The multiplier of cover area
472 void SetTileCoverAreaMultiplier(float multiplier);
475 * @brief Enable cursor by client.
476 * @param[in] enabled Whether cursor is enabled or not.
478 void EnableCursorByClient(bool enabled);
481 * @brief Get the selected text.
482 * @return The selected text
484 std::string GetSelectedText() const;
487 * @brief Get user agent string.
488 * @return The string value of user agent
490 const std::string& GetUserAgent() const;
493 * @brief Set user agent string.
494 * @param[in] userAgent The string value of user agent
496 void SetUserAgent(const std::string& userAgent);
499 * @brief Set zoom factor of the current page.
500 * @param[in] zoomFactor a new factor to be set.
502 void SetPageZoomFactor(float zoomFactor);
505 * @brief Query the current zoom factor of the page。
506 * @return The current page zoom factor.
508 float GetPageZoomFactor() const;
511 * @brief Set the current text zoom level。.
512 * @param[in] zoomFactor a new factor to be set.
514 void SetTextZoomFactor(float zoomFactor);
517 * @brief Get the current text zoom level.
518 * @return The current text zoom factor.
520 float GetTextZoomFactor() const;
523 * @brief Get the current load progress of the page.
524 * @return The load progress of the page.
526 float GetLoadProgressPercentage() const;
529 * @brief Request to set the current page's visibility.
530 * @param[in] visible Visible or not.
532 * @return true if succeeded, false otherwise
534 bool SetVisibility(bool visible);
537 * @brief Update display area of web view.
538 * @param[in] source The soource triggers Notification.
540 void UpdateDisplayArea(Dali::PropertyNotification& source);
543 * @brief Enable/Disable video hole for video playing.
544 * @param[in] enabled True if video hole is enabled, false otherwise.
546 void EnableVideoHole(bool enabled);
549 * @brief Enable blend mode.
550 * @param[in] blendEnabled True if turn on blend mode, false otherwise.
552 void EnableBlendMode(bool blendEnabled);
555 * @brief Enable/disable mouse events. The default is enabled.
557 * @param[in] enabled True if mouse events are enabled, false otherwise
559 void EnableMouseEvents(bool enabled);
562 * @brief Enable/disable key events. The default is enabled.
564 * @param[in] enabled True if key events enabled, false otherwise
566 void EnableKeyEvents(bool enabled);
569 * @brief Create image view by pixel data.
570 * @param[in] pixel Pixel data
571 * @return The new image view
573 Dali::Toolkit::ImageView CreateImageView(Dali::PixelData pixel);
576 * @brief Callback function to be called when page load started.
577 * @param[in] url The url currently being loaded
579 void OnPageLoadStarted(const std::string& url);
582 * @brief Callback function to be called when page is loading in progress.
583 * @param[in] url The url currently being loaded
585 void OnPageLoadInProgress(const std::string& url);
588 * @brief Callback function to be called when page load finished.
589 * @param[in] url The url currently being loaded
591 void OnPageLoadFinished(const std::string& url);
594 * @brief Callback function to be called when there is an error in page loading.
595 * @param[in] url The url currently being loaded
596 * @param[in] errorCode The error code
598 void OnPageLoadError(std::shared_ptr<Dali::WebEngineLoadError> error);
601 * @brief Callback function to be called when scroll edge is reached.
602 * @param[in] e The scroll edge reached.
604 void OnScrollEdgeReached(Dali::WebEnginePlugin::ScrollEdge edge);
607 * @brief Callback function to be called when url is changed.
608 * @param[in] url The url currently being loaded
610 void OnUrlChanged(const std::string& url);
613 * Signal occurs when the Web View has been touched.
614 * @param[in] actor The Actor Touched
615 * @param[in] touch The Touch Data.
616 * @return Whether to consume event or not.
618 bool OnTouchEvent(Actor actor, const Dali::TouchEvent& touch);
621 * Signal occurs when the Web View has been hovered.
622 * @param[in] actor The Actor Hovered
623 * @param[in] hover The Hover Data.
624 * @return Whether to consume event or not.
626 bool OnHoverEvent(Actor actor, const Dali::HoverEvent& hover);
629 * Signal occurs when the Web View receives wheel event.
630 * @param[in] actor The Actor that receives Wheel event.
631 * @param[in] wheel The Wheel Data.
632 * @return Whether to consume event or not.
634 bool OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel);
637 * @brief Callback function to be called when form repost decision need be checked.
638 * @param[in] decision The new decision for form repost
640 void OnFormRepostDecision(std::shared_ptr<Dali::WebEngineFormRepostDecision> decision);
643 * @brief Callback function to be called when frame is rendered.
645 void OnFrameRendered();
648 * @brief Callback function to be called when visibility is changed.
649 * @param[in] actor The actor, or child of actor, whose visibility has changed
650 * @param[in] isVisible Whether the actor is now visible or not
651 * @param[in] type, Whether the actor's visible property has changed or a parent's
653 void OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type);
656 * @brief callback for screen shot captured.
657 * @param[in] pixel Pixel data of screen shot.
659 void OnScreenshotCaptured(Dali::PixelData pixel);
662 * @brief Callback function to be called when http request need be intercepted.
663 * @param [in] request The http request interceptor.
665 void OnInterceptRequest(std::shared_ptr<Dali::WebEngineRequestInterceptor> interceptor);
668 * @brief Callback function to be called when console message will be logged.
669 * @param[in] message The message logged.
671 void OnConsoleMessage(std::shared_ptr<Dali::WebEngineConsoleMessage> message);
675 Dali::Toolkit::Visual::Base mVisual;
676 Dali::Size mWebViewSize;
677 Dali::WebEngine mWebEngine;
679 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadStartedSignal;
680 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadInProgressSignal;
681 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadFinishedSignal;
682 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType mPageLoadErrorSignal;
683 Dali::Toolkit::WebView::WebViewUrlChangedSignalType mUrlChangedSignal;
684 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType mScrollEdgeReachedSignal;
685 Dali::Toolkit::WebView::WebViewFormRepostDecisionSignalType mFormRepostDecisionSignal;
686 Dali::Toolkit::WebView::WebViewFrameRenderedSignalType mFrameRenderedSignal;
687 Dali::Toolkit::WebView::WebViewRequestInterceptorSignalType mRequestInterceptorSignal;
688 Dali::Toolkit::WebView::WebViewConsoleMessageSignalType mConsoleMessageSignal;
690 std::unique_ptr<Dali::Toolkit::WebContext> mWebContext;
691 std::unique_ptr<Dali::Toolkit::WebCookieManager> mWebCookieManager;
692 std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
693 std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
695 Dali::Toolkit::ImageView mFaviconView;
697 Dali::PropertyNotification mPositionUpdateNotification;
698 Dali::PropertyNotification mSizeUpdateNotification;
699 Dali::PropertyNotification mScaleUpdateNotification;
700 bool mVideoHoleEnabled;
701 Dali::Rect<int> mWebViewArea;
702 bool mMouseEventsEnabled;
703 bool mKeyEventsEnabled;
705 Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback mScreenshotCapturedCallback;
708 } // namespace Internal
710 inline Toolkit::Internal::WebView& GetImpl(Toolkit::WebView& handle)
712 DALI_ASSERT_ALWAYS(handle);
713 Dali::RefObject& impl = handle.GetImplementation();
714 return static_cast<Toolkit::Internal::WebView&>(impl);
717 inline const Toolkit::Internal::WebView& GetImpl(const Toolkit::WebView& handle)
719 DALI_ASSERT_ALWAYS(handle);
720 const Dali::RefObject& impl = handle.GetImplementation();
721 return static_cast<const Toolkit::Internal::WebView&>(impl);
724 } // namespace Toolkit
728 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H