1 #ifndef DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
5 * Copyright (c) 2022 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/proxy-accessible.h>
24 #include <dali/devel-api/adaptor-framework/web-engine/web-engine.h>
25 #include <dali/public-api/images/image-operations.h>
26 #include <dali/public-api/object/property-notification.h>
28 #include <unordered_map>
31 #include <dali-toolkit/devel-api/controls/control-accessible.h>
32 #include <dali-toolkit/devel-api/controls/web-view/web-view.h>
33 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
34 #include <dali-toolkit/public-api/controls/control-impl.h>
35 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
43 class WebBackForwardList;
49 class WebView : public Control
54 WebView(const std::string& locale, const std::string& timezoneId);
56 WebView(uint32_t argc, char** argv);
62 * @copydoc Dali::Toolkit::WebView::New()
64 static Toolkit::WebView New();
67 * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
69 static Toolkit::WebView New(const std::string& locale, const std::string& timezoneId);
72 * @copydoc Dali::Toolkit::WebView::New( uint32_t, char** )
74 static Toolkit::WebView New(uint32_t argc, char** argv);
77 * @copydoc Dali::Toolkit::WebView::FindWebView()
79 static Toolkit::WebView FindWebView(Dali::WebEnginePlugin* plugin);
82 * @copydoc Dali::Toolkit::WebView::GetContext()
84 static Dali::WebEngineContext* GetContext();
87 * @copydoc Dali::Toolkit::WebView::GetCookieManager()
89 static Dali::WebEngineCookieManager* GetCookieManager();
92 * @copydoc Dali::Toolkit::WebView::GetSettings()
94 Dali::Toolkit::WebSettings* GetSettings() const;
97 * @copydoc Dali::Toolkit::WebView::GetBackForwardList()
99 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
102 * @copydoc Dali::Toolkit::WebView::GetPlugin()
104 Dali::WebEnginePlugin* GetPlugin() const;
107 * @copydoc Dali::Toolkit::WebView::GetFavicon()
109 Dali::Toolkit::ImageView GetFavicon() const;
112 * @copydoc Dali::Toolkit::WebView::LoadUrl()
114 void LoadUrl(const std::string& url);
117 * @copydoc Dali::WebEngine::LoadHTMLString()
119 void LoadHtmlString(const std::string& htmlString);
122 * @copydoc Dali::WebEngine::LoadHtmlStringOverrideCurrentEntry()
124 bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
127 * @copydoc Dali::WebEngine::LoadContents()
129 bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
132 * @copydoc Dali::Toolkit::WebView::Reload()
137 * @copydoc Dali::WebEngine::ReloadWithoutCache()
139 bool ReloadWithoutCache();
142 * @copydoc Dali::Toolkit::WebView::StopLoading()
147 * @copydoc Dali::Toolkit::WebView::StopLoading()
152 * @copydoc Dali::Toolkit::WebView::Resume()
157 * @copydoc Dali::WebEngine::SuspendNetworkLoading()
159 void SuspendNetworkLoading();
162 * @copydoc Dali::WebEngine::ResumeNetworkLoading()
164 void ResumeNetworkLoading();
167 * @copydoc Dali::WebEngine::AddCustomHeader()
169 bool AddCustomHeader(const std::string& name, const std::string& value);
172 * @copydoc Dali::WebEngine::RemoveCustomHeader()
174 bool RemoveCustomHeader(const std::string& name);
177 * @copydoc Dali::WebEngine::StartInspectorServer()
179 uint32_t StartInspectorServer(uint32_t port);
182 * @copydoc Dali::WebEngine::StopInspectorServer()
184 bool StopInspectorServer();
187 * @copydoc Dali::Toolkit::WebView::ScrollBy()
189 void ScrollBy(int32_t deltaX, int32_t deltaY);
192 * @copydoc Dali::WebEngine::ScrollEdgeBy()
194 bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY);
197 * @copydoc Dali::Toolkit::WebView::CanGoForward()
202 * @copydoc Dali::Toolkit::WebView::GoForward()
207 * @copydoc Dali::Toolkit::WebView::CanGoBack()
212 * @copydoc Dali::Toolkit::WebView::GoBack()
217 * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
219 void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler);
222 * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
224 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler);
227 * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptAlertCallback()
229 void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
232 * @copydoc Dali::Toolkit::WebView::JavaScriptAlertReply()
234 void JavaScriptAlertReply();
237 * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptConfirmCallback()
239 void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
242 * @copydoc Dali::Toolkit::WebView::JavaScriptConfirmReply()
244 void JavaScriptConfirmReply(bool confirmed);
247 * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptPromptCallback()
249 void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
252 * @copydoc Dali::Toolkit::WebView::JavaScriptPromptReply()
254 void JavaScriptPromptReply(const std::string& result);
257 * @copydoc Dali::Toolkit::WebView::CreateHitTest()
259 std::unique_ptr<Dali::WebEngineHitTest> CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode);
262 * @copydoc Dali::Toolkit::WebView::CreateHitTestAsynchronously()
264 bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback);
267 * @copydoc Dali::Toolkit::WebView::ClearHistory()
272 * @copydoc Dali::Toolkit::WebView::ClearAllTilesResources()
274 void ClearAllTilesResources();
277 * @copydoc Dali::Toolkit::WebView::SetScaleFactor()
279 void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
282 * @copydoc Dali::Toolkit::WebView::GetScaleFactor()
284 float GetScaleFactor() const;
287 * @copydoc Dali::Toolkit::WebView::ActivateAccessibility()
289 void ActivateAccessibility(bool activated);
292 * @copydoc Dali::Toolkit::WebView::HighlightText()
294 bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
297 * @copydoc Dali::Toolkit::WebView::AddDynamicCertificatePath()
299 void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
302 * @copydoc Dali::Toolkit::WebView::GetScreenshot()
304 Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor);
307 * @copydoc Dali::Toolkit::WebView::GetScreenshotAsynchronously()
309 bool GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback);
312 * @copydoc Dali::Toolkit::WebView::CheckVideoPlayingAsynchronously()
314 bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
317 * @copydoc Dali::Toolkit::WebView::RegisterGeolocationPermissionCallback()
319 void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
322 * @copydoc Dali::Toolkit::WebView::SetTtsFocus()
324 void SetTtsFocus(bool focused);
327 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadStartedCallback()
329 void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
332 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadInProgressCallback()
334 void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
337 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadFinishedCallback()
339 void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
342 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadErrorCallback()
344 void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
347 * @copydoc Dali::Toolkit::WebView::RegisterScrollEdgeReachedCallback()
349 void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
352 * @copydoc Dali::Toolkit::WebView::RegisterUrlChangedCallback()
354 void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback);
357 * @copydoc Dali::Toolkit::WebView::RegisterFormRepostDecidedCallback()
359 void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback);
362 * @copydoc Dali::Toolkit::WebView::RegisterFrameRenderedCallback()
364 void RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback);
367 * @copydoc Dali::Toolkit::WebView::RegisterConsoleMessageReceivedCallback()
369 void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback);
372 * @copydoc Dali::Toolkit::WebView::RegisterResponsePolicyDecidedCallback()
374 void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback);
377 * @copydoc Dali::Toolkit::WebView::RegisterNavigationPolicyDecidedCallback()
379 void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback);
382 * @copydoc Dali::Toolkit::WebView::RegisterNewWindowCreatedCallback()
384 void RegisterNewWindowCreatedCallback(Dali::WebEnginePlugin::WebEngineNewWindowCreatedCallback callback);
387 * @copydoc Dali::Toolkit::WebView::RegisterCertificateConfirmedCallback()
389 void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
392 * @copydoc Dali::Toolkit::WebView::RegisterSslCertificateChangedCallback()
394 void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
397 * @copydoc Dali::Toolkit::WebView::RegisterHttpAuthHandlerCallback()
399 void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback);
402 * @copydoc Dali::Toolkit::WebView::RegisterContextMenuShownCallback()
404 void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback);
407 * @copydoc Dali::Toolkit::WebView::RegisterContextMenuHiddenCallback()
409 void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback);
412 * @copydoc Dali::Toolkit::WebView::GetPlainTextAsynchronously()
414 void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
416 public: // Properties
418 * @brief Called when a property of an object of this type is set.
420 * @param[in] object The object whose property is set.
421 * @param[in] index The property index.
422 * @param[in] value The new property value.
424 static void SetProperty(Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value);
427 * @brief Called to retrieve a property of an object of this type.
429 * @param[in] object The object whose property is to be retrieved.
430 * @param[in] index The property index.
431 * @return The current value of the property.
433 static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
435 private: // From Control
437 * @copydoc Toolkit::Control::OnInitialize()
439 void OnInitialize() override;
442 * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
444 DevelControl::ControlAccessible* CreateAccessibleObject() override;
447 * @copydoc Toolkit::Control::GetNaturalSize
449 Vector3 GetNaturalSize() override;
452 * @copydoc Toolkit::Control::OnKeyEvent()
454 bool OnKeyEvent(const Dali::KeyEvent& event) override;
457 * @copydoc Toolkit::Control::OnKeyInputFocusGained()
459 void OnKeyInputFocusGained() override;
462 * @copydoc Toolkit::Control::OnKeyInputFocusLost()
464 void OnKeyInputFocusLost() override;
467 * @copydoc Toolkit::Control::OnSceneConnection()
469 void OnSceneConnection(int depth) override;
473 WebView(const WebView& webView);
475 WebView& operator=(const WebView& webView);
478 * @brief Set an absolute scroll of the given view.
479 * @param[in] x The coordinate x of scroll
480 * @param[in] y The coordinate y of scroll
482 void SetScrollPosition(int32_t x, int32_t y);
485 * @brief Get the current scroll position of the given view.
486 * @param[out] x The coordinate x of scroll
487 * @param[out] y The coordinate y of scroll
489 Dali::Vector2 GetScrollPosition() const;
492 * @brief Get the possible scroll size of the given view.
493 * @param[out] width The width of scroll size
494 * @param[out] height The height of scroll size
496 Dali::Vector2 GetScrollSize() const;
499 * @brief Get the last known content's size.
500 * @param[out] width The width of content's size
501 * @param[out] height The height of content's size
503 Dali::Vector2 GetContentSize() const;
506 * @brief Return the title of the Web.
508 * @return The title of web page
510 std::string GetTitle() const;
513 * @brief Set the background color of web page.
514 * @param[in] color The value of background color.
516 void SetDocumentBackgroundColor(Dali::Vector4 color);
519 * @brief Clear tiles when hidden.
521 * @param[in] cleared Whether tiles are cleared or not
523 void ClearTilesWhenHidden(bool cleared);
526 * @brief Set multiplier of cover area of tile.
528 * @param[in] multiplier The multiplier of cover area
530 void SetTileCoverAreaMultiplier(float multiplier);
533 * @brief Enable cursor by client.
534 * @param[in] enabled Whether cursor is enabled or not.
536 void EnableCursorByClient(bool enabled);
539 * @brief Get the selected text.
540 * @return The selected text
542 std::string GetSelectedText() const;
545 * @brief Get url of web page.
546 * @return The string of url
548 std::string GetUrl() const;
551 * @brief Get user agent string.
552 * @return The string value of user agent
554 std::string GetUserAgent() const;
557 * @brief Set user agent string.
558 * @param[in] userAgent The string value of user agent
560 void SetUserAgent(const std::string& userAgent);
563 * @brief Set zoom factor of the current page.
564 * @param[in] zoomFactor a new factor to be set.
566 void SetPageZoomFactor(float zoomFactor);
569 * @brief Query the current zoom factor of the page。
570 * @return The current page zoom factor.
572 float GetPageZoomFactor() const;
575 * @brief Set the current text zoom level。.
576 * @param[in] zoomFactor a new factor to be set.
578 void SetTextZoomFactor(float zoomFactor);
581 * @brief Get the current text zoom level.
582 * @return The current text zoom factor.
584 float GetTextZoomFactor() const;
587 * @brief Get the current load progress of the page.
588 * @return The load progress of the page.
590 float GetLoadProgressPercentage() const;
593 * @brief Request to set the current page's visibility.
594 * @param[in] visible Visible or not.
596 * @return true if succeeded, false otherwise
598 bool SetVisibility(bool visible);
601 * @brief Enable/Disable video hole for video playing.
602 * @param[in] enabled True if video hole is enabled, false otherwise.
604 void EnableVideoHole(bool enabled);
607 * @brief Enable blend mode.
608 * @param[in] blendEnabled True if turn on blend mode, false otherwise.
610 void EnableBlendMode(bool blendEnabled);
613 * @brief Enable/disable mouse events. The default is enabled.
615 * @param[in] enabled True if mouse events are enabled, false otherwise
617 void EnableMouseEvents(bool enabled);
620 * @brief Enable/disable key events. The default is enabled.
622 * @param[in] enabled True if key events enabled, false otherwise
624 void EnableKeyEvents(bool enabled);
627 * @brief Create image view by pixel data.
628 * @param[in] pixel Pixel data
629 * @return The new image view
631 Dali::Toolkit::ImageView CreateImageView(Dali::PixelData pixel) const;
634 * @brief Signal occurs when the Web View has been touched.
635 * @param[in] actor The Actor Touched
636 * @param[in] touch The Touch Data.
637 * @return Whether to consume event or not.
639 bool OnTouchEvent(Actor actor, const Dali::TouchEvent& touch);
642 * @brief Signal occurs when the Web View has been hovered.
643 * @param[in] actor The Actor Hovered
644 * @param[in] hover The Hover Data.
645 * @return Whether to consume event or not.
647 bool OnHoverEvent(Actor actor, const Dali::HoverEvent& hover);
650 * @brief Signal occurs when the Web View receives wheel event.
651 * @param[in] actor The Actor that receives Wheel event.
652 * @param[in] wheel The Wheel Data.
653 * @return Whether to consume event or not.
655 bool OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel);
658 * @brief Callback function to be called when frame is rendered.
660 void OnFrameRendered();
663 * @brief Callback for updating display area of web view.
664 * @param[in] source The soource triggers Notification.
666 void OnDisplayAreaUpdated(Dali::PropertyNotification& source);
669 * @brief Callback function to be called when visibility is changed.
670 * @param[in] actor The actor, or child of actor, whose visibility has changed
671 * @param[in] isVisible Whether the actor is now visible or not
672 * @param[in] type, Whether the actor's visible property has changed or a parent's
674 void OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type);
677 * @brief callback for screen shot captured.
678 * @param[in] pixel Pixel data of screen shot.
680 void OnScreenshotCaptured(Dali::PixelData pixel);
683 class WebViewAccessible : public DevelControl::ControlAccessible
686 WebViewAccessible() = delete;
688 WebViewAccessible(Dali::Actor self, Dali::WebEngine& webEngine);
692 * @copydoc Dali::Accessibility::Accessible::GetAttributes()
694 Dali::Accessibility::Attributes GetAttributes() const override;
697 * @copydoc Dali::Accessibility::ActorAccessible::DoGetChildren()
699 void DoGetChildren(std::vector<Dali::Accessibility::Accessible*>& children) override;
702 void OnAccessibilityEnabled();
703 void OnAccessibilityDisabled();
704 void SetRemoteChildAddress(Dali::Accessibility::Address address);
706 Dali::Accessibility::ProxyAccessible mRemoteChild;
707 Dali::WebEngine& mWebEngine;
711 Dali::Toolkit::Visual::Base mVisual;
712 Dali::Size mWebViewSize;
713 Dali::WebEngine mWebEngine;
715 std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
716 std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
718 Dali::PropertyNotification mPositionUpdateNotification;
719 Dali::PropertyNotification mSizeUpdateNotification;
720 Dali::PropertyNotification mScaleUpdateNotification;
721 Dali::Rect<int32_t> mWebViewArea;
722 bool mVideoHoleEnabled;
723 bool mMouseEventsEnabled;
724 bool mKeyEventsEnabled;
726 Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback mScreenshotCapturedCallback;
727 Dali::WebEnginePlugin::WebEngineFrameRenderedCallback mFrameRenderedCallback;
729 static std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>> mPluginWebViewMap;
732 } // namespace Internal
734 inline Toolkit::Internal::WebView& GetImpl(Toolkit::WebView& handle)
736 DALI_ASSERT_ALWAYS(handle);
737 Dali::RefObject& impl = handle.GetImplementation();
738 return static_cast<Toolkit::Internal::WebView&>(impl);
741 inline const Toolkit::Internal::WebView& GetImpl(const Toolkit::WebView& handle)
743 DALI_ASSERT_ALWAYS(handle);
744 const Dali::RefObject& impl = handle.GetImplementation();
745 return static_cast<const Toolkit::Internal::WebView&>(impl);
748 } // namespace Toolkit
752 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H