2 * Copyright (c) 2024 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
19 #include <dali-toolkit/internal/controls/web-view/web-view-impl.h>
22 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-back-forward-list.h>
23 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-certificate.h>
24 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-console-message.h>
25 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-context-menu-item.h>
26 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-context-menu.h>
27 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-context.h>
28 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-cookie-manager.h>
29 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-form-repost-decision.h>
30 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-hit-test.h>
31 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-http-auth-handler.h>
32 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-load-error.h>
33 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-policy-decision.h>
34 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-settings.h>
35 #include <dali/devel-api/adaptor-framework/window-devel.h>
36 #include <dali/devel-api/common/stage.h>
37 #include <dali/devel-api/scripting/enum-helper.h>
38 #include <dali/devel-api/scripting/scripting.h>
39 #include <dali/public-api/adaptor-framework/native-image-source.h>
40 #include <dali/public-api/object/type-registry-helper.h>
41 #include <dali/public-api/object/type-registry.h>
44 #include <dali-toolkit/devel-api/controls/control-depth-index-ranges.h>
45 #include <dali-toolkit/devel-api/controls/control-devel.h>
46 #include <dali-toolkit/devel-api/controls/web-view/web-back-forward-list.h>
47 #include <dali-toolkit/devel-api/controls/web-view/web-settings.h>
48 #include <dali-toolkit/devel-api/visuals/visual-actions-devel.h>
49 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
50 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
51 #include <dali-toolkit/public-api/image-loader/image-url.h>
52 #include <dali-toolkit/public-api/image-loader/image.h>
53 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
57 #include <unordered_map>
69 return Toolkit::WebView::New();
73 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::WebView, Toolkit::Control, Create)
75 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "url", STRING, URL )
76 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "userAgent", STRING, USER_AGENT )
77 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "scrollPosition", VECTOR2, SCROLL_POSITION )
78 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "scrollSize", VECTOR2, SCROLL_SIZE )
79 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "contentSize", VECTOR2, CONTENT_SIZE )
80 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "title", STRING, TITLE )
81 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "videoHoleEnabled", BOOLEAN, VIDEO_HOLE_ENABLED )
82 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "mouseEventsEnabled", BOOLEAN, MOUSE_EVENTS_ENABLED )
83 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "keyEventsEnabled", BOOLEAN, KEY_EVENTS_ENABLED )
84 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "documentBackgroundColor", VECTOR4, DOCUMENT_BACKGROUND_COLOR )
85 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "tilesClearedWhenHidden", BOOLEAN, TILES_CLEARED_WHEN_HIDDEN )
86 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "tileCoverAreaMultiplier", FLOAT, TILE_COVER_AREA_MULTIPLIER)
87 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "cursorEnabledByClient", BOOLEAN, CURSOR_ENABLED_BY_CLIENT )
88 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "selectedText", STRING, SELECTED_TEXT )
89 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "pageZoomFactor", FLOAT, PAGE_ZOOM_FACTOR )
90 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "textZoomFactor", FLOAT, TEXT_ZOOM_FACTOR )
91 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "loadProgressPercentage", FLOAT, LOAD_PROGRESS_PERCENTAGE )
93 DALI_TYPE_REGISTRATION_END()
96 std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>>& GetPluginWebViewTable()
98 static std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>> pluginWebViewMap;
99 return pluginWebViewMap;
102 enum class DisplayAreaCalculateOption
104 PROPERTY = 0, ///< Calculate display update area by property
105 CURRENT_PROPERTY = 1, ///< Calculate display update area by current property
109 * @brief Helper function to calculate exact display area, offset and size.
110 * It will be useful when view size is not integer value, or view size is not matched with texture size.
112 * @param[in] self The view itself.
113 * @param[in] option Option of this calculation. Let we decide what kind of property will be used.
114 * @return DisplayArea for this view.
116 Rect<int32_t> CalculateDisplayArea(Dali::Actor self, DisplayAreaCalculateOption option)
118 bool positionUsesAnchorPoint = self.GetProperty<bool>(Actor::Property::POSITION_USES_ANCHOR_POINT);
119 Vector3 actorSize = (option == DisplayAreaCalculateOption::CURRENT_PROPERTY) ? self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::SCALE)
120 : self.GetProperty<Vector3>(Actor::Property::SIZE) * self.GetProperty<Vector3>(Actor::Property::SCALE);
121 Vector3 anchorPointOffSet = actorSize * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
122 Vector2 screenPosition = (option == DisplayAreaCalculateOption::CURRENT_PROPERTY) ? self.GetProperty<Vector2>(Actor::Property::SCREEN_POSITION)
123 : Dali::DevelActor::CalculateScreenPosition(self);
125 Dali::Rect<int32_t> displayArea;
126 displayArea.x = screenPosition.x - anchorPointOffSet.x;
127 displayArea.y = screenPosition.y - anchorPointOffSet.y;
128 displayArea.width = actorSize.x;
129 displayArea.height = actorSize.y;
134 constexpr Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
137 * @brief Helper function to calculate exact pixel area value by view and texture size.
138 * It will be useful when view size is not integer value, or view size is not matched with texture size.
140 * @param[in] viewSize The size of view.
141 * @param[in] textureWidth The width of texture, that must be integer type.
142 * @param[in] textureHeight The height of texture, that must be integer type.
143 * @return PixelArea value that image visual can use.
145 Vector4 CalculatePixelArea(const Size& viewSize, const uint32_t textureWidth, const uint32_t textureHeight)
147 float widthRatio = textureWidth == 0u ? 1.0f : viewSize.width / static_cast<float>(textureWidth);
148 float heightRatio = textureHeight == 0u ? 1.0f : viewSize.height / static_cast<float>(textureHeight);
149 return Vector4(0.0f, 0.0f, widthRatio, heightRatio);
154 WebView::WebView(const std::string& locale, const std::string& timezoneId)
155 : Control(ControlBehaviour(ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS)),
157 mWebViewSize(Stage::GetCurrent().GetSize()),
159 mLastRenderedNativeImageWidth(0u),
160 mLastRenderedNativeImageHeight(0u),
161 mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
162 mVideoHoleEnabled(false),
163 mMouseEventsEnabled(true),
164 mKeyEventsEnabled(true),
165 mVisualChangeRequired(false),
166 mScreenshotCapturedCallback{nullptr},
167 mFrameRenderedCallback{nullptr}
169 mWebEngine = Dali::WebEngine::New();
171 // WebEngine is empty when it is not properly initialized.
174 mWebEngine.Create(mWebViewSize.width, mWebViewSize.height, locale, timezoneId);
178 WebView::WebView(uint32_t argc, char** argv)
179 : Control(ControlBehaviour(ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS)),
181 mWebViewSize(Stage::GetCurrent().GetSize()),
183 mLastRenderedNativeImageWidth(0u),
184 mLastRenderedNativeImageHeight(0u),
185 mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
186 mVideoHoleEnabled(false),
187 mMouseEventsEnabled(true),
188 mKeyEventsEnabled(true),
189 mVisualChangeRequired(false),
190 mScreenshotCapturedCallback{nullptr},
191 mFrameRenderedCallback{nullptr}
193 mWebEngine = Dali::WebEngine::New();
195 // WebEngine is empty when it is not properly initialized.
198 mWebEngine.Create(mWebViewSize.width, mWebViewSize.height, argc, argv);
211 auto iter = GetPluginWebViewTable().find(mWebEngine.GetPlugin());
212 if(iter != GetPluginWebViewTable().end())
214 GetPluginWebViewTable().erase(iter);
216 mWebEngine.Destroy();
220 Toolkit::WebView WebView::New()
222 WebView* impl = new WebView();
223 Toolkit::WebView handle = Toolkit::WebView(*impl);
224 if(impl->GetPlugin())
226 GetPluginWebViewTable()[impl->GetPlugin()] = handle;
232 Toolkit::WebView WebView::New(const std::string& locale, const std::string& timezoneId)
234 WebView* impl = new WebView(locale, timezoneId);
235 Toolkit::WebView handle = Toolkit::WebView(*impl);
236 if(impl->GetPlugin())
238 GetPluginWebViewTable()[impl->GetPlugin()] = handle;
244 Toolkit::WebView WebView::New(uint32_t argc, char** argv)
246 WebView* impl = new WebView(argc, argv);
247 Toolkit::WebView handle = Toolkit::WebView(*impl);
248 if(impl->GetPlugin())
250 GetPluginWebViewTable()[impl->GetPlugin()] = handle;
256 Toolkit::WebView WebView::FindWebView(Dali::WebEnginePlugin* plugin)
258 auto iter = GetPluginWebViewTable().find(plugin);
259 if(iter != GetPluginWebViewTable().end())
261 return iter->second.GetHandle();
263 return Toolkit::WebView();
266 Dali::WebEngineContext* WebView::GetContext()
268 return Dali::WebEngine::GetContext();
271 Dali::WebEngineCookieManager* WebView::GetCookieManager()
273 return Dali::WebEngine::GetCookieManager();
276 void WebView::OnInitialize()
280 self.SetProperty(Actor::Property::KEYBOARD_FOCUSABLE, true);
281 self.SetProperty(DevelActor::Property::TOUCH_FOCUSABLE, true);
282 self.TouchedSignal().Connect(this, &WebView::OnTouchEvent);
283 self.HoveredSignal().Connect(this, &WebView::OnHoverEvent);
284 self.WheelEventSignal().Connect(this, &WebView::OnWheelEvent);
285 Dali::DevelActor::VisibilityChangedSignal(self).Connect(this, &WebView::OnVisibilityChanged);
287 mWebViewVisibleState |= WebViewVisibleStateFlag::SELF_SHOW;
289 mPositionUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_POSITION, StepCondition(1.0f, 1.0f));
290 mSizeUpdateNotification = self.AddPropertyNotification(Actor::Property::SIZE, StepCondition(1.0f, 1.0f));
291 mScaleUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_SCALE, StepCondition(0.1f, 1.0f));
292 mPositionUpdateNotification.NotifySignal().Connect(this, &WebView::OnDisplayAreaUpdated);
293 mSizeUpdateNotification.NotifySignal().Connect(this, &WebView::OnDisplayAreaUpdated);
294 mScaleUpdateNotification.NotifySignal().Connect(this, &WebView::OnDisplayAreaUpdated);
298 mWebEngine.RegisterFrameRenderedCallback(std::bind(&WebView::OnFrameRendered, this));
299 mWebSettings = std::unique_ptr<Dali::Toolkit::WebSettings>(new WebSettings(mWebEngine.GetSettings()));
300 mWebBackForwardList = std::unique_ptr<Dali::Toolkit::WebBackForwardList>(new WebBackForwardList(mWebEngine.GetBackForwardList()));
303 self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::FILLER);
306 DevelControl::ControlAccessible* WebView::CreateAccessibleObject()
308 return new WebViewAccessible(Self(), mWebEngine);
311 void WebView::OnRelayout(const Vector2& size, RelayoutContainer& container)
318 auto displayArea = CalculateDisplayArea(Self(), DisplayAreaCalculateOption::PROPERTY);
320 SetDisplayArea(displayArea);
323 Dali::Toolkit::WebSettings* WebView::GetSettings() const
325 return mWebSettings.get();
328 Dali::Toolkit::WebBackForwardList* WebView::GetBackForwardList() const
330 return mWebBackForwardList.get();
333 Dali::WebEnginePlugin* WebView::GetPlugin() const
335 return mWebEngine ? mWebEngine.GetPlugin() : nullptr;
338 Dali::Toolkit::ImageView WebView::GetFavicon() const
340 Dali::Toolkit::ImageView faviconView;
343 Dali::PixelData pixelData = mWebEngine.GetFavicon();
344 faviconView = CreateImageView(pixelData);
349 void WebView::LoadUrl(const std::string& url)
353 mWebEngine.LoadUrl(url);
357 void WebView::LoadHtmlString(const std::string& htmlString)
361 mWebEngine.LoadHtmlString(htmlString);
365 bool WebView::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
370 return mWebEngine.LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
373 bool WebView::LoadContents(const int8_t* contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
378 return mWebEngine.LoadContents(contents, contentSize, mimeType, encoding, baseUri);
381 void WebView::Reload()
389 bool WebView::ReloadWithoutCache()
391 return mWebEngine ? mWebEngine.ReloadWithoutCache() : false;
394 void WebView::StopLoading()
398 mWebEngine.StopLoading();
402 void WebView::Suspend()
406 mWebEngine.Suspend();
410 void WebView::Resume()
418 void WebView::SuspendNetworkLoading()
422 mWebEngine.SuspendNetworkLoading();
426 void WebView::ResumeNetworkLoading()
430 mWebEngine.ResumeNetworkLoading();
434 bool WebView::AddCustomHeader(const std::string& name, const std::string& value)
436 return mWebEngine ? mWebEngine.AddCustomHeader(name, value) : false;
439 bool WebView::RemoveCustomHeader(const std::string& name)
441 return mWebEngine ? mWebEngine.RemoveCustomHeader(name) : false;
444 uint32_t WebView::StartInspectorServer(uint32_t port)
446 return mWebEngine ? mWebEngine.StartInspectorServer(port) : false;
449 bool WebView::StopInspectorServer()
451 return mWebEngine ? mWebEngine.StopInspectorServer() : false;
454 void WebView::ScrollBy(int32_t deltaX, int32_t deltaY)
458 mWebEngine.ScrollBy(deltaX, deltaY);
462 bool WebView::ScrollEdgeBy(int32_t deltaX, int32_t deltaY)
464 return mWebEngine ? mWebEngine.ScrollEdgeBy(deltaX, deltaY) : false;
467 bool WebView::CanGoForward()
469 return mWebEngine ? mWebEngine.CanGoForward() : false;
472 void WebView::GoForward()
476 mWebEngine.GoForward();
480 bool WebView::CanGoBack()
482 return mWebEngine ? mWebEngine.CanGoBack() : false;
485 void WebView::GoBack()
493 void WebView::EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler)
497 mWebEngine.EvaluateJavaScript(script, std::move(resultHandler));
501 void WebView::AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler)
505 mWebEngine.AddJavaScriptMessageHandler(exposedObjectName, std::move(handler));
509 void WebView::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
513 mWebEngine.RegisterJavaScriptAlertCallback(std::move(callback));
517 void WebView::JavaScriptAlertReply()
521 mWebEngine.JavaScriptAlertReply();
525 void WebView::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
529 mWebEngine.RegisterJavaScriptConfirmCallback(std::move(callback));
533 void WebView::JavaScriptConfirmReply(bool confirmed)
537 mWebEngine.JavaScriptConfirmReply(confirmed);
541 void WebView::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
545 mWebEngine.RegisterJavaScriptPromptCallback(std::move(callback));
549 void WebView::JavaScriptPromptReply(const std::string& result)
553 mWebEngine.JavaScriptPromptReply(result);
557 std::unique_ptr<Dali::WebEngineHitTest> WebView::CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode)
559 std::unique_ptr<Dali::WebEngineHitTest> webHitTest;
565 return mWebEngine.CreateHitTest(x, y, mode);
568 bool WebView::CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback)
573 result = mWebEngine.CreateHitTestAsynchronously(x, y, mode, std::move(callback));
578 void WebView::ClearHistory()
582 mWebEngine.ClearHistory();
586 void WebView::ClearAllTilesResources()
590 mWebEngine.ClearAllTilesResources();
594 void WebView::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
598 mWebEngine.SetScaleFactor(scaleFactor, point);
602 float WebView::GetScaleFactor() const
604 return mWebEngine ? mWebEngine.GetScaleFactor() : 0.0f;
607 void WebView::ActivateAccessibility(bool activated)
611 mWebEngine.ActivateAccessibility(activated);
615 bool WebView::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
617 return mWebEngine ? mWebEngine.HighlightText(text, options, maxMatchCount) : false;
620 void WebView::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
624 mWebEngine.AddDynamicCertificatePath(host, certPath);
628 Dali::Toolkit::ImageView WebView::GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor)
630 Dali::Toolkit::ImageView imageView;
633 Dali::PixelData pixelData = mWebEngine.GetScreenshot(viewArea, scaleFactor);
634 imageView = CreateImageView(pixelData);
639 bool WebView::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback)
641 mScreenshotCapturedCallback = std::move(callback);
642 return mWebEngine ? mWebEngine.GetScreenshotAsynchronously(viewArea, scaleFactor, std::bind(&WebView::OnScreenshotCaptured, this, std::placeholders::_1)) : false;
645 bool WebView::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
647 return mWebEngine ? mWebEngine.CheckVideoPlayingAsynchronously(std::move(callback)) : false;
650 void WebView::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
654 mWebEngine.RegisterGeolocationPermissionCallback(std::move(callback));
658 void WebView::SetTtsFocus(bool focused)
660 if(mWebEngine && !HasKeyInputFocus())
662 mWebEngine.SetFocus(focused);
666 void WebView::EnableVideoHole(bool enabled)
668 mVideoHoleEnabled = enabled;
670 EnableBlendMode(!mVideoHoleEnabled);
674 mWebEngine.EnableVideoHole(mVideoHoleEnabled);
678 void WebView::EnableBlendMode(bool blendEnabled)
681 for(uint32_t i = 0; i < self.GetRendererCount(); i++)
683 Dali::Renderer render = self.GetRendererAt(i);
684 render.SetProperty(Renderer::Property::BLEND_MODE, blendEnabled ? BlendMode::ON : BlendMode::OFF);
688 Dali::Toolkit::ImageView WebView::CreateImageView(Dali::PixelData pixel) const
692 return Dali::Toolkit::ImageView();
695 Dali::Toolkit::ImageUrl url = Dali::Toolkit::Image::GenerateUrl(pixel);
696 Dali::Toolkit::ImageView imageView = Dali::Toolkit::ImageView::New(url.GetUrl());
697 imageView.SetProperty(Dali::Actor::Property::SIZE, Vector2(pixel.GetWidth(), pixel.GetHeight()));
701 void WebView::RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
705 mWebEngine.RegisterPageLoadStartedCallback(std::move(callback));
709 void WebView::RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
713 mWebEngine.RegisterPageLoadInProgressCallback(std::move(callback));
717 void WebView::RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
721 mWebEngine.RegisterPageLoadFinishedCallback(std::move(callback));
725 void WebView::RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback)
729 mWebEngine.RegisterPageLoadErrorCallback(std::move(callback));
733 void WebView::RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback)
737 mWebEngine.RegisterScrollEdgeReachedCallback(std::move(callback));
741 void WebView::RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback)
745 mWebEngine.RegisterUrlChangedCallback(std::move(callback));
749 void WebView::RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback)
753 mWebEngine.RegisterFormRepostDecidedCallback(std::move(callback));
757 void WebView::RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback)
759 mFrameRenderedCallback = std::move(callback);
762 void WebView::RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback)
766 mWebEngine.RegisterConsoleMessageReceivedCallback(std::move(callback));
770 void WebView::RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback)
774 mWebEngine.RegisterResponsePolicyDecidedCallback(std::move(callback));
778 void WebView::RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback)
782 mWebEngine.RegisterNavigationPolicyDecidedCallback(std::move(callback));
786 void WebView::RegisterNewWindowCreatedCallback(Dali::WebEnginePlugin::WebEngineNewWindowCreatedCallback callback)
790 mWebEngine.RegisterNewWindowCreatedCallback(std::move(callback));
794 void WebView::RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
798 mWebEngine.RegisterCertificateConfirmedCallback(std::move(callback));
802 void WebView::RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
806 mWebEngine.RegisterSslCertificateChangedCallback(std::move(callback));
810 void WebView::RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback)
814 mWebEngine.RegisterHttpAuthHandlerCallback(std::move(callback));
818 void WebView::RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback)
822 mWebEngine.RegisterContextMenuShownCallback(std::move(callback));
826 void WebView::RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback)
830 mWebEngine.RegisterContextMenuHiddenCallback(std::move(callback));
834 void WebView::GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback)
838 mWebEngine.GetPlainTextAsynchronously(std::move(callback));
842 void WebView::OnFrameRendered()
844 if(mFrameRenderedCallback)
846 mFrameRenderedCallback();
849 // Make sure that mVisual is created only if required.
850 if(mVisualChangeRequired || !mVisual)
853 mVisualChangeRequired = false;
855 auto nativeImageSourcePtr = mWebEngine.GetNativeImageSource();
857 mLastRenderedNativeImageWidth = nativeImageSourcePtr->GetWidth();
858 mLastRenderedNativeImageHeight = nativeImageSourcePtr->GetHeight();
860 Dali::Toolkit::ImageUrl nativeImageUrl = Dali::Toolkit::Image::GenerateUrl(nativeImageSourcePtr);
862 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
863 {{Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE},
864 {Toolkit::ImageVisual::Property::URL, nativeImageUrl.GetUrl()},
865 {Toolkit::ImageVisual::Property::PIXEL_AREA, FULL_TEXTURE_RECT},
866 {Toolkit::ImageVisual::Property::WRAP_MODE_U, Dali::WrapMode::CLAMP_TO_EDGE},
867 {Toolkit::ImageVisual::Property::WRAP_MODE_V, Dali::WrapMode::CLAMP_TO_EDGE}});
871 DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual, DepthIndex::CONTENT);
872 EnableBlendMode(!mVideoHoleEnabled);
877 void WebView::OnDisplayAreaUpdated(Dali::PropertyNotification& /*source*/)
884 auto displayArea = CalculateDisplayArea(Self(), DisplayAreaCalculateOption::CURRENT_PROPERTY);
886 SetDisplayArea(displayArea);
889 void WebView::OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type)
891 if(type == Dali::DevelActor::VisibilityChange::Type::SELF)
895 mWebViewVisibleState |= WebViewVisibleStateFlag::SELF_SHOW;
899 mWebViewVisibleState &= ~WebViewVisibleStateFlag::SELF_SHOW;
902 else if(type == Dali::DevelActor::VisibilityChange::Type::PARENT)
906 mWebViewVisibleState |= WebViewVisibleStateFlag::PARENT_SHOW;
907 // TODO : We should consider double-hide called from parent
911 mWebViewVisibleState &= ~WebViewVisibleStateFlag::PARENT_SHOW;
914 ApplyVisibilityCheck();
917 void WebView::OnWindowVisibilityChanged(Window window, bool visible)
921 mWebViewVisibleState |= WebViewVisibleStateFlag::WINDOW_SHOW;
925 mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
927 ApplyVisibilityCheck();
930 void WebView::OnScreenshotCaptured(Dali::PixelData pixel)
932 if(mScreenshotCapturedCallback)
934 Dali::Toolkit::ImageView imageView = CreateImageView(pixel);
935 mScreenshotCapturedCallback(imageView);
939 void WebView::SetDisplayArea(const Dali::Rect<int32_t>& displayArea)
941 Size displaySize = Size(displayArea.width, displayArea.height);
942 if(mWebViewSize != displaySize)
944 mWebViewSize = displaySize;
947 if(mWebViewArea != displayArea)
949 // WebEngine visual size changed. we have to re-create visual.
950 mVisualChangeRequired = true;
952 // Change old visual's pixel area matched as changed web view size
955 auto pixelArea = CalculatePixelArea(mWebViewSize, mLastRenderedNativeImageWidth, mLastRenderedNativeImageHeight);
956 Toolkit::GetImplementation(mVisual).DoAction(Toolkit::DevelVisual::Action::UPDATE_PROPERTY, {{Toolkit::ImageVisual::Property::PIXEL_AREA, pixelArea}});
959 mWebViewArea = displayArea;
960 mWebEngine.UpdateDisplayArea(mWebViewArea);
964 void WebView::OnSceneConnection(int depth)
966 mWebViewVisibleState |= WebViewVisibleStateFlag::SCENE_ON;
967 mWebViewVisibleState |= WebViewVisibleStateFlag::PARENT_SHOW;
968 // TODO : We should consider already hided parent
969 Window window = DevelWindow::Get(Self());
972 // Hold the weak handle of the placement window.
973 mPlacementWindow = window;
974 if(window.IsVisible())
976 mWebViewVisibleState |= WebViewVisibleStateFlag::WINDOW_SHOW;
980 mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
982 DevelWindow::VisibilityChangedSignal(window).Connect(this, &WebView::OnWindowVisibilityChanged);
984 ApplyVisibilityCheck();
985 Control::OnSceneConnection(depth);
986 EnableBlendMode(!mVideoHoleEnabled);
989 void WebView::OnSceneDisconnection()
991 mWebViewVisibleState &= ~WebViewVisibleStateFlag::SCENE_ON;
992 mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
993 mWebViewVisibleState &= ~WebViewVisibleStateFlag::PARENT_SHOW;
994 Window window = mPlacementWindow.GetHandle();
997 DevelWindow::VisibilityChangedSignal(window).Disconnect(this, &WebView::OnWindowVisibilityChanged);
998 mPlacementWindow.Reset();
1000 ApplyVisibilityCheck();
1001 Control::OnSceneDisconnection();
1004 bool WebView::OnTouchEvent(Actor actor, const Dali::TouchEvent& touch)
1006 bool result = false;
1010 result = mWebEngine.SendTouchEvent(touch);
1015 bool WebView::OnKeyEvent(const Dali::KeyEvent& event)
1017 bool result = false;
1021 result = mWebEngine.SendKeyEvent(event);
1026 bool WebView::OnHoverEvent(Actor actor, const Dali::HoverEvent& hover)
1028 bool result = false;
1029 if(mWebEngine && mMouseEventsEnabled)
1031 result = mWebEngine.SendHoverEvent(hover);
1036 bool WebView::OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel)
1038 bool result = false;
1039 if(mWebEngine && mMouseEventsEnabled)
1041 result = mWebEngine.SendWheelEvent(wheel);
1046 void WebView::OnKeyInputFocusGained()
1050 mWebEngine.SetFocus(true);
1053 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
1056 void WebView::OnKeyInputFocusLost()
1060 mWebEngine.SetFocus(false);
1063 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
1066 Vector3 WebView::GetNaturalSize()
1070 Vector2 rendererNaturalSize;
1071 mVisual.GetNaturalSize(rendererNaturalSize);
1072 return Vector3(rendererNaturalSize);
1075 return Vector3(mWebViewSize);
1078 void WebView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
1080 Toolkit::WebView webView = Toolkit::WebView::DownCast(Dali::BaseHandle(object));
1084 WebView& impl = GetImpl(webView);
1087 case Toolkit::WebView::Property::URL:
1096 case Toolkit::WebView::Property::USER_AGENT:
1099 if(value.Get(input))
1101 impl.SetUserAgent(input);
1105 case Toolkit::WebView::Property::SCROLL_POSITION:
1108 if(value.Get(input))
1110 impl.SetScrollPosition(input.x, input.y);
1114 case Toolkit::WebView::Property::VIDEO_HOLE_ENABLED:
1117 if(value.Get(input))
1119 impl.EnableVideoHole(input);
1123 case Toolkit::WebView::Property::MOUSE_EVENTS_ENABLED:
1126 if(value.Get(input))
1128 impl.EnableMouseEvents(input);
1132 case Toolkit::WebView::Property::KEY_EVENTS_ENABLED:
1135 if(value.Get(input))
1137 impl.EnableKeyEvents(input);
1141 case Toolkit::WebView::Property::DOCUMENT_BACKGROUND_COLOR:
1144 if(value.Get(input))
1146 impl.SetDocumentBackgroundColor(input);
1150 case Toolkit::WebView::Property::TILES_CLEARED_WHEN_HIDDEN:
1153 if(value.Get(input))
1155 impl.ClearTilesWhenHidden(input);
1159 case Toolkit::WebView::Property::TILE_COVER_AREA_MULTIPLIER:
1162 if(value.Get(input))
1164 impl.SetTileCoverAreaMultiplier(input);
1168 case Toolkit::WebView::Property::CURSOR_ENABLED_BY_CLIENT:
1171 if(value.Get(input))
1173 impl.EnableCursorByClient(input);
1177 case Toolkit::WebView::Property::PAGE_ZOOM_FACTOR:
1180 if(value.Get(input))
1182 impl.SetPageZoomFactor(input);
1186 case Toolkit::WebView::Property::TEXT_ZOOM_FACTOR:
1189 if(value.Get(input))
1191 impl.SetTextZoomFactor(input);
1201 Property::Value WebView::GetProperty(BaseObject* object, Property::Index propertyIndex)
1203 Property::Value value;
1205 Toolkit::WebView webView = Toolkit::WebView::DownCast(Dali::BaseHandle(object));
1209 WebView& impl = GetImpl(webView);
1210 switch(propertyIndex)
1212 case Toolkit::WebView::Property::URL:
1214 value = impl.GetUrl();
1217 case Toolkit::WebView::Property::USER_AGENT:
1219 value = impl.GetUserAgent();
1222 case Toolkit::WebView::Property::SCROLL_POSITION:
1224 value = impl.GetScrollPosition();
1227 case Toolkit::WebView::Property::SCROLL_SIZE:
1229 value = impl.GetScrollSize();
1232 case Toolkit::WebView::Property::CONTENT_SIZE:
1234 value = impl.GetContentSize();
1237 case Toolkit::WebView::Property::TITLE:
1239 value = impl.GetTitle();
1242 case Toolkit::WebView::Property::VIDEO_HOLE_ENABLED:
1244 value = impl.mVideoHoleEnabled;
1247 case Toolkit::WebView::Property::MOUSE_EVENTS_ENABLED:
1249 value = impl.mMouseEventsEnabled;
1252 case Toolkit::WebView::Property::KEY_EVENTS_ENABLED:
1254 value = impl.mKeyEventsEnabled;
1257 case Toolkit::WebView::Property::SELECTED_TEXT:
1259 value = impl.GetSelectedText();
1262 case Toolkit::WebView::Property::PAGE_ZOOM_FACTOR:
1264 value = impl.GetPageZoomFactor();
1267 case Toolkit::WebView::Property::TEXT_ZOOM_FACTOR:
1269 value = impl.GetTextZoomFactor();
1272 case Toolkit::WebView::Property::LOAD_PROGRESS_PERCENTAGE:
1274 value = impl.GetLoadProgressPercentage();
1285 void WebView::SetScrollPosition(int32_t x, int32_t y)
1289 mWebEngine.SetScrollPosition(x, y);
1293 Dali::Vector2 WebView::GetScrollPosition() const
1295 return mWebEngine ? mWebEngine.GetScrollPosition() : Dali::Vector2::ZERO;
1298 Dali::Vector2 WebView::GetScrollSize() const
1300 return mWebEngine ? mWebEngine.GetScrollSize() : Dali::Vector2::ZERO;
1303 Dali::Vector2 WebView::GetContentSize() const
1305 return mWebEngine ? mWebEngine.GetContentSize() : Dali::Vector2::ZERO;
1308 std::string WebView::GetTitle() const
1310 return mWebEngine ? mWebEngine.GetTitle() : std::string();
1313 void WebView::SetDocumentBackgroundColor(Dali::Vector4 color)
1317 mWebEngine.SetDocumentBackgroundColor(color);
1321 void WebView::ClearTilesWhenHidden(bool cleared)
1325 mWebEngine.ClearTilesWhenHidden(cleared);
1329 void WebView::SetTileCoverAreaMultiplier(float multiplier)
1333 mWebEngine.SetTileCoverAreaMultiplier(multiplier);
1337 void WebView::EnableCursorByClient(bool enabled)
1341 mWebEngine.EnableCursorByClient(enabled);
1345 std::string WebView::GetSelectedText() const
1347 return mWebEngine ? mWebEngine.GetSelectedText() : std::string();
1350 std::string WebView::GetUrl() const
1352 return mWebEngine ? mWebEngine.GetUrl() : std::string();
1355 std::string WebView::GetUserAgent() const
1357 return mWebEngine ? mWebEngine.GetUserAgent() : std::string();
1360 void WebView::SetUserAgent(const std::string& userAgent)
1364 mWebEngine.SetUserAgent(userAgent);
1368 void WebView::EnableMouseEvents(bool enabled)
1372 mMouseEventsEnabled = enabled;
1373 mWebEngine.EnableMouseEvents(enabled);
1377 void WebView::EnableKeyEvents(bool enabled)
1381 mKeyEventsEnabled = enabled;
1382 mWebEngine.EnableKeyEvents(enabled);
1386 void WebView::SetPageZoomFactor(float zoomFactor)
1390 mWebEngine.SetPageZoomFactor(zoomFactor);
1394 float WebView::GetPageZoomFactor() const
1396 return mWebEngine ? mWebEngine.GetPageZoomFactor() : 0.0f;
1399 void WebView::SetTextZoomFactor(float zoomFactor)
1403 mWebEngine.SetTextZoomFactor(zoomFactor);
1407 float WebView::GetTextZoomFactor() const
1409 return mWebEngine ? mWebEngine.GetTextZoomFactor() : 0.0f;
1412 float WebView::GetLoadProgressPercentage() const
1414 return mWebEngine ? mWebEngine.GetLoadProgressPercentage() : 0.0f;
1417 bool WebView::SetVisibility(bool visible)
1419 return mWebEngine ? mWebEngine.SetVisibility(visible) : false;
1422 void WebView::ApplyVisibilityCheck()
1424 SetVisibility(mWebViewVisibleState == WebViewVisibleStateFlag::VISIBLE);
1427 WebView::WebViewAccessible::WebViewAccessible(Dali::Actor self, Dali::WebEngine& webEngine)
1428 : ControlAccessible(self),
1430 mWebEngine{webEngine}
1432 mRemoteChild.SetParent(this);
1434 Dali::Accessibility::Bridge::EnabledSignal().Connect(this, &WebViewAccessible::OnAccessibilityEnabled);
1435 Dali::Accessibility::Bridge::DisabledSignal().Connect(this, &WebViewAccessible::OnAccessibilityDisabled);
1437 if(Dali::Accessibility::IsUp())
1439 OnAccessibilityEnabled();
1443 OnAccessibilityDisabled();
1447 Dali::Accessibility::Attributes WebView::WebViewAccessible::GetAttributes() const
1449 auto attributes = DevelControl::ControlAccessible::GetAttributes();
1451 if(mRemoteChild.GetAddress())
1453 attributes.insert_or_assign("child_bus", mRemoteChild.GetAddress().GetBus());
1459 void WebView::WebViewAccessible::DoGetChildren(std::vector<Dali::Accessibility::Accessible*>& children)
1461 if(mRemoteChild.GetAddress())
1463 // DoGetChildren is called at most once per every OnChildrenChanged.
1464 // We have only one OnChildrenChanged in this case, so EmbedAtkSocket will be called only once.
1465 Accessibility::Bridge::GetCurrentBridge()->EmbedAtkSocket(GetAddress(), mRemoteChild.GetAddress());
1466 children.push_back(&mRemoteChild);
1470 void WebView::WebViewAccessible::OnAccessibilityEnabled()
1477 mWebEngine.ActivateAccessibility(true);
1478 SetRemoteChildAddress(mWebEngine.GetAccessibilityAddress());
1481 void WebView::WebViewAccessible::OnAccessibilityDisabled()
1488 SetRemoteChildAddress({});
1489 mWebEngine.ActivateAccessibility(false);
1492 void WebView::WebViewAccessible::SetRemoteChildAddress(Dali::Accessibility::Address address)
1494 mRemoteChild.SetAddress(address);
1495 OnChildrenChanged();
1498 } // namespace Internal
1500 } // namespace Toolkit