2 * Copyright (c) 2018 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"
23 #include <dali/devel-api/scripting/enum-helper.h>
24 #include <dali/devel-api/scripting/scripting.h>
25 #include <dali/public-api/common/stage.h>
26 #include <dali/public-api/images/native-image.h>
27 #include <dali/public-api/adaptor-framework/native-image-source.h>
28 #include <dali/public-api/object/type-registry.h>
29 #include <dali/public-api/object/type-registry-helper.h>
32 #include <dali-toolkit/devel-api/controls/control-devel.h>
33 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
49 return Toolkit::WebView::New();
52 DALI_ENUM_TO_STRING_TABLE_BEGIN( CacheModel )
53 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_VIEWER )
54 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, DOCUMENT_BROWSER )
55 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CacheModel, PRIMARY_WEB_BROWSER )
56 DALI_ENUM_TO_STRING_TABLE_END( CacheModel )
58 DALI_ENUM_TO_STRING_TABLE_BEGIN( CookieAcceptPolicy )
59 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, ALWAYS )
60 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NEVER )
61 DALI_ENUM_TO_STRING_WITH_SCOPE( Toolkit::WebView::CookieAcceptPolicy, NO_THIRD_PARTY )
62 DALI_ENUM_TO_STRING_TABLE_END( CookieAcceptPolicy )
64 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::WebView, Toolkit::Control, Create )
66 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "url", STRING, URL )
67 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cacheModel", STRING, CACHE_MODEL )
68 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "cookieAcceptPolicy", STRING, COOKIE_ACCEPT_POLICY )
69 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "userAgent", STRING, USER_AGENT )
70 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "enableJavaScript", BOOLEAN, ENABLE_JAVASCRIPT )
71 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "loadImagesAutomatically", BOOLEAN, LOAD_IMAGES_AUTOMATICALLY )
72 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultTextEncodingName", STRING, DEFAULT_TEXT_ENCODING_NAME )
73 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "defaultFontSize", INTEGER, DEFAULT_FONT_SIZE )
75 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadStarted", PAGE_LOAD_STARTED_SIGNAL )
76 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadFinished", PAGE_LOAD_FINISHED_SIGNAL )
77 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadError", PAGE_LOAD_ERROR_SIGNAL )
79 DALI_TYPE_REGISTRATION_END()
81 const std::string kEmptyString;
83 } // anonymous namepsace
85 #define GET_ENUM_STRING( structName, inputExp ) \
86 Scripting::GetLinearEnumerationName< Toolkit::WebView::structName::Type >( static_cast< Toolkit::WebView::structName::Type >( inputExp ), structName##_TABLE, structName##_TABLE_COUNT )
88 #define GET_ENUM_VALUE( structName, inputExp, outputExp ) \
89 Scripting::GetEnumerationProperty< Toolkit::WebView::structName::Type >( inputExp, structName##_TABLE, structName##_TABLE_COUNT, outputExp )
91 WebView::WebView( const std::string& locale, const std::string& timezoneId )
92 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS ) ),
95 mWebViewSize( Stage::GetCurrent().GetSize() ),
97 mPageLoadStartedSignal(),
98 mPageLoadFinishedSignal(),
99 mPageLoadErrorSignal()
101 mWebEngine = Dali::WebEngine::New();
103 // WebEngine is empty when it is not properly initialized.
106 mWebEngine.Create( mWebViewSize.width, mWebViewSize.height, locale, timezoneId );
119 Toolkit::WebView WebView::New()
121 WebView* impl = new WebView();
122 Toolkit::WebView handle = Toolkit::WebView( *impl );
128 Toolkit::WebView WebView::New( const std::string& locale, const std::string& timezoneId )
130 WebView* impl = new WebView( locale, timezoneId );
131 Toolkit::WebView handle = Toolkit::WebView( *impl );
137 void WebView::OnInitialize()
139 Self().SetKeyboardFocusable( true );
140 Self().TouchSignal().Connect( this, &WebView::OnTouchEvent );
144 mWebEngine.PageLoadStartedSignal().Connect( this, &WebView::OnPageLoadStarted );
145 mWebEngine.PageLoadFinishedSignal().Connect( this, &WebView::OnPageLoadFinished );
146 mWebEngine.PageLoadErrorSignal().Connect( this, &WebView::OnPageLoadError );
150 void WebView::LoadUrl( const std::string& url )
155 Dali::Image image = Dali::NativeImage::New( *mWebEngine.GetNativeImageSource() );
156 mVisual = Toolkit::VisualFactory::Get().CreateVisual( image );
160 // Clean up previously registered visual and add new one.
161 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
162 mWebEngine.LoadUrl( url );
167 void WebView::LoadHTMLString( const std::string& htmlString )
171 Dali::Image image = Dali::NativeImage::New( *mWebEngine.GetNativeImageSource() );
172 mVisual = Toolkit::VisualFactory::Get().CreateVisual( image );
176 DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
177 mWebEngine.LoadHTMLString( htmlString );
182 void WebView::Reload()
190 void WebView::StopLoading()
194 mWebEngine.StopLoading();
198 void WebView::Suspend()
202 mWebEngine.Suspend();
206 void WebView::Resume()
214 bool WebView::CanGoForward()
216 return mWebEngine ? mWebEngine.CanGoForward() : false;
219 void WebView::GoForward()
223 mWebEngine.GoForward();
227 bool WebView::CanGoBack()
229 return mWebEngine ? mWebEngine.CanGoBack() : false;
232 void WebView::GoBack()
240 void WebView::EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler )
244 mWebEngine.EvaluateJavaScript( script, resultHandler );
248 void WebView::AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler )
252 mWebEngine.AddJavaScriptMessageHandler( exposedObjectName, handler );
256 void WebView::ClearHistory()
260 mWebEngine.ClearHistory();
264 void WebView::ClearCache()
268 mWebEngine.ClearCache();
272 void WebView::ClearCookies()
276 mWebEngine.ClearCookies();
280 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadStartedSignal()
282 return mPageLoadStartedSignal;
285 Dali::Toolkit::WebView::WebViewPageLoadSignalType& WebView::PageLoadFinishedSignal()
287 return mPageLoadFinishedSignal;
290 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& WebView::PageLoadErrorSignal()
292 return mPageLoadErrorSignal;
295 void WebView::OnPageLoadStarted( const std::string& url )
297 if( !mPageLoadStartedSignal.Empty() )
299 Dali::Toolkit::WebView handle( GetOwner() );
300 mPageLoadStartedSignal.Emit( handle, url );
304 void WebView::OnPageLoadFinished( const std::string& url )
306 if( !mPageLoadFinishedSignal.Empty() )
308 Dali::Toolkit::WebView handle( GetOwner() );
309 mPageLoadFinishedSignal.Emit( handle, url );
313 void WebView::OnPageLoadError( const std::string& url, int errorCode )
315 if( !mPageLoadErrorSignal.Empty() )
317 Dali::Toolkit::WebView handle( GetOwner() );
318 mPageLoadErrorSignal.Emit( handle, url, static_cast< Toolkit::WebView::LoadErrorCode >( errorCode ) );
322 bool WebView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
324 Dali::BaseHandle handle( object );
326 bool connected = false;
327 Toolkit::WebView webView = Toolkit::WebView::DownCast( handle );
329 if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL ) )
331 webView.PageLoadStartedSignal().Connect( tracker, functor );
334 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL ) )
336 webView.PageLoadFinishedSignal().Connect( tracker, functor );
339 else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_ERROR_SIGNAL ) )
341 webView.PageLoadErrorSignal().Connect( tracker, functor );
348 Vector3 WebView::GetNaturalSize()
352 Vector2 rendererNaturalSize;
353 mVisual.GetNaturalSize( rendererNaturalSize );
354 return Vector3( rendererNaturalSize );
357 return Vector3( mWebViewSize );
360 void WebView::OnRelayout( const Vector2& size, RelayoutContainer& container )
362 Control::OnRelayout( size, container );
364 if( size.width > 0 && size.height > 0 && mWebViewSize != size )
370 mWebEngine.SetSize( size.width, size.height );
375 void WebView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
377 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
381 WebView& impl = GetImpl( webView );
384 case Toolkit::WebView::Property::URL:
387 if( value.Get( url ) )
393 case Toolkit::WebView::Property::CACHE_MODEL:
395 Toolkit::WebView::CacheModel::Type output = impl.GetCacheModel();
396 GET_ENUM_VALUE( CacheModel, value, output );
397 impl.SetCacheModel( output );
400 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
402 Toolkit::WebView::CookieAcceptPolicy::Type output = impl.GetCookieAcceptPolicy();
403 GET_ENUM_VALUE( CookieAcceptPolicy, value, output );
404 impl.SetCookieAcceptPolicy( output );
407 case Toolkit::WebView::Property::USER_AGENT:
410 if( value.Get( input ) )
412 impl.SetUserAgent( input );
416 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
419 if( value.Get( input ) )
421 impl.EnableJavaScript( input );
425 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
428 if( value.Get( input ) )
430 impl.LoadImagesAutomatically( input );
434 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
437 if( value.Get( input ) )
439 impl.SetDefaultTextEncodingName( input );
443 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
446 if( value.Get( input ) )
448 impl.SetDefaultFontSize( input );
456 Property::Value WebView::GetProperty( BaseObject* object, Property::Index propertyIndex )
458 Property::Value value;
460 Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
464 WebView& impl = GetImpl( webView );
465 switch( propertyIndex )
467 case Toolkit::WebView::Property::URL:
472 case Toolkit::WebView::Property::CACHE_MODEL:
474 value = GET_ENUM_STRING( CacheModel, impl.GetCacheModel() );
477 case Toolkit::WebView::Property::COOKIE_ACCEPT_POLICY:
479 value = GET_ENUM_STRING( CookieAcceptPolicy, impl.GetCookieAcceptPolicy() );
482 case Toolkit::WebView::Property::USER_AGENT:
484 value = impl.GetUserAgent();
487 case Toolkit::WebView::Property::ENABLE_JAVASCRIPT:
489 value = impl.IsJavaScriptEnabled();
492 case Toolkit::WebView::Property::LOAD_IMAGES_AUTOMATICALLY:
494 value = impl.AreImagesAutomaticallyLoaded();
497 case Toolkit::WebView::Property::DEFAULT_TEXT_ENCODING_NAME:
499 value = impl.GetDefaultTextEncodingName();
502 case Toolkit::WebView::Property::DEFAULT_FONT_SIZE:
504 value = impl.GetDefaultFontSize();
515 bool WebView::OnTouchEvent( Actor actor, const Dali::TouchData& touch )
521 result = mWebEngine.SendTouchEvent( touch );
526 bool WebView::OnKeyEvent( const Dali::KeyEvent& event )
532 result = mWebEngine.SendKeyEvent( event );
537 Toolkit::WebView::CacheModel::Type WebView::GetCacheModel() const
539 return mWebEngine ? static_cast< Toolkit::WebView::CacheModel::Type >( mWebEngine.GetCacheModel() ) : Toolkit::WebView::CacheModel::DOCUMENT_VIEWER;
542 void WebView::SetCacheModel( Toolkit::WebView::CacheModel::Type cacheModel )
546 mWebEngine.SetCacheModel( static_cast< WebEnginePlugin::CacheModel >( cacheModel ) );
550 Toolkit::WebView::CookieAcceptPolicy::Type WebView::GetCookieAcceptPolicy() const
552 return mWebEngine ? static_cast< Toolkit::WebView::CookieAcceptPolicy::Type >( mWebEngine.GetCookieAcceptPolicy() ) : Toolkit::WebView::CookieAcceptPolicy::NO_THIRD_PARTY;
555 void WebView::SetCookieAcceptPolicy( Toolkit::WebView::CookieAcceptPolicy::Type policy )
559 mWebEngine.SetCookieAcceptPolicy( static_cast< WebEnginePlugin::CookieAcceptPolicy >( policy ) );
563 const std::string& WebView::GetUserAgent() const
565 return mWebEngine ? mWebEngine.GetUserAgent() : kEmptyString;
568 void WebView::SetUserAgent( const std::string& userAgent )
572 mWebEngine.SetUserAgent( userAgent );
576 bool WebView::IsJavaScriptEnabled() const
578 return mWebEngine ? mWebEngine.IsJavaScriptEnabled() : true;
581 void WebView::EnableJavaScript( bool enabled )
585 mWebEngine.EnableJavaScript( enabled );
589 bool WebView::AreImagesAutomaticallyLoaded() const
591 return mWebEngine ? mWebEngine.AreImagesAutomaticallyLoaded() : true;
594 void WebView::LoadImagesAutomatically( bool automatic )
598 mWebEngine.LoadImagesAutomatically( automatic );
602 const std::string& WebView::GetDefaultTextEncodingName() const
604 return mWebEngine ? mWebEngine.GetDefaultTextEncodingName() : kEmptyString;
607 void WebView::SetDefaultTextEncodingName( const std::string& defaultTextEncodingName )
611 mWebEngine.SetDefaultTextEncodingName( defaultTextEncodingName );
615 int WebView::GetDefaultFontSize() const
617 return mWebEngine ? mWebEngine.GetDefaultFontSize() : 0;
620 void WebView::SetDefaultFontSize( int defaultFontSize )
624 mWebEngine.SetDefaultFontSize( defaultFontSize );
628 #undef GET_ENUM_STRING
629 #undef GET_ENUM_VALUE
631 } // namespace Internal
633 } // namespace Toolkit