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-devel.h>
45 #include <dali-toolkit/devel-api/controls/web-view/web-back-forward-list.h>
46 #include <dali-toolkit/devel-api/controls/web-view/web-settings.h>
47 #include <dali-toolkit/devel-api/visuals/visual-actions-devel.h>
48 #include <dali-toolkit/internal/visuals/visual-base-impl.h>
49 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
50 #include <dali-toolkit/public-api/image-loader/image-url.h>
51 #include <dali-toolkit/public-api/image-loader/image.h>
52 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
56 #include <unordered_map>
68 return Toolkit::WebView::New();
72 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::WebView, Toolkit::Control, Create)
74 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "url", STRING, URL )
75 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "userAgent", STRING, USER_AGENT )
76 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "scrollPosition", VECTOR2, SCROLL_POSITION )
77 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "scrollSize", VECTOR2, SCROLL_SIZE )
78 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "contentSize", VECTOR2, CONTENT_SIZE )
79 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "title", STRING, TITLE )
80 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "videoHoleEnabled", BOOLEAN, VIDEO_HOLE_ENABLED )
81 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "mouseEventsEnabled", BOOLEAN, MOUSE_EVENTS_ENABLED )
82 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "keyEventsEnabled", BOOLEAN, KEY_EVENTS_ENABLED )
83 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "documentBackgroundColor", VECTOR4, DOCUMENT_BACKGROUND_COLOR )
84 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "tilesClearedWhenHidden", BOOLEAN, TILES_CLEARED_WHEN_HIDDEN )
85 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "tileCoverAreaMultiplier", FLOAT, TILE_COVER_AREA_MULTIPLIER)
86 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "cursorEnabledByClient", BOOLEAN, CURSOR_ENABLED_BY_CLIENT )
87 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "selectedText", STRING, SELECTED_TEXT )
88 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "pageZoomFactor", FLOAT, PAGE_ZOOM_FACTOR )
89 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "textZoomFactor", FLOAT, TEXT_ZOOM_FACTOR )
90 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "loadProgressPercentage", FLOAT, LOAD_PROGRESS_PERCENTAGE )
92 DALI_TYPE_REGISTRATION_END()
95 std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>>& GetPluginWebViewTable()
97 static std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>> pluginWebViewMap;
98 return pluginWebViewMap;
101 enum class DisplayAreaCalculateOption
103 PROPERTY = 0, ///< Calculate display update area by property
104 CURRENT_PROPERTY = 1, ///< Calculate display update area by current property
108 * @brief Helper function to calculate exact display area, offset and size.
109 * It will be useful when view size is not integer value, or view size is not matched with texture size.
111 * @param[in] self The view itself.
112 * @param[in] option Option of this calculation. Let we decide what kind of property will be used.
113 * @return DisplayArea for this view.
115 Rect<int32_t> CalculateDisplayArea(Dali::Actor self, DisplayAreaCalculateOption option)
117 bool positionUsesAnchorPoint = self.GetProperty<bool>(Actor::Property::POSITION_USES_ANCHOR_POINT);
118 Vector3 actorSize = (option == DisplayAreaCalculateOption::CURRENT_PROPERTY) ? self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::SCALE)
119 : self.GetProperty<Vector3>(Actor::Property::SIZE) * self.GetProperty<Vector3>(Actor::Property::SCALE);
120 Vector3 anchorPointOffSet = actorSize * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
121 Vector2 screenPosition = (option == DisplayAreaCalculateOption::CURRENT_PROPERTY) ? self.GetProperty<Vector2>(Actor::Property::SCREEN_POSITION)
122 : Dali::DevelActor::CalculateScreenPosition(self);
124 Dali::Rect<int32_t> displayArea;
125 displayArea.x = screenPosition.x - anchorPointOffSet.x;
126 displayArea.y = screenPosition.y - anchorPointOffSet.y;
127 displayArea.width = actorSize.x;
128 displayArea.height = actorSize.y;
133 constexpr Vector4 FULL_TEXTURE_RECT(0.f, 0.f, 1.f, 1.f);
136 * @brief Helper function to calculate exact pixel area value by view and texture size.
137 * It will be useful when view size is not integer value, or view size is not matched with texture size.
139 * @param[in] viewSize The size of view.
140 * @param[in] textureWidth The width of texture, that must be integer type.
141 * @param[in] textureHeight The height of texture, that must be integer type.
142 * @return PixelArea value that image visual can use.
144 Vector4 CalculatePixelArea(const Size& viewSize, const uint32_t textureWidth, const uint32_t textureHeight)
146 float widthRatio = textureWidth == 0u ? 1.0f : viewSize.width / static_cast<float>(textureWidth);
147 float heightRatio = textureHeight == 0u ? 1.0f : viewSize.height / static_cast<float>(textureHeight);
148 return Vector4(0.0f, 0.0f, widthRatio, heightRatio);
153 WebView::WebView(const std::string& locale, const std::string& timezoneId)
154 : Control(ControlBehaviour(ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS)),
156 mWebViewSize(Stage::GetCurrent().GetSize()),
158 mLastRenderedNativeImageWidth(0u),
159 mLastRenderedNativeImageHeight(0u),
160 mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
161 mVideoHoleEnabled(false),
162 mMouseEventsEnabled(true),
163 mKeyEventsEnabled(true),
164 mVisualChangeRequired(false),
165 mScreenshotCapturedCallback{nullptr},
166 mFrameRenderedCallback{nullptr}
168 mWebEngine = Dali::WebEngine::New();
170 // WebEngine is empty when it is not properly initialized.
173 mWebEngine.Create(mWebViewSize.width, mWebViewSize.height, locale, timezoneId);
177 WebView::WebView(uint32_t argc, char** argv)
178 : Control(ControlBehaviour(ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS)),
180 mWebViewSize(Stage::GetCurrent().GetSize()),
182 mLastRenderedNativeImageWidth(0u),
183 mLastRenderedNativeImageHeight(0u),
184 mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
185 mVideoHoleEnabled(false),
186 mMouseEventsEnabled(true),
187 mKeyEventsEnabled(true),
188 mVisualChangeRequired(false),
189 mScreenshotCapturedCallback{nullptr},
190 mFrameRenderedCallback{nullptr}
192 mWebEngine = Dali::WebEngine::New();
194 // WebEngine is empty when it is not properly initialized.
197 mWebEngine.Create(mWebViewSize.width, mWebViewSize.height, argc, argv);
210 auto iter = GetPluginWebViewTable().find(mWebEngine.GetPlugin());
211 if(iter != GetPluginWebViewTable().end())
213 GetPluginWebViewTable().erase(iter);
215 mWebEngine.Destroy();
219 Toolkit::WebView WebView::New()
221 WebView* impl = new WebView();
222 Toolkit::WebView handle = Toolkit::WebView(*impl);
223 if(impl->GetPlugin())
225 GetPluginWebViewTable()[impl->GetPlugin()] = handle;
231 Toolkit::WebView WebView::New(const std::string& locale, const std::string& timezoneId)
233 WebView* impl = new WebView(locale, timezoneId);
234 Toolkit::WebView handle = Toolkit::WebView(*impl);
235 if(impl->GetPlugin())
237 GetPluginWebViewTable()[impl->GetPlugin()] = handle;
243 Toolkit::WebView WebView::New(uint32_t argc, char** argv)
245 WebView* impl = new WebView(argc, argv);
246 Toolkit::WebView handle = Toolkit::WebView(*impl);
247 if(impl->GetPlugin())
249 GetPluginWebViewTable()[impl->GetPlugin()] = handle;
255 Toolkit::WebView WebView::FindWebView(Dali::WebEnginePlugin* plugin)
257 auto iter = GetPluginWebViewTable().find(plugin);
258 if(iter != GetPluginWebViewTable().end())
260 return iter->second.GetHandle();
262 return Toolkit::WebView();
265 Dali::WebEngineContext* WebView::GetContext()
267 return Dali::WebEngine::GetContext();
270 Dali::WebEngineCookieManager* WebView::GetCookieManager()
272 return Dali::WebEngine::GetCookieManager();
275 void WebView::OnInitialize()
279 self.SetProperty(Actor::Property::KEYBOARD_FOCUSABLE, true);
280 self.SetProperty(DevelActor::Property::TOUCH_FOCUSABLE, true);
281 self.TouchedSignal().Connect(this, &WebView::OnTouchEvent);
282 self.HoveredSignal().Connect(this, &WebView::OnHoverEvent);
283 self.WheelEventSignal().Connect(this, &WebView::OnWheelEvent);
284 Dali::DevelActor::VisibilityChangedSignal(self).Connect(this, &WebView::OnVisibilityChanged);
286 mWebViewVisibleState |= WebViewVisibleStateFlag::SELF_SHOW;
288 mPositionUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_POSITION, StepCondition(1.0f, 1.0f));
289 mSizeUpdateNotification = self.AddPropertyNotification(Actor::Property::SIZE, StepCondition(1.0f, 1.0f));
290 mScaleUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_SCALE, StepCondition(0.1f, 1.0f));
291 mPositionUpdateNotification.NotifySignal().Connect(this, &WebView::OnDisplayAreaUpdated);
292 mSizeUpdateNotification.NotifySignal().Connect(this, &WebView::OnDisplayAreaUpdated);
293 mScaleUpdateNotification.NotifySignal().Connect(this, &WebView::OnDisplayAreaUpdated);
297 mWebEngine.RegisterFrameRenderedCallback(std::bind(&WebView::OnFrameRendered, this));
298 mWebSettings = std::unique_ptr<Dali::Toolkit::WebSettings>(new WebSettings(mWebEngine.GetSettings()));
299 mWebBackForwardList = std::unique_ptr<Dali::Toolkit::WebBackForwardList>(new WebBackForwardList(mWebEngine.GetBackForwardList()));
302 self.SetProperty(DevelControl::Property::ACCESSIBILITY_ROLE, Dali::Accessibility::Role::FILLER);
305 DevelControl::ControlAccessible* WebView::CreateAccessibleObject()
307 return new WebViewAccessible(Self(), mWebEngine);
310 void WebView::OnRelayout(const Vector2& size, RelayoutContainer& container)
317 auto displayArea = CalculateDisplayArea(Self(), DisplayAreaCalculateOption::PROPERTY);
319 SetDisplayArea(displayArea);
322 Dali::Toolkit::WebSettings* WebView::GetSettings() const
324 return mWebSettings.get();
327 Dali::Toolkit::WebBackForwardList* WebView::GetBackForwardList() const
329 return mWebBackForwardList.get();
332 Dali::WebEnginePlugin* WebView::GetPlugin() const
334 return mWebEngine ? mWebEngine.GetPlugin() : nullptr;
337 Dali::Toolkit::ImageView WebView::GetFavicon() const
339 Dali::Toolkit::ImageView faviconView;
342 Dali::PixelData pixelData = mWebEngine.GetFavicon();
343 faviconView = CreateImageView(pixelData);
348 void WebView::LoadUrl(const std::string& url)
352 mWebEngine.LoadUrl(url);
356 void WebView::LoadHtmlString(const std::string& htmlString)
360 mWebEngine.LoadHtmlString(htmlString);
364 bool WebView::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
369 return mWebEngine.LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
372 bool WebView::LoadContents(const int8_t* contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
377 return mWebEngine.LoadContents(contents, contentSize, mimeType, encoding, baseUri);
380 void WebView::Reload()
388 bool WebView::ReloadWithoutCache()
390 return mWebEngine ? mWebEngine.ReloadWithoutCache() : false;
393 void WebView::StopLoading()
397 mWebEngine.StopLoading();
401 void WebView::Suspend()
405 mWebEngine.Suspend();
409 void WebView::Resume()
417 void WebView::SuspendNetworkLoading()
421 mWebEngine.SuspendNetworkLoading();
425 void WebView::ResumeNetworkLoading()
429 mWebEngine.ResumeNetworkLoading();
433 bool WebView::AddCustomHeader(const std::string& name, const std::string& value)
435 return mWebEngine ? mWebEngine.AddCustomHeader(name, value) : false;
438 bool WebView::RemoveCustomHeader(const std::string& name)
440 return mWebEngine ? mWebEngine.RemoveCustomHeader(name) : false;
443 uint32_t WebView::StartInspectorServer(uint32_t port)
445 return mWebEngine ? mWebEngine.StartInspectorServer(port) : false;
448 bool WebView::StopInspectorServer()
450 return mWebEngine ? mWebEngine.StopInspectorServer() : false;
453 void WebView::ScrollBy(int32_t deltaX, int32_t deltaY)
457 mWebEngine.ScrollBy(deltaX, deltaY);
461 bool WebView::ScrollEdgeBy(int32_t deltaX, int32_t deltaY)
463 return mWebEngine ? mWebEngine.ScrollEdgeBy(deltaX, deltaY) : false;
466 bool WebView::CanGoForward()
468 return mWebEngine ? mWebEngine.CanGoForward() : false;
471 void WebView::GoForward()
475 mWebEngine.GoForward();
479 bool WebView::CanGoBack()
481 return mWebEngine ? mWebEngine.CanGoBack() : false;
484 void WebView::GoBack()
492 void WebView::EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler)
496 mWebEngine.EvaluateJavaScript(script, std::move(resultHandler));
500 void WebView::AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler)
504 mWebEngine.AddJavaScriptMessageHandler(exposedObjectName, std::move(handler));
508 void WebView::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
512 mWebEngine.RegisterJavaScriptAlertCallback(std::move(callback));
516 void WebView::JavaScriptAlertReply()
520 mWebEngine.JavaScriptAlertReply();
524 void WebView::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
528 mWebEngine.RegisterJavaScriptConfirmCallback(std::move(callback));
532 void WebView::JavaScriptConfirmReply(bool confirmed)
536 mWebEngine.JavaScriptConfirmReply(confirmed);
540 void WebView::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
544 mWebEngine.RegisterJavaScriptPromptCallback(std::move(callback));
548 void WebView::JavaScriptPromptReply(const std::string& result)
552 mWebEngine.JavaScriptPromptReply(result);
556 std::unique_ptr<Dali::WebEngineHitTest> WebView::CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode)
558 std::unique_ptr<Dali::WebEngineHitTest> webHitTest;
564 return mWebEngine.CreateHitTest(x, y, mode);
567 bool WebView::CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback)
572 result = mWebEngine.CreateHitTestAsynchronously(x, y, mode, std::move(callback));
577 void WebView::ClearHistory()
581 mWebEngine.ClearHistory();
585 void WebView::ClearAllTilesResources()
589 mWebEngine.ClearAllTilesResources();
593 void WebView::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
597 mWebEngine.SetScaleFactor(scaleFactor, point);
601 float WebView::GetScaleFactor() const
603 return mWebEngine ? mWebEngine.GetScaleFactor() : 0.0f;
606 void WebView::ActivateAccessibility(bool activated)
610 mWebEngine.ActivateAccessibility(activated);
614 bool WebView::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
616 return mWebEngine ? mWebEngine.HighlightText(text, options, maxMatchCount) : false;
619 void WebView::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
623 mWebEngine.AddDynamicCertificatePath(host, certPath);
627 Dali::Toolkit::ImageView WebView::GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor)
629 Dali::Toolkit::ImageView imageView;
632 Dali::PixelData pixelData = mWebEngine.GetScreenshot(viewArea, scaleFactor);
633 imageView = CreateImageView(pixelData);
638 bool WebView::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback)
640 mScreenshotCapturedCallback = std::move(callback);
641 return mWebEngine ? mWebEngine.GetScreenshotAsynchronously(viewArea, scaleFactor, std::bind(&WebView::OnScreenshotCaptured, this, std::placeholders::_1)) : false;
644 bool WebView::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
646 return mWebEngine ? mWebEngine.CheckVideoPlayingAsynchronously(std::move(callback)) : false;
649 void WebView::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
653 mWebEngine.RegisterGeolocationPermissionCallback(std::move(callback));
657 void WebView::SetTtsFocus(bool focused)
659 if(mWebEngine && !HasKeyInputFocus())
661 mWebEngine.SetFocus(focused);
665 void WebView::EnableVideoHole(bool enabled)
667 mVideoHoleEnabled = enabled;
669 EnableBlendMode(!mVideoHoleEnabled);
673 mWebEngine.EnableVideoHole(mVideoHoleEnabled);
677 void WebView::EnableBlendMode(bool blendEnabled)
680 for(uint32_t i = 0; i < self.GetRendererCount(); i++)
682 Dali::Renderer render = self.GetRendererAt(i);
683 render.SetProperty(Renderer::Property::BLEND_MODE, blendEnabled ? BlendMode::ON : BlendMode::OFF);
687 Dali::Toolkit::ImageView WebView::CreateImageView(Dali::PixelData pixel) const
691 return Dali::Toolkit::ImageView();
694 Dali::Toolkit::ImageUrl url = Dali::Toolkit::Image::GenerateUrl(pixel);
695 Dali::Toolkit::ImageView imageView = Dali::Toolkit::ImageView::New(url.GetUrl());
696 imageView.SetProperty(Dali::Actor::Property::SIZE, Vector2(pixel.GetWidth(), pixel.GetHeight()));
700 void WebView::RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
704 mWebEngine.RegisterPageLoadStartedCallback(std::move(callback));
708 void WebView::RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
712 mWebEngine.RegisterPageLoadInProgressCallback(std::move(callback));
716 void WebView::RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback)
720 mWebEngine.RegisterPageLoadFinishedCallback(std::move(callback));
724 void WebView::RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback)
728 mWebEngine.RegisterPageLoadErrorCallback(std::move(callback));
732 void WebView::RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback)
736 mWebEngine.RegisterScrollEdgeReachedCallback(std::move(callback));
740 void WebView::RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback)
744 mWebEngine.RegisterUrlChangedCallback(std::move(callback));
748 void WebView::RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback)
752 mWebEngine.RegisterFormRepostDecidedCallback(std::move(callback));
756 void WebView::RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback)
758 mFrameRenderedCallback = std::move(callback);
761 void WebView::RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback)
765 mWebEngine.RegisterConsoleMessageReceivedCallback(std::move(callback));
769 void WebView::RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback)
773 mWebEngine.RegisterResponsePolicyDecidedCallback(std::move(callback));
777 void WebView::RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback)
781 mWebEngine.RegisterNavigationPolicyDecidedCallback(std::move(callback));
785 void WebView::RegisterNewWindowCreatedCallback(Dali::WebEnginePlugin::WebEngineNewWindowCreatedCallback callback)
789 mWebEngine.RegisterNewWindowCreatedCallback(std::move(callback));
793 void WebView::RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
797 mWebEngine.RegisterCertificateConfirmedCallback(std::move(callback));
801 void WebView::RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback)
805 mWebEngine.RegisterSslCertificateChangedCallback(std::move(callback));
809 void WebView::RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback)
813 mWebEngine.RegisterHttpAuthHandlerCallback(std::move(callback));
817 void WebView::RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback)
821 mWebEngine.RegisterContextMenuShownCallback(std::move(callback));
825 void WebView::RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback)
829 mWebEngine.RegisterContextMenuHiddenCallback(std::move(callback));
833 void WebView::GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback)
837 mWebEngine.GetPlainTextAsynchronously(std::move(callback));
841 void WebView::OnFrameRendered()
843 if(mFrameRenderedCallback)
845 mFrameRenderedCallback();
848 // Make sure that mVisual is created only if required.
849 if(mVisualChangeRequired || !mVisual)
852 mVisualChangeRequired = false;
854 auto nativeImageSourcePtr = mWebEngine.GetNativeImageSource();
856 mLastRenderedNativeImageWidth = nativeImageSourcePtr->GetWidth();
857 mLastRenderedNativeImageHeight = nativeImageSourcePtr->GetHeight();
859 Dali::Toolkit::ImageUrl nativeImageUrl = Dali::Toolkit::Image::GenerateUrl(nativeImageSourcePtr);
861 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
862 {{Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE},
863 {Toolkit::ImageVisual::Property::URL, nativeImageUrl.GetUrl()},
864 {Toolkit::ImageVisual::Property::PIXEL_AREA, FULL_TEXTURE_RECT},
865 {Toolkit::ImageVisual::Property::WRAP_MODE_U, Dali::WrapMode::CLAMP_TO_EDGE},
866 {Toolkit::ImageVisual::Property::WRAP_MODE_V, Dali::WrapMode::CLAMP_TO_EDGE}});
870 DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual);
871 EnableBlendMode(!mVideoHoleEnabled);
876 void WebView::OnDisplayAreaUpdated(Dali::PropertyNotification& /*source*/)
883 auto displayArea = CalculateDisplayArea(Self(), DisplayAreaCalculateOption::CURRENT_PROPERTY);
885 SetDisplayArea(displayArea);
888 void WebView::OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type)
890 if(type == Dali::DevelActor::VisibilityChange::Type::SELF)
894 mWebViewVisibleState |= WebViewVisibleStateFlag::SELF_SHOW;
898 mWebViewVisibleState &= ~WebViewVisibleStateFlag::SELF_SHOW;
901 else if(type == Dali::DevelActor::VisibilityChange::Type::PARENT)
905 mWebViewVisibleState |= WebViewVisibleStateFlag::PARENT_SHOW;
906 // TODO : We should consider double-hide called from parent
910 mWebViewVisibleState &= ~WebViewVisibleStateFlag::PARENT_SHOW;
913 ApplyVisibilityCheck();
916 void WebView::OnWindowVisibilityChanged(Window window, bool visible)
920 mWebViewVisibleState |= WebViewVisibleStateFlag::WINDOW_SHOW;
924 mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
926 ApplyVisibilityCheck();
929 void WebView::OnScreenshotCaptured(Dali::PixelData pixel)
931 if(mScreenshotCapturedCallback)
933 Dali::Toolkit::ImageView imageView = CreateImageView(pixel);
934 mScreenshotCapturedCallback(imageView);
938 void WebView::SetDisplayArea(const Dali::Rect<int32_t>& displayArea)
940 Size displaySize = Size(displayArea.width, displayArea.height);
941 if(mWebViewSize != displaySize)
943 mWebViewSize = displaySize;
946 if(mWebViewArea != displayArea)
948 // WebEngine visual size changed. we have to re-create visual.
949 mVisualChangeRequired = true;
951 // Change old visual's pixel area matched as changed web view size
954 auto pixelArea = CalculatePixelArea(mWebViewSize, mLastRenderedNativeImageWidth, mLastRenderedNativeImageHeight);
955 Toolkit::GetImplementation(mVisual).DoAction(Toolkit::DevelVisual::Action::UPDATE_PROPERTY, {{Toolkit::ImageVisual::Property::PIXEL_AREA, pixelArea}});
958 mWebViewArea = displayArea;
959 mWebEngine.UpdateDisplayArea(mWebViewArea);
963 void WebView::OnSceneConnection(int depth)
965 mWebViewVisibleState |= WebViewVisibleStateFlag::SCENE_ON;
966 mWebViewVisibleState |= WebViewVisibleStateFlag::PARENT_SHOW;
967 // TODO : We should consider already hided parent
968 Window window = DevelWindow::Get(Self());
971 // Hold the weak handle of the placement window.
972 mPlacementWindow = window;
973 if(window.IsVisible())
975 mWebViewVisibleState |= WebViewVisibleStateFlag::WINDOW_SHOW;
979 mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
981 DevelWindow::VisibilityChangedSignal(window).Connect(this, &WebView::OnWindowVisibilityChanged);
983 ApplyVisibilityCheck();
984 Control::OnSceneConnection(depth);
985 EnableBlendMode(!mVideoHoleEnabled);
988 void WebView::OnSceneDisconnection()
990 mWebViewVisibleState &= ~WebViewVisibleStateFlag::SCENE_ON;
991 mWebViewVisibleState &= ~WebViewVisibleStateFlag::WINDOW_SHOW;
992 mWebViewVisibleState &= ~WebViewVisibleStateFlag::PARENT_SHOW;
993 Window window = mPlacementWindow.GetHandle();
996 DevelWindow::VisibilityChangedSignal(window).Disconnect(this, &WebView::OnWindowVisibilityChanged);
997 mPlacementWindow.Reset();
999 ApplyVisibilityCheck();
1000 Control::OnSceneDisconnection();
1003 bool WebView::OnTouchEvent(Actor actor, const Dali::TouchEvent& touch)
1005 bool result = false;
1009 result = mWebEngine.SendTouchEvent(touch);
1014 bool WebView::OnKeyEvent(const Dali::KeyEvent& event)
1016 bool result = false;
1020 result = mWebEngine.SendKeyEvent(event);
1025 bool WebView::OnHoverEvent(Actor actor, const Dali::HoverEvent& hover)
1027 bool result = false;
1028 if(mWebEngine && mMouseEventsEnabled)
1030 result = mWebEngine.SendHoverEvent(hover);
1035 bool WebView::OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel)
1037 bool result = false;
1038 if(mWebEngine && mMouseEventsEnabled)
1040 result = mWebEngine.SendWheelEvent(wheel);
1045 void WebView::OnKeyInputFocusGained()
1049 mWebEngine.SetFocus(true);
1052 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
1055 void WebView::OnKeyInputFocusLost()
1059 mWebEngine.SetFocus(false);
1062 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
1065 Vector3 WebView::GetNaturalSize()
1069 Vector2 rendererNaturalSize;
1070 mVisual.GetNaturalSize(rendererNaturalSize);
1071 return Vector3(rendererNaturalSize);
1074 return Vector3(mWebViewSize);
1077 void WebView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
1079 Toolkit::WebView webView = Toolkit::WebView::DownCast(Dali::BaseHandle(object));
1083 WebView& impl = GetImpl(webView);
1086 case Toolkit::WebView::Property::URL:
1095 case Toolkit::WebView::Property::USER_AGENT:
1098 if(value.Get(input))
1100 impl.SetUserAgent(input);
1104 case Toolkit::WebView::Property::SCROLL_POSITION:
1107 if(value.Get(input))
1109 impl.SetScrollPosition(input.x, input.y);
1113 case Toolkit::WebView::Property::VIDEO_HOLE_ENABLED:
1116 if(value.Get(input))
1118 impl.EnableVideoHole(input);
1122 case Toolkit::WebView::Property::MOUSE_EVENTS_ENABLED:
1125 if(value.Get(input))
1127 impl.EnableMouseEvents(input);
1131 case Toolkit::WebView::Property::KEY_EVENTS_ENABLED:
1134 if(value.Get(input))
1136 impl.EnableKeyEvents(input);
1140 case Toolkit::WebView::Property::DOCUMENT_BACKGROUND_COLOR:
1143 if(value.Get(input))
1145 impl.SetDocumentBackgroundColor(input);
1149 case Toolkit::WebView::Property::TILES_CLEARED_WHEN_HIDDEN:
1152 if(value.Get(input))
1154 impl.ClearTilesWhenHidden(input);
1158 case Toolkit::WebView::Property::TILE_COVER_AREA_MULTIPLIER:
1161 if(value.Get(input))
1163 impl.SetTileCoverAreaMultiplier(input);
1167 case Toolkit::WebView::Property::CURSOR_ENABLED_BY_CLIENT:
1170 if(value.Get(input))
1172 impl.EnableCursorByClient(input);
1176 case Toolkit::WebView::Property::PAGE_ZOOM_FACTOR:
1179 if(value.Get(input))
1181 impl.SetPageZoomFactor(input);
1185 case Toolkit::WebView::Property::TEXT_ZOOM_FACTOR:
1188 if(value.Get(input))
1190 impl.SetTextZoomFactor(input);
1200 Property::Value WebView::GetProperty(BaseObject* object, Property::Index propertyIndex)
1202 Property::Value value;
1204 Toolkit::WebView webView = Toolkit::WebView::DownCast(Dali::BaseHandle(object));
1208 WebView& impl = GetImpl(webView);
1209 switch(propertyIndex)
1211 case Toolkit::WebView::Property::URL:
1213 value = impl.GetUrl();
1216 case Toolkit::WebView::Property::USER_AGENT:
1218 value = impl.GetUserAgent();
1221 case Toolkit::WebView::Property::SCROLL_POSITION:
1223 value = impl.GetScrollPosition();
1226 case Toolkit::WebView::Property::SCROLL_SIZE:
1228 value = impl.GetScrollSize();
1231 case Toolkit::WebView::Property::CONTENT_SIZE:
1233 value = impl.GetContentSize();
1236 case Toolkit::WebView::Property::TITLE:
1238 value = impl.GetTitle();
1241 case Toolkit::WebView::Property::VIDEO_HOLE_ENABLED:
1243 value = impl.mVideoHoleEnabled;
1246 case Toolkit::WebView::Property::MOUSE_EVENTS_ENABLED:
1248 value = impl.mMouseEventsEnabled;
1251 case Toolkit::WebView::Property::KEY_EVENTS_ENABLED:
1253 value = impl.mKeyEventsEnabled;
1256 case Toolkit::WebView::Property::SELECTED_TEXT:
1258 value = impl.GetSelectedText();
1261 case Toolkit::WebView::Property::PAGE_ZOOM_FACTOR:
1263 value = impl.GetPageZoomFactor();
1266 case Toolkit::WebView::Property::TEXT_ZOOM_FACTOR:
1268 value = impl.GetTextZoomFactor();
1271 case Toolkit::WebView::Property::LOAD_PROGRESS_PERCENTAGE:
1273 value = impl.GetLoadProgressPercentage();
1284 void WebView::SetScrollPosition(int32_t x, int32_t y)
1288 mWebEngine.SetScrollPosition(x, y);
1292 Dali::Vector2 WebView::GetScrollPosition() const
1294 return mWebEngine ? mWebEngine.GetScrollPosition() : Dali::Vector2::ZERO;
1297 Dali::Vector2 WebView::GetScrollSize() const
1299 return mWebEngine ? mWebEngine.GetScrollSize() : Dali::Vector2::ZERO;
1302 Dali::Vector2 WebView::GetContentSize() const
1304 return mWebEngine ? mWebEngine.GetContentSize() : Dali::Vector2::ZERO;
1307 std::string WebView::GetTitle() const
1309 return mWebEngine ? mWebEngine.GetTitle() : std::string();
1312 void WebView::SetDocumentBackgroundColor(Dali::Vector4 color)
1316 mWebEngine.SetDocumentBackgroundColor(color);
1320 void WebView::ClearTilesWhenHidden(bool cleared)
1324 mWebEngine.ClearTilesWhenHidden(cleared);
1328 void WebView::SetTileCoverAreaMultiplier(float multiplier)
1332 mWebEngine.SetTileCoverAreaMultiplier(multiplier);
1336 void WebView::EnableCursorByClient(bool enabled)
1340 mWebEngine.EnableCursorByClient(enabled);
1344 std::string WebView::GetSelectedText() const
1346 return mWebEngine ? mWebEngine.GetSelectedText() : std::string();
1349 std::string WebView::GetUrl() const
1351 return mWebEngine ? mWebEngine.GetUrl() : std::string();
1354 std::string WebView::GetUserAgent() const
1356 return mWebEngine ? mWebEngine.GetUserAgent() : std::string();
1359 void WebView::SetUserAgent(const std::string& userAgent)
1363 mWebEngine.SetUserAgent(userAgent);
1367 void WebView::EnableMouseEvents(bool enabled)
1371 mMouseEventsEnabled = enabled;
1372 mWebEngine.EnableMouseEvents(enabled);
1376 void WebView::EnableKeyEvents(bool enabled)
1380 mKeyEventsEnabled = enabled;
1381 mWebEngine.EnableKeyEvents(enabled);
1385 void WebView::SetPageZoomFactor(float zoomFactor)
1389 mWebEngine.SetPageZoomFactor(zoomFactor);
1393 float WebView::GetPageZoomFactor() const
1395 return mWebEngine ? mWebEngine.GetPageZoomFactor() : 0.0f;
1398 void WebView::SetTextZoomFactor(float zoomFactor)
1402 mWebEngine.SetTextZoomFactor(zoomFactor);
1406 float WebView::GetTextZoomFactor() const
1408 return mWebEngine ? mWebEngine.GetTextZoomFactor() : 0.0f;
1411 float WebView::GetLoadProgressPercentage() const
1413 return mWebEngine ? mWebEngine.GetLoadProgressPercentage() : 0.0f;
1416 bool WebView::SetVisibility(bool visible)
1418 return mWebEngine ? mWebEngine.SetVisibility(visible) : false;
1421 void WebView::ApplyVisibilityCheck()
1423 SetVisibility(mWebViewVisibleState == WebViewVisibleStateFlag::VISIBLE);
1426 WebView::WebViewAccessible::WebViewAccessible(Dali::Actor self, Dali::WebEngine& webEngine)
1427 : ControlAccessible(self),
1429 mWebEngine{webEngine}
1431 mRemoteChild.SetParent(this);
1433 Dali::Accessibility::Bridge::EnabledSignal().Connect(this, &WebViewAccessible::OnAccessibilityEnabled);
1434 Dali::Accessibility::Bridge::DisabledSignal().Connect(this, &WebViewAccessible::OnAccessibilityDisabled);
1436 if(Dali::Accessibility::IsUp())
1438 OnAccessibilityEnabled();
1442 OnAccessibilityDisabled();
1446 Dali::Accessibility::Attributes WebView::WebViewAccessible::GetAttributes() const
1448 auto attributes = DevelControl::ControlAccessible::GetAttributes();
1450 if(mRemoteChild.GetAddress())
1452 attributes.insert_or_assign("child_bus", mRemoteChild.GetAddress().GetBus());
1458 void WebView::WebViewAccessible::DoGetChildren(std::vector<Dali::Accessibility::Accessible*>& children)
1460 if(mRemoteChild.GetAddress())
1462 // DoGetChildren is called at most once per every OnChildrenChanged.
1463 // We have only one OnChildrenChanged in this case, so EmbedAtkSocket will be called only once.
1464 Accessibility::Bridge::GetCurrentBridge()->EmbedAtkSocket(GetAddress(), mRemoteChild.GetAddress());
1465 children.push_back(&mRemoteChild);
1469 void WebView::WebViewAccessible::OnAccessibilityEnabled()
1476 mWebEngine.ActivateAccessibility(true);
1477 SetRemoteChildAddress(mWebEngine.GetAccessibilityAddress());
1480 void WebView::WebViewAccessible::OnAccessibilityDisabled()
1487 SetRemoteChildAddress({});
1488 mWebEngine.ActivateAccessibility(false);
1491 void WebView::WebViewAccessible::SetRemoteChildAddress(Dali::Accessibility::Address address)
1493 mRemoteChild.SetAddress(address);
1494 OnChildrenChanged();
1497 } // namespace Internal
1499 } // namespace Toolkit