1 #ifndef DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
5 * Copyright (c) 2023 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 int8_t* 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::ExitFullscreen()
319 void ExitFullscreen();
322 * @copydoc Dali::Toolkit::WebView::RegisterGeolocationPermissionCallback()
324 void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
327 * @copydoc Dali::Toolkit::WebView::SetTtsFocus()
329 void SetTtsFocus(bool focused);
332 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadStartedCallback()
334 void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
337 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadInProgressCallback()
339 void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
342 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadFinishedCallback()
344 void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
347 * @copydoc Dali::Toolkit::WebView::RegisterPageLoadErrorCallback()
349 void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
352 * @copydoc Dali::Toolkit::WebView::RegisterScrollEdgeReachedCallback()
354 void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
357 * @copydoc Dali::Toolkit::WebView::RegisterUrlChangedCallback()
359 void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback);
362 * @copydoc Dali::Toolkit::WebView::RegisterFormRepostDecidedCallback()
364 void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback);
367 * @copydoc Dali::Toolkit::WebView::RegisterFrameRenderedCallback()
369 void RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback);
372 * @copydoc Dali::Toolkit::WebView::RegisterConsoleMessageReceivedCallback()
374 void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback);
377 * @copydoc Dali::Toolkit::WebView::RegisterResponsePolicyDecidedCallback()
379 void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback);
382 * @copydoc Dali::Toolkit::WebView::RegisterNavigationPolicyDecidedCallback()
384 void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback);
387 * @copydoc Dali::Toolkit::WebView::RegisterNewWindowPolicyDecidedCallback()
389 void RegisterNewWindowPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNewWindowPolicyDecidedCallback callback);
392 * @copydoc Dali::Toolkit::WebView::RegisterNewWindowCreatedCallback()
394 void RegisterNewWindowCreatedCallback(Dali::WebEnginePlugin::WebEngineNewWindowCreatedCallback callback);
397 * @copydoc Dali::Toolkit::WebView::RegisterCertificateConfirmedCallback()
399 void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
402 * @copydoc Dali::Toolkit::WebView::RegisterSslCertificateChangedCallback()
404 void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
407 * @copydoc Dali::Toolkit::WebView::RegisterHttpAuthHandlerCallback()
409 void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback);
412 * @copydoc Dali::Toolkit::WebView::RegisterContextMenuShownCallback()
414 void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback);
417 * @copydoc Dali::Toolkit::WebView::RegisterContextMenuHiddenCallback()
419 void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback);
422 * @copydoc Dali::Toolkit::WebView::RegisterFullscreenEnteredCallback()
424 void RegisterFullscreenEnteredCallback(Dali::WebEnginePlugin::WebEngineFullscreenEnteredCallback callback);
427 * @copydoc Dali::Toolkit::WebView::RegisterFullscreenExitedCallback()
429 void RegisterFullscreenExitedCallback(Dali::WebEnginePlugin::WebEngineFullscreenExitedCallback callback);
432 * @copydoc Dali::Toolkit::WebView::RegisterTextFoundCallback()
434 void RegisterTextFoundCallback(Dali::WebEnginePlugin::WebEngineTextFoundCallback callback);
437 * @copydoc Dali::Toolkit::WebView::GetPlainTextAsynchronously()
439 void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
441 public: // Properties
443 * @brief Called when a property of an object of this type is set.
445 * @param[in] object The object whose property is set.
446 * @param[in] index The property index.
447 * @param[in] value The new property value.
449 static void SetProperty(Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value);
452 * @brief Called to retrieve a property of an object of this type.
454 * @param[in] object The object whose property is to be retrieved.
455 * @param[in] index The property index.
456 * @return The current value of the property.
458 static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
460 private: // From Control
462 * @copydoc Toolkit::Control::OnInitialize()
464 void OnInitialize() override;
467 * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
469 DevelControl::ControlAccessible* CreateAccessibleObject() override;
472 * @copydoc Toolkit::Control::GetNaturalSize
474 Vector3 GetNaturalSize() override;
477 * @copydoc Toolkit::Control::OnKeyEvent()
479 bool OnKeyEvent(const Dali::KeyEvent& event) override;
482 * @copydoc Toolkit::Control::OnKeyInputFocusGained()
484 void OnKeyInputFocusGained() override;
487 * @copydoc Toolkit::Control::OnKeyInputFocusLost()
489 void OnKeyInputFocusLost() override;
492 * @copydoc Toolkit::Control::OnSceneConnection()
494 void OnSceneConnection(int depth) override;
498 WebView(const WebView& webView);
500 WebView& operator=(const WebView& webView);
503 * @brief Set an absolute scroll of the given view.
504 * @param[in] x The coordinate x of scroll
505 * @param[in] y The coordinate y of scroll
507 void SetScrollPosition(int32_t x, int32_t y);
510 * @brief Get the current scroll position of the given view.
511 * @param[out] x The coordinate x of scroll
512 * @param[out] y The coordinate y of scroll
514 Dali::Vector2 GetScrollPosition() const;
517 * @brief Get the possible scroll size of the given view.
518 * @param[out] width The width of scroll size
519 * @param[out] height The height of scroll size
521 Dali::Vector2 GetScrollSize() const;
524 * @brief Get the last known content's size.
525 * @param[out] width The width of content's size
526 * @param[out] height The height of content's size
528 Dali::Vector2 GetContentSize() const;
531 * @brief Return the title of the Web.
533 * @return The title of web page
535 std::string GetTitle() const;
538 * @brief Set the background color of web page.
539 * @param[in] color The value of background color.
541 void SetDocumentBackgroundColor(Dali::Vector4 color);
544 * @brief Clear tiles when hidden.
546 * @param[in] cleared Whether tiles are cleared or not
548 void ClearTilesWhenHidden(bool cleared);
551 * @brief Set multiplier of cover area of tile.
553 * @param[in] multiplier The multiplier of cover area
555 void SetTileCoverAreaMultiplier(float multiplier);
558 * @brief Enable cursor by client.
559 * @param[in] enabled Whether cursor is enabled or not.
561 void EnableCursorByClient(bool enabled);
564 * @brief Get the selected text.
565 * @return The selected text
567 std::string GetSelectedText() const;
570 * @brief Get url of web page.
571 * @return The string of url
573 std::string GetUrl() const;
576 * @brief Get user agent string.
577 * @return The string value of user agent
579 std::string GetUserAgent() const;
582 * @brief Set user agent string.
583 * @param[in] userAgent The string value of user agent
585 void SetUserAgent(const std::string& userAgent);
588 * @brief Set zoom factor of the current page.
589 * @param[in] zoomFactor a new factor to be set.
591 void SetPageZoomFactor(float zoomFactor);
594 * @brief Query the current zoom factor of the page。
595 * @return The current page zoom factor.
597 float GetPageZoomFactor() const;
600 * @brief Set the current text zoom level。.
601 * @param[in] zoomFactor a new factor to be set.
603 void SetTextZoomFactor(float zoomFactor);
606 * @brief Get the current text zoom level.
607 * @return The current text zoom factor.
609 float GetTextZoomFactor() const;
612 * @brief Get the current load progress of the page.
613 * @return The load progress of the page.
615 float GetLoadProgressPercentage() const;
618 * @brief Request to set the current page's visibility.
619 * @param[in] visible Visible or not.
621 * @return true if succeeded, false otherwise
623 bool SetVisibility(bool visible);
626 * @brief Enable/Disable video hole for video playing.
627 * @param[in] enabled True if video hole is enabled, false otherwise.
629 void EnableVideoHole(bool enabled);
632 * @brief Enable blend mode.
633 * @param[in] blendEnabled True if turn on blend mode, false otherwise.
635 void EnableBlendMode(bool blendEnabled);
638 * @brief Enable/disable mouse events. The default is enabled.
640 * @param[in] enabled True if mouse events are enabled, false otherwise
642 void EnableMouseEvents(bool enabled);
645 * @brief Enable/disable key events. The default is enabled.
647 * @param[in] enabled True if key events enabled, false otherwise
649 void EnableKeyEvents(bool enabled);
652 * @brief Create image view by pixel data.
653 * @param[in] pixel Pixel data
654 * @return The new image view
656 Dali::Toolkit::ImageView CreateImageView(Dali::PixelData pixel) const;
659 * @brief Signal occurs when the Web View has been touched.
660 * @param[in] actor The Actor Touched
661 * @param[in] touch The Touch Data.
662 * @return Whether to consume event or not.
664 bool OnTouchEvent(Actor actor, const Dali::TouchEvent& touch);
667 * @brief Signal occurs when the Web View has been hovered.
668 * @param[in] actor The Actor Hovered
669 * @param[in] hover The Hover Data.
670 * @return Whether to consume event or not.
672 bool OnHoverEvent(Actor actor, const Dali::HoverEvent& hover);
675 * @brief Signal occurs when the Web View receives wheel event.
676 * @param[in] actor The Actor that receives Wheel event.
677 * @param[in] wheel The Wheel Data.
678 * @return Whether to consume event or not.
680 bool OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel);
683 * @brief Callback function to be called when frame is rendered.
685 void OnFrameRendered();
688 * @brief Callback for updating display area of web view.
689 * @param[in] source The soource triggers Notification.
691 void OnDisplayAreaUpdated(Dali::PropertyNotification& source);
694 * @brief Callback function to be called when visibility is changed.
695 * @param[in] actor The actor, or child of actor, whose visibility has changed
696 * @param[in] isVisible Whether the actor is now visible or not
697 * @param[in] type, Whether the actor's visible property has changed or a parent's
699 void OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type);
702 * @brief callback for screen shot captured.
703 * @param[in] pixel Pixel data of screen shot.
705 void OnScreenshotCaptured(Dali::PixelData pixel);
708 class WebViewAccessible : public DevelControl::ControlAccessible
711 WebViewAccessible() = delete;
713 WebViewAccessible(Dali::Actor self, Dali::WebEngine& webEngine);
717 * @copydoc Dali::Accessibility::Accessible::GetAttributes()
719 Dali::Accessibility::Attributes GetAttributes() const override;
722 * @copydoc Dali::Accessibility::ActorAccessible::DoGetChildren()
724 void DoGetChildren(std::vector<Dali::Accessibility::Accessible*>& children) override;
727 void OnAccessibilityEnabled();
728 void OnAccessibilityDisabled();
729 void SetRemoteChildAddress(Dali::Accessibility::Address address);
731 Dali::Accessibility::ProxyAccessible mRemoteChild;
732 Dali::WebEngine& mWebEngine;
736 Dali::Toolkit::Visual::Base mVisual;
737 Dali::Size mWebViewSize;
738 Dali::WebEngine mWebEngine;
740 std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
741 std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
743 Dali::PropertyNotification mPositionUpdateNotification;
744 Dali::PropertyNotification mSizeUpdateNotification;
745 Dali::PropertyNotification mScaleUpdateNotification;
746 Dali::Rect<int32_t> mWebViewArea;
747 bool mVideoHoleEnabled;
748 bool mMouseEventsEnabled;
749 bool mKeyEventsEnabled;
751 Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback mScreenshotCapturedCallback;
752 Dali::WebEnginePlugin::WebEngineFrameRenderedCallback mFrameRenderedCallback;
754 Vector4 mCornerRadius; /// < Corner radius
755 float mCornerRadiusPolicy; /// < Corner radius policy
756 static std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>> mPluginWebViewMap;
759 } // namespace Internal
761 inline Toolkit::Internal::WebView& GetImpl(Toolkit::WebView& handle)
763 DALI_ASSERT_ALWAYS(handle);
764 Dali::RefObject& impl = handle.GetImplementation();
765 return static_cast<Toolkit::Internal::WebView&>(impl);
768 inline const Toolkit::Internal::WebView& GetImpl(const Toolkit::WebView& handle)
770 DALI_ASSERT_ALWAYS(handle);
771 const Dali::RefObject& impl = handle.GetImplementation();
772 return static_cast<const Toolkit::Internal::WebView&>(impl);
775 } // namespace Toolkit
779 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H