dali-toolkit/internal/controls/web-view/web-view-impl.cpp

   1 /*
   2  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include "web-view-impl.h"
  20
  21 // EXTERNAL INCLUDES
  22 #include <cstring>
  23 #include <dali/public-api/common/stage.h>
  24 #include <dali/public-api/images/native-image.h>
  25 #include <dali/public-api/adaptor-framework/native-image-source.h>
  26 #include <dali/public-api/object/type-registry.h>
  27 #include <dali/public-api/object/type-registry-helper.h>
  28
  29 // INTERNAL INCLUDES
  30 #include <dali-toolkit/devel-api/controls/control-devel.h>
  31 #include <dali-toolkit/internal/visuals/visual-factory-impl.h>
  32
  33 namespace Dali
  34 {
  35
  36 namespace Toolkit
  37 {
  38
  39 namespace Internal
  40 {
  41
  42 namespace
  43 {
  44
  45 BaseHandle Create()
  46 {
  47   return Toolkit::WebView::New();
  48 }
  49
  50 DALI_TYPE_REGISTRATION_BEGIN( Toolkit::WebView, Toolkit::Control, Create );
  51
  52 DALI_PROPERTY_REGISTRATION( Toolkit, WebView, "url", STRING, URL );
  53
  54 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadStarted", PAGE_LOAD_STARTED_SIGNAL );
  55 DALI_SIGNAL_REGISTRATION( Toolkit, WebView, "pageLoadFinished", PAGE_LOAD_FINISHED_SIGNAL );
  56
  57 DALI_TYPE_REGISTRATION_END()
  58
  59 } // anonymous namepsace
  60
  61 WebView::WebView( const std::string& locale, const std::string& timezoneId )
  62 : Control( ControlBehaviour( ACTOR_BEHAVIOUR_DEFAULT | DISABLE_STYLE_CHANGE_SIGNALS ) ),
  63   mUrl(),
  64   mVisual(),
  65   mWebViewSize( Stage::GetCurrent().GetSize() ),
  66   mWebEngine(),
  67   mPageLoadStartedSignal(),
  68   mPageLoadFinishedSignal()
  69 {
  70   mWebEngine = Dali::WebEngine::New();
  71   if ( mWebEngine )
  72   {
  73     mWebEngine.Create( mWebViewSize.width, mWebViewSize.height, locale, timezoneId );
  74   }
  75 }
  76
  77 WebView::WebView()
  78 : WebView( "", "" )
  79 {
  80 }
  81
  82 WebView::~WebView()
  83 {
  84 }
  85
  86 Toolkit::WebView WebView::New()
  87 {
  88   WebView* impl = new WebView();
  89   Toolkit::WebView handle = Toolkit::WebView( *impl );
  90
  91   impl->Initialize();
  92   return handle;
  93 }
  94
  95 Toolkit::WebView WebView::New( const std::string& locale, const std::string& timezoneId )
  96 {
  97   WebView* impl = new WebView( locale, timezoneId );
  98   Toolkit::WebView handle = Toolkit::WebView( *impl );
  99
 100   impl->Initialize();
 101   return handle;
 102 }
 103
 104 void WebView::OnInitialize()
 105 {
 106   Self().SetKeyboardFocusable( true );
 107   Self().TouchSignal().Connect( this, &WebView::OnTouchEvent );
 108
 109   if ( mWebEngine )
 110   {
 111     mWebEngine.PageLoadStartedSignal().Connect( this, &WebView::OnPageLoadStarted );
 112     mWebEngine.PageLoadFinishedSignal().Connect( this, &WebView::OnPageLoadFinished );
 113   }
 114 }
 115
 116 void WebView::LoadUrl( const std::string& url )
 117 {
 118   mUrl = url;
 119   if ( mWebEngine )
 120   {
 121     Dali::Image image = Dali::NativeImage::New( *mWebEngine.GetNativeImageSource() );
 122     mVisual = Toolkit::VisualFactory::Get().CreateVisual( image );
 123
 124     if ( mVisual )
 125     {
 126       // Clean up previously registered visual and add new one.
 127       DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
 128       mWebEngine.LoadUrl( url );
 129     }
 130   }
 131 }
 132
 133 const std::string& WebView::GetUrl()
 134 {
 135   return mWebEngine ? mWebEngine.GetUrl() : mUrl;
 136 }
 137
 138 void WebView::LoadHTMLString( const std::string& htmlString )
 139 {
 140   if ( mWebEngine )
 141   {
 142     Dali::Image image = Dali::NativeImage::New( *mWebEngine.GetNativeImageSource() );
 143     mVisual = Toolkit::VisualFactory::Get().CreateVisual( image );
 144
 145     if ( mVisual )
 146     {
 147       DevelControl::RegisterVisual( *this, Toolkit::WebView::Property::URL, mVisual );
 148       mWebEngine.LoadHTMLString( htmlString );
 149     }
 150   }
 151 }
 152
 153 void WebView::Reload()
 154 {
 155   if ( mWebEngine )
 156   {
 157     mWebEngine.Reload();
 158   }
 159 }
 160
 161 void WebView::StopLoading()
 162 {
 163   if ( mWebEngine )
 164   {
 165     mWebEngine.StopLoading();
 166   }
 167 }
 168
 169 bool WebView::CanGoForward()
 170 {
 171   return mWebEngine ? mWebEngine.CanGoForward() : false;
 172 }
 173
 174 void WebView::GoForward()
 175 {
 176   if ( mWebEngine )
 177   {
 178     mWebEngine.GoForward();
 179   }
 180 }
 181
 182 bool WebView::CanGoBack()
 183 {
 184   return mWebEngine ? mWebEngine.CanGoBack() : false;
 185 }
 186
 187 void WebView::GoBack()
 188 {
 189   if ( mWebEngine )
 190   {
 191     mWebEngine.GoBack();
 192   }
 193 }
 194
 195 void WebView::EvaluateJavaScript( const std::string& script )
 196 {
 197   if ( mWebEngine )
 198   {
 199     mWebEngine.EvaluateJavaScript( script );
 200   }
 201 }
 202
 203 void WebView::AddJavaScriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName, std::function< std::string(const std::string&) > callback )
 204 {
 205   if ( mWebEngine )
 206   {
 207     mWebEngine.AddJavaScriptInterface( exposedObjectName, jsFunctionName, callback );
 208   }
 209 }
 210
 211 void WebView::RemoveJavascriptInterface( const std::string& exposedObjectName, const std::string& jsFunctionName )
 212 {
 213   if ( mWebEngine )
 214   {
 215     mWebEngine.RemoveJavascriptInterface( exposedObjectName, jsFunctionName );
 216   }
 217 }
 218
 219 void WebView::ClearHistory()
 220 {
 221   if ( mWebEngine )
 222   {
 223     mWebEngine.ClearHistory();
 224   }
 225 }
 226
 227 void WebView::ClearCache()
 228 {
 229   if ( mWebEngine )
 230   {
 231     mWebEngine.ClearCache();
 232   }
 233 }
 234
 235 Dali::Toolkit::WebView::WebViewSignalType& WebView::PageLoadStartedSignal()
 236 {
 237   return mPageLoadStartedSignal;
 238 }
 239
 240 Dali::Toolkit::WebView::WebViewSignalType& WebView::PageLoadFinishedSignal()
 241 {
 242   return mPageLoadFinishedSignal;
 243 }
 244
 245 void WebView::OnPageLoadStarted( const std::string& url )
 246 {
 247   if( !mPageLoadStartedSignal.Empty() )
 248   {
 249     Dali::Toolkit::WebView handle( GetOwner() );
 250     mPageLoadStartedSignal.Emit( handle, url );
 251   }
 252 }
 253
 254 void WebView::OnPageLoadFinished( const std::string& url )
 255 {
 256   if( !mPageLoadFinishedSignal.Empty() )
 257   {
 258     Dali::Toolkit::WebView handle( GetOwner() );
 259     mPageLoadFinishedSignal.Emit( handle, url );
 260   }
 261 }
 262
 263 bool WebView::DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor )
 264 {
 265   Dali::BaseHandle handle( object );
 266
 267   bool connected = false;
 268   Toolkit::WebView webView = Toolkit::WebView::DownCast( handle );
 269
 270   if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_STARTED_SIGNAL ) )
 271   {
 272     webView.PageLoadStartedSignal().Connect( tracker, functor );
 273     connected = true;
 274   }
 275   else if( 0 == strcmp( signalName.c_str(), PAGE_LOAD_FINISHED_SIGNAL ) )
 276   {
 277     webView.PageLoadFinishedSignal().Connect( tracker, functor );
 278     connected = true;
 279   }
 280
 281   return connected;
 282 }
 283
 284 Vector3 WebView::GetNaturalSize()
 285 {
 286   if( mVisual )
 287   {
 288     Vector2 rendererNaturalSize;
 289     mVisual.GetNaturalSize( rendererNaturalSize );
 290     return Vector3( rendererNaturalSize );
 291   }
 292
 293   return Vector3( mWebViewSize );
 294 }
 295
 296 void WebView::OnRelayout( const Vector2& size, RelayoutContainer& container )
 297 {
 298   Control::OnRelayout( size, container );
 299
 300   if( size.width > 0 && size.height > 0 && mWebViewSize != size )
 301   {
 302     mWebViewSize = size;
 303
 304     if( mWebEngine )
 305     {
 306       mWebEngine.SetSize( size.width, size.height );
 307     }
 308   }
 309 }
 310
 311 void WebView::SetProperty( BaseObject* object, Property::Index index, const Property::Value& value )
 312 {
 313   Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
 314
 315   if( webView )
 316   {
 317     WebView& impl = GetImpl( webView );
 318     switch( index )
 319     {
 320       case Toolkit::WebView::Property::URL:
 321       {
 322         std::string url;
 323         if( value.Get( url ) )
 324         {
 325           impl.LoadUrl( url );
 326         }
 327         break;
 328       }
 329     }
 330   }
 331 }
 332
 333 Property::Value WebView::GetProperty( BaseObject* object, Property::Index propertyIndex )
 334 {
 335   Property::Value value;
 336
 337   Toolkit::WebView webView = Toolkit::WebView::DownCast( Dali::BaseHandle( object ) );
 338
 339   if( webView )
 340   {
 341     WebView& impl = GetImpl( webView );
 342     switch( propertyIndex )
 343     {
 344       case Toolkit::WebView::Property::URL:
 345       {
 346         value = impl.GetUrl();
 347         break;
 348       }
 349     }
 350   }
 351
 352   return value;
 353 }
 354
 355 bool WebView::OnTouchEvent( Actor actor, const Dali::TouchData& touch )
 356 {
 357   bool result = false;
 358
 359   if ( mWebEngine )
 360   {
 361     result = mWebEngine.SendTouchEvent( touch );
 362   }
 363   return result;
 364 }
 365
 366 bool WebView::OnKeyEvent( const Dali::KeyEvent& event )
 367 {
 368   bool result = false;
 369
 370   if ( mWebEngine )
 371   {
 372     result = mWebEngine.SendKeyEvent( event );
 373   }
 374   return result;
 375 }
 376
 377 } // namespace Internal
 378
 379 } // namespace Toolkit
 380
 381 } // namespace Dali