2 * Copyright (c) 2021 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 "web-view-impl.h"
22 #include <dali/devel-api/adaptor-framework/web-engine-back-forward-list.h>
23 #include <dali/devel-api/adaptor-framework/web-engine-certificate.h>
24 #include <dali/devel-api/adaptor-framework/web-engine-console-message.h>
25 #include <dali/devel-api/adaptor-framework/web-engine-context-menu-item.h>
26 #include <dali/devel-api/adaptor-framework/web-engine-context-menu.h>
27 #include <dali/devel-api/adaptor-framework/web-engine-context.h>
28 #include <dali/devel-api/adaptor-framework/web-engine-cookie-manager.h>
29 #include <dali/devel-api/adaptor-framework/web-engine-form-repost-decision.h>
30 #include <dali/devel-api/adaptor-framework/web-engine-hit-test.h>
31 #include <dali/devel-api/adaptor-framework/web-engine-http-auth-handler.h>
32 #include <dali/devel-api/adaptor-framework/web-engine-load-error.h>
33 #include <dali/devel-api/adaptor-framework/web-engine-policy-decision.h>
34 #include <dali/devel-api/adaptor-framework/web-engine-request-interceptor.h>
35 #include <dali/devel-api/adaptor-framework/web-engine-settings.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>
46 #include <dali-toolkit/devel-api/controls/control-devel.h>
47 #include <dali-toolkit/devel-api/controls/web-view/web-back-forward-list.h>
48 #include <dali-toolkit/devel-api/controls/web-view/web-context.h>
49 #include <dali-toolkit/devel-api/controls/web-view/web-cookie-manager.h>
50 #include <dali-toolkit/devel-api/controls/web-view/web-settings.h>
51 #include <dali-toolkit/devel-api/image-loader/texture-manager.h>
52 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
53 #include <dali-toolkit/public-api/image-loader/image.h>
54 #include <dali-toolkit/public-api/visuals/image-visual-properties.h>
66 return Toolkit::WebView::New();
70 DALI_TYPE_REGISTRATION_BEGIN(Toolkit::WebView, Toolkit::Control, Create)
72 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "url", STRING, URL )
73 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "userAgent", STRING, USER_AGENT )
74 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "scrollPosition", VECTOR2, SCROLL_POSITION )
75 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "scrollSize", VECTOR2, SCROLL_SIZE )
76 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "contentSize", VECTOR2, CONTENT_SIZE )
77 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "title", STRING, TITLE )
78 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "videoHoleEnabled", BOOLEAN, VIDEO_HOLE_ENABLED )
79 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "mouseEventsEnabled", BOOLEAN, MOUSE_EVENTS_ENABLED )
80 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "keyEventsEnabled", BOOLEAN, KEY_EVENTS_ENABLED )
81 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "documentBackgroundColor", VECTOR4, DOCUMENT_BACKGROUND_COLOR )
82 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "tilesClearedWhenHidden", BOOLEAN, TILES_CLEARED_WHEN_HIDDEN )
83 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "tileCoverAreaMultiplier", FLOAT, TILE_COVER_AREA_MULTIPLIER)
84 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "cursorEnabledByClient", BOOLEAN, CURSOR_ENABLED_BY_CLIENT )
85 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "selectedText", STRING, SELECTED_TEXT )
86 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "pageZoomFactor", FLOAT, PAGE_ZOOM_FACTOR )
87 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "textZoomFactor", FLOAT, TEXT_ZOOM_FACTOR )
88 DALI_PROPERTY_REGISTRATION(Toolkit, WebView, "loadProgressPercentage", FLOAT, LOAD_PROGRESS_PERCENTAGE )
90 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "pageLoadStarted", PAGE_LOAD_STARTED_SIGNAL )
91 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "pageLoadInProgress", PAGE_LOAD_IN_PROGRESS_SIGNAL )
92 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "pageLoadFinished", PAGE_LOAD_FINISHED_SIGNAL )
93 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "pageLoadError", PAGE_LOAD_ERROR_SIGNAL )
94 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "scrollEdgeReached", SCROLL_EDGE_REACHED_SIGNAL )
95 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "urlChanged", URL_CHANGED_SIGNAL )
96 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "formRepostDecision", FORM_REPOST_DECISION_SIGNAL )
97 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "frameRendered", FRAME_RENDERED_SIGNAL )
98 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "requestInterceptor", REQUEST_INTERCEPTOR_SIGNAL )
99 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "consoleMessage", CONSOLE_MESSAGE_SIGNAL )
100 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "policyDecision", POLICY_DECISION )
101 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "certificateConfirm", CERTIFICATE_CONFIRM_SIGNAL )
102 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "sslCertificateChanged", SSL_CERTIFICATE_CHANGED_SIGNAL )
103 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "httpAuthRequest", HTTP_AUTH_REQUEST_SIGNAL )
104 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "contextMenuCustomized", CONTEXT_MENU_CUSTOMIZED_SIGNAL )
105 DALI_SIGNAL_REGISTRATION(Toolkit, WebView, "contextMenuItemSelected", CONTEXT_MENU_ITEM_SELECTED_SIGNAL)
107 DALI_TYPE_REGISTRATION_END()
110 const std::string kEmptyString;
112 const char* DEFAULT_SAMPLER_TYPENAME = "sampler2D";
114 const char* FRAGMENT_SHADER_TEXTURE = DALI_COMPOSE_SHADER(
115 varying mediump vec2 vTexCoord;\n
116 uniform sampler2D sTexture;\n
117 uniform lowp vec4 uColor;\n
118 uniform lowp vec3 mixColor;\n
119 uniform lowp float preMultipliedAlpha;\n
123 gl_FragColor = texture2D( sTexture, vTexCoord ) * uColor * vec4( mixColor, 1.0 );\n
127 Dali::Toolkit::Visual::Base CreateNativeImageVisual( NativeImageInterfacePtr nativeImageInterface )
129 std::string fragmentShader;
131 const char* fragmentPrefix = nativeImageInterface->GetCustomFragmentPrefix();
134 fragmentShader = fragmentPrefix;
135 fragmentShader += FRAGMENT_SHADER_TEXTURE;
139 fragmentShader = FRAGMENT_SHADER_TEXTURE;
142 const char* customSamplerTypename = nativeImageInterface->GetCustomSamplerTypename();
143 if( customSamplerTypename )
145 fragmentShader.replace( fragmentShader.find( DEFAULT_SAMPLER_TYPENAME ), strlen( DEFAULT_SAMPLER_TYPENAME ), customSamplerTypename );
148 Texture texture = Dali::Texture::New( *nativeImageInterface );
149 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture( texture );
151 return Toolkit::VisualFactory::Get().CreateVisual(
152 { { Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE } ,
153 { Toolkit::Visual::Property::SHADER, { { Toolkit::Visual::Shader::Property::FRAGMENT_SHADER, fragmentShader } } },
154 { Toolkit::ImageVisual::Property::URL, nativeImageUrl } } );
157 } // anonymous namepsace
159 #define GET_ENUM_STRING(structName, inputExp) \
160 Scripting::GetLinearEnumerationName<Toolkit::WebView::structName::Type>(static_cast<Toolkit::WebView::structName::Type>(inputExp), structName##_TABLE, structName##_TABLE_COUNT)
162 #define GET_ENUM_VALUE(structName, inputExp, outputExp) \
163 Scripting::GetEnumerationProperty<Toolkit::WebView::structName::Type>(inputExp, structName##_TABLE, structName##_TABLE_COUNT, outputExp)
165 WebView::WebView(const std::string& locale, const std::string& timezoneId)
166 : Control(ControlBehaviour(ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS)),
169 mWebViewSize(Stage::GetCurrent().GetSize()),
171 mPageLoadStartedSignal(),
172 mPageLoadFinishedSignal(),
173 mPageLoadErrorSignal(),
175 mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
176 mVideoHoleEnabled(true),
177 mMouseEventsEnabled(true),
178 mKeyEventsEnabled(true)
180 mWebEngine = Dali::WebEngine::New();
182 // WebEngine is empty when it is not properly initialized.
185 mWebEngine.Create(mWebViewSize.width, mWebViewSize.height, locale, timezoneId);
189 WebView::WebView(uint32_t argc, char** argv)
190 : Control(ControlBehaviour(ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS)),
193 mWebViewSize(Stage::GetCurrent().GetSize()),
195 mPageLoadStartedSignal(),
196 mPageLoadFinishedSignal(),
197 mPageLoadErrorSignal(),
199 mWebViewArea(0, 0, mWebViewSize.width, mWebViewSize.height),
200 mVideoHoleEnabled(true),
201 mMouseEventsEnabled(true),
202 mKeyEventsEnabled(true)
204 mWebEngine = Dali::WebEngine::New();
206 // WebEngine is empty when it is not properly initialized.
209 mWebEngine.Create(mWebViewSize.width, mWebViewSize.height, argc, argv);
222 mWebEngine.Destroy();
226 Toolkit::WebView WebView::New()
228 WebView* impl = new WebView();
229 Toolkit::WebView handle = Toolkit::WebView(*impl);
235 Toolkit::WebView WebView::New(const std::string& locale, const std::string& timezoneId)
237 WebView* impl = new WebView(locale, timezoneId);
238 Toolkit::WebView handle = Toolkit::WebView(*impl);
244 Toolkit::WebView WebView::New(uint32_t argc, char** argv)
246 WebView* impl = new WebView(argc, argv);
247 Toolkit::WebView handle = Toolkit::WebView(*impl);
253 void WebView::OnInitialize()
257 self.SetProperty(Actor::Property::KEYBOARD_FOCUSABLE, true);
258 self.TouchedSignal().Connect(this, &WebView::OnTouchEvent);
259 self.HoveredSignal().Connect(this, &WebView::OnHoverEvent);
260 self.WheelEventSignal().Connect(this, &WebView::OnWheelEvent);
261 Dali::DevelActor::VisibilityChangedSignal(self).Connect(this, &WebView::OnVisibilityChanged);
263 mPositionUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_POSITION, StepCondition(1.0f, 1.0f));
264 mSizeUpdateNotification = self.AddPropertyNotification(Actor::Property::SIZE, StepCondition(1.0f, 1.0f));
265 mScaleUpdateNotification = self.AddPropertyNotification(Actor::Property::WORLD_SCALE, StepCondition(0.1f, 1.0f));
266 mPositionUpdateNotification.NotifySignal().Connect(this, &WebView::UpdateDisplayArea);
267 mSizeUpdateNotification.NotifySignal().Connect(this, &WebView::UpdateDisplayArea);
268 mScaleUpdateNotification.NotifySignal().Connect(this, &WebView::UpdateDisplayArea);
272 mWebEngine.PageLoadStartedSignal().Connect(this, &WebView::OnPageLoadStarted);
273 mWebEngine.PageLoadInProgressSignal().Connect(this, &WebView::OnPageLoadInProgress);
274 mWebEngine.PageLoadFinishedSignal().Connect(this, &WebView::OnPageLoadFinished);
275 mWebEngine.PageLoadErrorSignal().Connect(this, &WebView::OnPageLoadError);
276 mWebEngine.ScrollEdgeReachedSignal().Connect(this, &WebView::OnScrollEdgeReached);
277 mWebEngine.UrlChangedSignal().Connect(this, &WebView::OnUrlChanged);
278 mWebEngine.FormRepostDecisionSignal().Connect(this, &WebView::OnFormRepostDecision);
279 mWebEngine.FrameRenderedSignal().Connect(this, &WebView::OnFrameRendered);
280 mWebEngine.RequestInterceptorSignal().Connect(this, &WebView::OnInterceptRequest);
281 mWebEngine.ConsoleMessageSignal().Connect(this, &WebView::OnConsoleMessage);
282 mWebEngine.PolicyDecisionSignal().Connect(this, &WebView::OnPolicyDecisionRequest);
283 mWebEngine.CertificateConfirmSignal().Connect(this, &WebView::OnCertificateConfirm);
284 mWebEngine.SslCertificateChangedSignal().Connect(this, &WebView::OnSslCertificateChanged);
285 mWebEngine.HttpAuthHandlerSignal().Connect(this, &WebView::OnHttpAuthenticationRequest);
286 mWebEngine.ContextMenuCustomizedSignal().Connect(this, &WebView::OnContextMenuCustomized);
287 mWebEngine.ContextMenuItemSelectedSignal().Connect(this, &WebView::OnContextMenuItemSelected);
289 mWebContext = std::unique_ptr<Dali::Toolkit::WebContext>(new WebContext(mWebEngine.GetContext()));
290 mWebCookieManager = std::unique_ptr<Dali::Toolkit::WebCookieManager>(new WebCookieManager(mWebEngine.GetCookieManager()));
291 mWebSettings = std::unique_ptr<Dali::Toolkit::WebSettings>(new WebSettings(mWebEngine.GetSettings()));
292 mWebBackForwardList = std::unique_ptr<Dali::Toolkit::WebBackForwardList>(new WebBackForwardList(mWebEngine.GetBackForwardList()));
296 Dali::Toolkit::WebSettings* WebView::GetSettings() const
298 return mWebSettings.get();
301 Dali::Toolkit::WebContext* WebView::GetContext() const
303 return mWebContext.get();
306 Dali::Toolkit::WebCookieManager* WebView::GetCookieManager() const
308 return mWebCookieManager.get();
311 Dali::Toolkit::WebBackForwardList* WebView::GetBackForwardList() const
313 return mWebBackForwardList.get();
316 Dali::Toolkit::ImageView& WebView::GetFavicon()
320 Dali::PixelData pixelData = mWebEngine.GetFavicon();
321 mFaviconView = CreateImageView(pixelData);
326 void WebView::LoadUrl(const std::string& url)
331 mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
335 // Clean up previously registered visual and add new one.
336 DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual);
337 mWebEngine.LoadUrl(url);
340 if(mVideoHoleEnabled)
342 EnableBlendMode(false);
347 void WebView::LoadHtmlString(const std::string& htmlString)
351 mVisual = CreateNativeImageVisual( mWebEngine.GetNativeImageSource() );
355 DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual);
356 mWebEngine.LoadHtmlString(htmlString);
359 if(mVideoHoleEnabled)
361 EnableBlendMode(false);
366 bool WebView::LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl)
371 Texture texture = Dali::Texture::New(*mWebEngine.GetNativeImageSource());
372 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture(texture);
373 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
374 {{Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE},
375 {Toolkit::ImageVisual::Property::URL, nativeImageUrl}});
380 DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual);
381 result = mWebEngine.LoadHtmlStringOverrideCurrentEntry(html, basicUri, unreachableUrl);
384 if(mVideoHoleEnabled)
386 EnableBlendMode(false);
391 bool WebView::LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri)
396 Texture texture = Dali::Texture::New(*mWebEngine.GetNativeImageSource());
397 const std::string nativeImageUrl = Dali::Toolkit::TextureManager::AddTexture(texture);
398 mVisual = Toolkit::VisualFactory::Get().CreateVisual(
399 {{Toolkit::Visual::Property::TYPE, Toolkit::Visual::IMAGE},
400 {Toolkit::ImageVisual::Property::URL, nativeImageUrl}});
405 DevelControl::RegisterVisual(*this, Toolkit::WebView::Property::URL, mVisual);
406 result = mWebEngine.LoadContents(contents, contentSize, mimeType, encoding, baseUri);
409 if(mVideoHoleEnabled)
411 EnableBlendMode(false);
416 void WebView::Reload()
424 bool WebView::ReloadWithoutCache()
426 return mWebEngine ? mWebEngine.ReloadWithoutCache() : false;
429 void WebView::StopLoading()
433 mWebEngine.StopLoading();
437 void WebView::Suspend()
441 mWebEngine.Suspend();
445 void WebView::Resume()
453 void WebView::SuspendNetworkLoading()
457 mWebEngine.SuspendNetworkLoading();
461 void WebView::ResumeNetworkLoading()
465 mWebEngine.ResumeNetworkLoading();
469 bool WebView::AddCustomHeader(const std::string& name, const std::string& value)
471 return mWebEngine ? mWebEngine.AddCustomHeader(name, value) : false;
474 bool WebView::RemoveCustomHeader(const std::string& name)
476 return mWebEngine ? mWebEngine.RemoveCustomHeader(name) : false;
479 uint32_t WebView::StartInspectorServer(uint32_t port)
481 return mWebEngine ? mWebEngine.StartInspectorServer(port) : false;
484 bool WebView::StopInspectorServer()
486 return mWebEngine ? mWebEngine.StopInspectorServer() : false;
489 void WebView::ScrollBy(int32_t deltaX, int32_t deltaY)
493 mWebEngine.ScrollBy(deltaX, deltaY);
497 bool WebView::ScrollEdgeBy(int32_t deltaX, int32_t deltaY)
499 return mWebEngine ? mWebEngine.ScrollEdgeBy(deltaX, deltaY) : false;
502 bool WebView::CanGoForward()
504 return mWebEngine ? mWebEngine.CanGoForward() : false;
507 void WebView::GoForward()
511 mWebEngine.GoForward();
515 bool WebView::CanGoBack()
517 return mWebEngine ? mWebEngine.CanGoBack() : false;
520 void WebView::GoBack()
528 void WebView::EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler)
532 mWebEngine.EvaluateJavaScript(script, resultHandler);
536 void WebView::AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler)
540 mWebEngine.AddJavaScriptMessageHandler(exposedObjectName, handler);
544 void WebView::RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback)
548 mWebEngine.RegisterJavaScriptAlertCallback(callback);
552 void WebView::JavaScriptAlertReply()
556 mWebEngine.JavaScriptAlertReply();
560 void WebView::RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback)
564 mWebEngine.RegisterJavaScriptConfirmCallback(callback);
568 void WebView::JavaScriptConfirmReply(bool confirmed)
572 mWebEngine.JavaScriptConfirmReply(confirmed);
576 void WebView::RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback)
580 mWebEngine.RegisterJavaScriptPromptCallback(callback);
584 void WebView::JavaScriptPromptReply(const std::string& result)
588 mWebEngine.JavaScriptPromptReply(result);
592 std::unique_ptr<Dali::WebEngineHitTest> WebView::CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode)
594 std::unique_ptr<Dali::WebEngineHitTest> webHitTest;
600 return mWebEngine.CreateHitTest(x, y, mode);
603 bool WebView::CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback)
608 result = mWebEngine.CreateHitTestAsynchronously(x, y, mode, callback);
613 void WebView::ClearHistory()
617 mWebEngine.ClearHistory();
621 void WebView::ClearAllTilesResources()
625 mWebEngine.ClearAllTilesResources();
629 void WebView::SetScaleFactor(float scaleFactor, Dali::Vector2 point)
633 mWebEngine.SetScaleFactor(scaleFactor, point);
637 float WebView::GetScaleFactor() const
639 return mWebEngine ? mWebEngine.GetScaleFactor() : 0.0f;
642 void WebView::ActivateAccessibility(bool activated)
646 mWebEngine.ActivateAccessibility(activated);
650 bool WebView::HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount)
652 return mWebEngine ? mWebEngine.HighlightText(text, options, maxMatchCount) : false;
655 void WebView::AddDynamicCertificatePath(const std::string& host, const std::string& certPath)
659 mWebEngine.AddDynamicCertificatePath(host, certPath);
663 Dali::Toolkit::ImageView WebView::GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor)
665 Dali::Toolkit::ImageView imageView;
668 Dali::PixelData pixelData = mWebEngine.GetScreenshot(viewArea, scaleFactor);
669 imageView = CreateImageView(pixelData);
674 bool WebView::GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback)
676 mScreenshotCapturedCallback = callback;
677 return mWebEngine ? mWebEngine.GetScreenshotAsynchronously(viewArea, scaleFactor, std::bind(&WebView::OnScreenshotCaptured, this, std::placeholders::_1)) : false;
680 bool WebView::CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback)
682 return mWebEngine ? mWebEngine.CheckVideoPlayingAsynchronously(callback) : false;
685 void WebView::RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback)
689 mWebEngine.RegisterGeolocationPermissionCallback(callback);
693 void WebView::UpdateDisplayArea(Dali::PropertyNotification& /*source*/)
700 bool positionUsesAnchorPoint = self.GetProperty<bool>(Actor::Property::POSITION_USES_ANCHOR_POINT);
701 Vector3 actorSize = self.GetCurrentProperty<Vector3>(Actor::Property::SIZE) * self.GetCurrentProperty<Vector3>(Actor::Property::SCALE);
702 Vector3 anchorPointOffSet = actorSize * (positionUsesAnchorPoint ? self.GetCurrentProperty<Vector3>(Actor::Property::ANCHOR_POINT) : AnchorPoint::TOP_LEFT);
703 Vector2 screenPosition = self.GetProperty<Vector2>(Actor::Property::SCREEN_POSITION);
705 Dali::Rect<int32_t> displayArea;
706 displayArea.x = screenPosition.x - anchorPointOffSet.x;
707 displayArea.y = screenPosition.y - anchorPointOffSet.y;
708 displayArea.width = actorSize.x;
709 displayArea.height = actorSize.y;
711 Size displaySize = Size(displayArea.width, displayArea.height);
712 if(mWebViewSize != displaySize)
714 mWebViewSize = displaySize;
717 if(mWebViewArea != displayArea)
719 mWebViewArea = displayArea;
720 mWebEngine.UpdateDisplayArea(mWebViewArea);
724 void WebView::EnableVideoHole(bool enabled)
726 mVideoHoleEnabled = enabled;
728 EnableBlendMode(!mVideoHoleEnabled);
732 mWebEngine.EnableVideoHole(mVideoHoleEnabled);
736 void WebView::EnableBlendMode(bool blendEnabled)
739 for(uint32_t i = 0; i < self.GetRendererCount(); i++)
741 Dali::Renderer render = self.GetRendererAt(i);
742 render.SetProperty(Renderer::Property::BLEND_MODE, blendEnabled ? BlendMode::ON : BlendMode::OFF);
746 Dali::Toolkit::ImageView WebView::CreateImageView(Dali::PixelData pixel)
748 std::string url = Dali::Toolkit::Image::GenerateUrl(pixel);
749 Dali::Toolkit::ImageView imageView = Dali::Toolkit::ImageView::New(url);
750 imageView.SetProperty(Dali::Actor::Property::SIZE, Vector2(pixel.GetWidth(), pixel.GetHeight()));
754 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadStartedSignal()
756 return mPageLoadStartedSignal;
759 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadInProgressSignal()
761 return mPageLoadInProgressSignal;
764 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadFinishedSignal()
766 return mPageLoadFinishedSignal;
769 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& WebView::PageLoadErrorSignal()
771 return mPageLoadErrorSignal;
774 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& WebView::ScrollEdgeReachedSignal()
776 return mScrollEdgeReachedSignal;
779 Dali::Toolkit::WebView::WebViewUrlChangedSignalType& WebView::UrlChangedSignal()
781 return mUrlChangedSignal;
784 Dali::Toolkit::WebView::WebViewFormRepostDecisionSignalType& WebView::FormRepostDecisionSignal()
786 return mFormRepostDecisionSignal;
789 Dali::Toolkit::WebView::WebViewFrameRenderedSignalType& WebView::FrameRenderedSignal()
791 return mFrameRenderedSignal;
794 Dali::Toolkit::WebView::WebViewRequestInterceptorSignalType& WebView::RequestInterceptorSignal()
796 return mRequestInterceptorSignal;
799 Dali::Toolkit::WebView::WebViewConsoleMessageSignalType& WebView::ConsoleMessageSignal()
801 return mConsoleMessageSignal;
804 Dali::Toolkit::WebView::WebViewPolicyDecisionSignalType& WebView::PolicyDecisionSignal()
806 return mPolicyDecisionSignal;
809 Dali::Toolkit::WebView::WebViewCertificateSignalType& WebView::CertificateConfirmSignal()
811 return mCertificateConfirmSignal;
814 Dali::Toolkit::WebView::WebViewCertificateSignalType& WebView::SslCertificateChangedSignal()
816 return mSslCertificateChangedSignal;
819 Dali::Toolkit::WebView::WebViewHttpAuthHandlerSignalType& WebView::HttpAuthHandlerSignal()
821 return mHttpAuthHandlerSignal;
824 Dali::Toolkit::WebView::WebViewContextMenuCustomizedSignalType& WebView::ContextMenuCustomizedSignal()
826 return mContextMenuCustomizedSignal;
829 Dali::Toolkit::WebView::WebViewContextMenuItemSelectedSignalType& WebView::ContextMenuItemSelectedSignal()
831 return mContextMenuItemSelectedSignal;
834 void WebView::OnPageLoadStarted(const std::string& url)
836 if(!mPageLoadStartedSignal.Empty())
838 Dali::Toolkit::WebView handle(GetOwner());
839 mPageLoadStartedSignal.Emit(handle, url);
843 void WebView::OnPageLoadInProgress(const std::string& url)
845 if(!mPageLoadInProgressSignal.Empty())
847 Dali::Toolkit::WebView handle(GetOwner());
848 mPageLoadInProgressSignal.Emit(handle, url);
852 void WebView::OnPageLoadFinished(const std::string& url)
854 if(!mPageLoadFinishedSignal.Empty())
856 Dali::Toolkit::WebView handle(GetOwner());
857 mPageLoadFinishedSignal.Emit(handle, url);
861 void WebView::OnPageLoadError(std::shared_ptr<Dali::WebEngineLoadError> error)
863 if(!mPageLoadErrorSignal.Empty())
865 Dali::Toolkit::WebView handle(GetOwner());
866 mPageLoadErrorSignal.Emit(handle, std::move(error));
870 void WebView::OnScrollEdgeReached(Dali::WebEnginePlugin::ScrollEdge edge)
872 if(!mScrollEdgeReachedSignal.Empty())
874 Dali::Toolkit::WebView handle(GetOwner());
875 mScrollEdgeReachedSignal.Emit(handle, edge);
879 void WebView::OnUrlChanged(const std::string& url)
881 if(!mUrlChangedSignal.Empty())
883 Dali::Toolkit::WebView handle(GetOwner());
884 mUrlChangedSignal.Emit(handle, url);
888 void WebView::OnFormRepostDecision(std::shared_ptr<Dali::WebEngineFormRepostDecision> decision)
890 if(!mFormRepostDecisionSignal.Empty())
892 Dali::Toolkit::WebView handle(GetOwner());
893 mFormRepostDecisionSignal.Emit(handle, std::move(decision));
897 void WebView::OnFrameRendered()
899 if(!mFrameRenderedSignal.Empty())
901 Dali::Toolkit::WebView handle(GetOwner());
902 mFrameRenderedSignal.Emit(handle);
906 void WebView::OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type)
908 if(type == Dali::DevelActor::VisibilityChange::Type::SELF)
910 SetVisibility(isVisible);
914 void WebView::OnScreenshotCaptured(Dali::PixelData pixel)
916 if(mScreenshotCapturedCallback)
918 Dali::Toolkit::ImageView imageView = CreateImageView(pixel);
919 mScreenshotCapturedCallback(imageView);
923 void WebView::OnInterceptRequest(std::shared_ptr<Dali::WebEngineRequestInterceptor> interceptor)
925 if(!mRequestInterceptorSignal.Empty())
927 Dali::Toolkit::WebView handle(GetOwner());
928 mRequestInterceptorSignal.Emit(handle, std::move(interceptor));
932 void WebView::OnConsoleMessage(std::shared_ptr<Dali::WebEngineConsoleMessage> message)
934 if(!mConsoleMessageSignal.Empty())
936 Dali::Toolkit::WebView handle(GetOwner());
937 mConsoleMessageSignal.Emit(handle, std::move(message));
941 void WebView::OnPolicyDecisionRequest(std::shared_ptr<Dali::WebEnginePolicyDecision> decision)
943 if(!mPolicyDecisionSignal.Empty())
945 Dali::Toolkit::WebView handle(GetOwner());
946 mPolicyDecisionSignal.Emit(handle, std::move(decision));
950 void WebView::OnCertificateConfirm(std::shared_ptr<Dali::WebEngineCertificate> certificate)
952 if(!mCertificateConfirmSignal.Empty())
954 Dali::Toolkit::WebView handle(GetOwner());
955 mCertificateConfirmSignal.Emit(handle, std::move(certificate));
959 void WebView::OnSslCertificateChanged(std::shared_ptr<Dali::WebEngineCertificate> certificate)
961 if(!mSslCertificateChangedSignal.Empty())
963 Dali::Toolkit::WebView handle(GetOwner());
964 mSslCertificateChangedSignal.Emit(handle, std::move(certificate));
968 void WebView::OnHttpAuthenticationRequest(std::shared_ptr<Dali::WebEngineHttpAuthHandler> handler)
970 if(!mHttpAuthHandlerSignal.Empty())
972 Dali::Toolkit::WebView handle(GetOwner());
973 mHttpAuthHandlerSignal.Emit(handle, std::move(handler));
977 void WebView::OnContextMenuCustomized(std::shared_ptr<Dali::WebEngineContextMenu> menu)
979 if(!mContextMenuCustomizedSignal.Empty())
981 Dali::Toolkit::WebView handle(GetOwner());
982 mContextMenuCustomizedSignal.Emit(handle, std::move(menu));
986 void WebView::OnContextMenuItemSelected(std::shared_ptr<Dali::WebEngineContextMenuItem> item)
988 if(!mContextMenuItemSelectedSignal.Empty())
990 Dali::Toolkit::WebView handle(GetOwner());
991 mContextMenuItemSelectedSignal.Emit(handle, std::move(item));
995 bool WebView::DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor)
997 Dali::BaseHandle handle(object);
999 bool connected = false;
1000 Toolkit::WebView webView = Toolkit::WebView::DownCast(handle);
1002 if(0 == strcmp(signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL))
1004 webView.PageLoadStartedSignal().Connect(tracker, functor);
1007 else if(0 == strcmp(signalName.c_str(), PAGE_LOAD_IN_PROGRESS_SIGNAL))
1009 webView.PageLoadInProgressSignal().Connect(tracker, functor);
1012 else if(0 == strcmp(signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL))
1014 webView.PageLoadFinishedSignal().Connect(tracker, functor);
1017 else if(0 == strcmp(signalName.c_str(), PAGE_LOAD_ERROR_SIGNAL))
1019 webView.PageLoadErrorSignal().Connect(tracker, functor);
1022 else if(0 == strcmp(signalName.c_str(), SCROLL_EDGE_REACHED_SIGNAL))
1024 webView.ScrollEdgeReachedSignal().Connect(tracker, functor);
1027 else if(0 == strcmp(signalName.c_str(), URL_CHANGED_SIGNAL))
1029 webView.UrlChangedSignal().Connect(tracker, functor);
1032 else if(0 == strcmp(signalName.c_str(), FORM_REPOST_DECISION_SIGNAL))
1034 webView.FormRepostDecisionSignal().Connect(tracker, functor);
1037 else if(0 == strcmp(signalName.c_str(), FRAME_RENDERED_SIGNAL))
1039 webView.FrameRenderedSignal().Connect(tracker, functor);
1042 else if(0 == strcmp(signalName.c_str(), REQUEST_INTERCEPTOR_SIGNAL))
1044 webView.RequestInterceptorSignal().Connect(tracker, functor);
1047 else if(0 == strcmp(signalName.c_str(), CONSOLE_MESSAGE_SIGNAL))
1049 webView.ConsoleMessageSignal().Connect(tracker, functor);
1052 else if(0 == strcmp(signalName.c_str(), POLICY_DECISION))
1054 webView.PolicyDecisionSignal().Connect(tracker, functor);
1057 else if(0 == strcmp(signalName.c_str(), CERTIFICATE_CONFIRM_SIGNAL))
1059 webView.CertificateConfirmSignal().Connect(tracker, functor);
1062 else if(0 == strcmp(signalName.c_str(), SSL_CERTIFICATE_CHANGED_SIGNAL))
1064 webView.SslCertificateChangedSignal().Connect(tracker, functor);
1067 else if(0 == strcmp(signalName.c_str(), HTTP_AUTH_REQUEST_SIGNAL))
1069 webView.HttpAuthHandlerSignal().Connect(tracker, functor);
1072 else if(0 == strcmp(signalName.c_str(), CONTEXT_MENU_CUSTOMIZED_SIGNAL))
1074 webView.ContextMenuCustomizedSignal().Connect(tracker, functor);
1077 else if(0 == strcmp(signalName.c_str(), CONTEXT_MENU_ITEM_SELECTED_SIGNAL))
1079 webView.ContextMenuItemSelectedSignal().Connect(tracker, functor);
1086 Vector3 WebView::GetNaturalSize()
1090 Vector2 rendererNaturalSize;
1091 mVisual.GetNaturalSize(rendererNaturalSize);
1092 return Vector3(rendererNaturalSize);
1095 return Vector3(mWebViewSize);
1098 void WebView::OnSceneConnection(int depth)
1100 Control::OnSceneConnection(depth);
1102 EnableBlendMode(!mVideoHoleEnabled);
1105 void WebView::SetProperty(BaseObject* object, Property::Index index, const Property::Value& value)
1107 Toolkit::WebView webView = Toolkit::WebView::DownCast(Dali::BaseHandle(object));
1111 WebView& impl = GetImpl(webView);
1114 case Toolkit::WebView::Property::URL:
1123 case Toolkit::WebView::Property::USER_AGENT:
1126 if(value.Get(input))
1128 impl.SetUserAgent(input);
1132 case Toolkit::WebView::Property::SCROLL_POSITION:
1135 if(value.Get(input))
1137 impl.SetScrollPosition(input.x, input.y);
1141 case Toolkit::WebView::Property::VIDEO_HOLE_ENABLED:
1144 if(value.Get(input))
1146 impl.EnableVideoHole(input);
1150 case Toolkit::WebView::Property::MOUSE_EVENTS_ENABLED:
1153 if(value.Get(input))
1155 impl.EnableMouseEvents(input);
1159 case Toolkit::WebView::Property::KEY_EVENTS_ENABLED:
1162 if(value.Get(input))
1164 impl.EnableKeyEvents(input);
1168 case Toolkit::WebView::Property::DOCUMENT_BACKGROUND_COLOR:
1171 if(value.Get(input))
1173 impl.SetDocumentBackgroundColor(input);
1177 case Toolkit::WebView::Property::TILES_CLEARED_WHEN_HIDDEN:
1180 if(value.Get(input))
1182 impl.ClearTilesWhenHidden(input);
1186 case Toolkit::WebView::Property::TILE_COVER_AREA_MULTIPLIER:
1189 if(value.Get(input))
1191 impl.SetTileCoverAreaMultiplier(input);
1195 case Toolkit::WebView::Property::CURSOR_ENABLED_BY_CLIENT:
1198 if(value.Get(input))
1200 impl.EnableCursorByClient(input);
1204 case Toolkit::WebView::Property::PAGE_ZOOM_FACTOR:
1207 if(value.Get(input))
1209 impl.SetPageZoomFactor(input);
1213 case Toolkit::WebView::Property::TEXT_ZOOM_FACTOR:
1216 if(value.Get(input))
1218 impl.SetTextZoomFactor(input);
1228 Property::Value WebView::GetProperty(BaseObject* object, Property::Index propertyIndex)
1230 Property::Value value;
1232 Toolkit::WebView webView = Toolkit::WebView::DownCast(Dali::BaseHandle(object));
1236 WebView& impl = GetImpl(webView);
1237 switch(propertyIndex)
1239 case Toolkit::WebView::Property::URL:
1244 case Toolkit::WebView::Property::USER_AGENT:
1246 value = impl.GetUserAgent();
1249 case Toolkit::WebView::Property::SCROLL_POSITION:
1251 value = impl.GetScrollPosition();
1254 case Toolkit::WebView::Property::SCROLL_SIZE:
1256 value = impl.GetScrollSize();
1259 case Toolkit::WebView::Property::CONTENT_SIZE:
1261 value = impl.GetContentSize();
1264 case Toolkit::WebView::Property::TITLE:
1266 value = impl.GetTitle();
1269 case Toolkit::WebView::Property::VIDEO_HOLE_ENABLED:
1271 value = impl.mVideoHoleEnabled;
1274 case Toolkit::WebView::Property::MOUSE_EVENTS_ENABLED:
1276 value = impl.mMouseEventsEnabled;
1279 case Toolkit::WebView::Property::KEY_EVENTS_ENABLED:
1281 value = impl.mKeyEventsEnabled;
1284 case Toolkit::WebView::Property::SELECTED_TEXT:
1286 value = impl.GetSelectedText();
1289 case Toolkit::WebView::Property::PAGE_ZOOM_FACTOR:
1291 value = impl.GetPageZoomFactor();
1294 case Toolkit::WebView::Property::TEXT_ZOOM_FACTOR:
1296 value = impl.GetTextZoomFactor();
1299 case Toolkit::WebView::Property::LOAD_PROGRESS_PERCENTAGE:
1301 value = impl.GetLoadProgressPercentage();
1312 bool WebView::OnTouchEvent(Actor actor, const Dali::TouchEvent& touch)
1314 bool result = false;
1318 result = mWebEngine.SendTouchEvent(touch);
1323 bool WebView::OnKeyEvent(const Dali::KeyEvent& event)
1325 bool result = false;
1329 result = mWebEngine.SendKeyEvent(event);
1334 bool WebView::OnHoverEvent(Actor actor, const Dali::HoverEvent& hover)
1336 bool result = false;
1337 if(mWebEngine && mMouseEventsEnabled)
1339 result = mWebEngine.SendHoverEvent(hover);
1344 bool WebView::OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel)
1346 bool result = false;
1347 if(mWebEngine && mMouseEventsEnabled)
1349 result = mWebEngine.SendWheelEvent(wheel);
1354 void WebView::OnKeyInputFocusGained()
1358 mWebEngine.SetFocus(true);
1361 EmitKeyInputFocusSignal(true); // Calls back into the Control hence done last.
1364 void WebView::OnKeyInputFocusLost()
1368 mWebEngine.SetFocus(false);
1371 EmitKeyInputFocusSignal(false); // Calls back into the Control hence done last.
1374 void WebView::SetScrollPosition(int32_t x, int32_t y)
1378 mWebEngine.SetScrollPosition(x, y);
1382 Dali::Vector2 WebView::GetScrollPosition() const
1384 return mWebEngine ? mWebEngine.GetScrollPosition() : Dali::Vector2::ZERO;
1387 Dali::Vector2 WebView::GetScrollSize() const
1389 return mWebEngine ? mWebEngine.GetScrollSize() : Dali::Vector2::ZERO;
1392 Dali::Vector2 WebView::GetContentSize() const
1394 return mWebEngine ? mWebEngine.GetContentSize() : Dali::Vector2::ZERO;
1397 std::string WebView::GetTitle() const
1399 return mWebEngine ? mWebEngine.GetTitle() : kEmptyString;
1402 void WebView::SetDocumentBackgroundColor(Dali::Vector4 color)
1406 mWebEngine.SetDocumentBackgroundColor(color);
1410 void WebView::ClearTilesWhenHidden(bool cleared)
1414 mWebEngine.ClearTilesWhenHidden(cleared);
1418 void WebView::SetTileCoverAreaMultiplier(float multiplier)
1422 mWebEngine.SetTileCoverAreaMultiplier(multiplier);
1426 void WebView::EnableCursorByClient(bool enabled)
1430 mWebEngine.EnableCursorByClient(enabled);
1434 std::string WebView::GetSelectedText() const
1436 return mWebEngine ? mWebEngine.GetSelectedText() : kEmptyString;
1439 const std::string& WebView::GetUserAgent() const
1441 return mWebEngine ? mWebEngine.GetUserAgent() : kEmptyString;
1444 void WebView::SetUserAgent(const std::string& userAgent)
1448 mWebEngine.SetUserAgent(userAgent);
1452 void WebView::EnableMouseEvents(bool enabled)
1456 mMouseEventsEnabled = enabled;
1457 mWebEngine.EnableMouseEvents(enabled);
1461 void WebView::EnableKeyEvents(bool enabled)
1465 mKeyEventsEnabled = enabled;
1466 mWebEngine.EnableKeyEvents(enabled);
1470 void WebView::SetPageZoomFactor(float zoomFactor)
1474 mWebEngine.SetPageZoomFactor(zoomFactor);
1478 float WebView::GetPageZoomFactor() const
1480 return mWebEngine ? mWebEngine.GetPageZoomFactor() : 0.0f;
1483 void WebView::SetTextZoomFactor(float zoomFactor)
1487 mWebEngine.SetTextZoomFactor(zoomFactor);
1491 float WebView::GetTextZoomFactor() const
1493 return mWebEngine ? mWebEngine.GetTextZoomFactor() : 0.0f;
1496 float WebView::GetLoadProgressPercentage() const
1498 return mWebEngine ? mWebEngine.GetLoadProgressPercentage() : 0.0f;
1501 bool WebView::SetVisibility(bool visible)
1503 return mWebEngine ? mWebEngine.SetVisibility(visible) : false;
1506 #undef GET_ENUM_STRING
1507 #undef GET_ENUM_VALUE
1509 } // namespace Internal
1511 } // namespace Toolkit