1 #ifndef DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
23 #include <dali/devel-api/adaptor-framework/web-engine.h>
24 #include <dali/public-api/images/image-operations.h>
25 #include <dali/public-api/object/property-notification.h>
28 #include <dali-toolkit/devel-api/controls/web-view/web-view.h>
29 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
30 #include <dali-toolkit/public-api/controls/control-impl.h>
31 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
41 class WebBackForwardList;
43 class WebCookieManager;
50 class WebView : public Control
56 WebView( const std::string& locale, const std::string& timezoneId );
58 WebView( int argc, char** argv );
65 * @copydoc Dali::Toolkit::WebView::New()
67 static Toolkit::WebView New();
70 * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
72 static Toolkit::WebView New( const std::string& locale, const std::string& timezoneId );
75 * @brief Get settings of WebEngine.
77 Dali::Toolkit::WebSettings* GetSettings() const;
80 * @brief Get context of WebEngine.
82 Dali::Toolkit::WebContext* GetContext() const;
85 * @brief Get cookie manager of WebEngine.
87 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
90 * @brief Get WebBackForwardList of WebEngine.
92 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
95 * @copydoc Dali::Toolkit::WebView::New( int, char** )
97 static Toolkit::WebView New( int argc, char** argv );
100 * @brief Get Favicon of web page.
102 * @return Handle to a fav icon
104 Dali::Toolkit::ImageView& GetFavicon();
107 * @copydoc Dali::Toolkit::WebView::LoadUrl()
109 void LoadUrl( const std::string& url );
112 * @copydoc Dali::WebEngine::LoadHTMLString()
114 void LoadHtmlString( const std::string& htmlString );
117 * @copydoc Dali::Toolkit::WebView::Reload()
122 * @copydoc Dali::Toolkit::WebView::StopLoading()
127 * @copydoc Dali::Toolkit::WebView::StopLoading()
132 * @copydoc Dali::Toolkit::WebView::Resume()
137 * @copydoc Dali::Toolkit::WebView::ScrollBy()
139 void ScrollBy( int deltaX, int deltaY );
142 * @copydoc Dali::Toolkit::WebView::CanGoForward()
147 * @copydoc Dali::Toolkit::WebView::GoForward()
152 * @copydoc Dali::Toolkit::WebView::CanGoBack()
157 * @copydoc Dali::Toolkit::WebView::GoBack()
162 * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
164 void EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler );
167 * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
169 void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler );
172 * @brief Clears all tiles resources of Web.
174 void ClearAllTilesResources();
177 * @copydoc Dali::Toolkit::WebView::ClearHistory()
182 * @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
184 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
187 * @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
189 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
192 * @copydoc Dali::Toolkit::WebView::PageLoadErrorSignal()
194 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
197 * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
199 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
201 public: // Properties
204 * @brief Called when a property of an object of this type is set.
206 * @param[in] object The object whose property is set.
207 * @param[in] index The property index.
208 * @param[in] value The new property value.
210 static void SetProperty( Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value );
213 * @brief Called to retrieve a property of an object of this type.
215 * @param[in] object The object whose property is to be retrieved.
216 * @param[in] index The property index.
217 * @return The current value of the property.
219 static Dali::Property::Value GetProperty( Dali::BaseObject* object, Dali::Property::Index propertyIndex );
222 * Connects a callback function with the object's signals.
223 * @param[in] object The object providing the signal.
224 * @param[in] tracker Used to disconnect the signal.
225 * @param[in] signalName The signal to connect to.
226 * @param[in] functor A newly allocated FunctorDelegate.
227 * @return True if the signal was connected.
228 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
230 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
232 private: // From Control
235 * @copydoc Toolkit::Control::OnInitialize()
237 void OnInitialize() override;
240 * @copydoc Toolkit::Control::GetNaturalSize
242 Vector3 GetNaturalSize() override;
245 * Signal occurs when the Web View has been touched.
246 * @param[in] actor The Actor Touched
247 * @param[in] touch The Touch Data.
248 * @return Whether to consume event or not.
250 bool OnTouchEvent( Actor actor, const Dali::TouchEvent& touch );
253 * @copydoc Toolkit::Control::OnKeyEvent()
255 bool OnKeyEvent( const Dali::KeyEvent& event ) override;
258 * @copydoc Toolkit::Control::OnKeyInputFocusGained()
260 void OnKeyInputFocusGained() override;
263 * @copydoc Toolkit::Control::OnKeyInputFocusLost()
265 void OnKeyInputFocusLost() override;
268 * @copydoc Toolkit::Control::OnSceneConnection()
270 void OnSceneConnection( int depth ) override;
275 WebView( const WebView& webView );
277 WebView& operator=( const WebView& webView );
280 * @brief Sets an absolute scroll of the given view.
281 * @param[in] x The coordinate x of scroll
282 * @param[in] y The coordinate y of scroll
284 void SetScrollPosition( int x, int y );
287 * @brief Gets the current scroll position of the given view.
288 * @param[out] x The coordinate x of scroll
289 * @param[out] y The coordinate y of scroll
291 void GetScrollPosition( int& x, int& y ) const;
294 * @brief Gets the possible scroll size of the given view.
295 * @param[out] width The width of scroll size
296 * @param[out] height The height of scroll size
298 void GetScrollSize( int& width, int& height ) const;
301 * @brief Gets the last known content's size.
302 * @param[out] width The width of content's size
303 * @param[out] height The height of content's size
305 void GetContentSize( int& width, int& height ) const;
308 * @brief Returns the title of the Web.
310 * @return The title of web page
312 std::string GetTitle() const;
315 * @brief Get user agent string.
316 * @return The string value of user agent
318 const std::string& GetUserAgent() const;
321 * @brief Set user agent string.
322 * @param[in] userAgent The string value of user agent
324 void SetUserAgent( const std::string& userAgent );
327 * @brief Updates display area of web view.
328 * @param[in] source The soource triggers Notification.
330 void UpdateDisplayArea( Dali::PropertyNotification& source );
333 * @brief Enable/Disable video hole for video playing.
334 * @param[in] enabled True if video hole is enabled, false otherwise.
336 void EnableVideoHole( bool enabled );
339 * @brief Enable blend mode.
340 * @param[in] blendEnabled True if turn on blend mode, false otherwise.
342 void EnableBlendMode( bool blendEnabled );
345 * @brief Callback function to be called when page load started.
346 * @param[in] url The url currently being loaded
348 void OnPageLoadStarted( const std::string& url );
351 * @brief Callback function to be called when page load finished.
352 * @param[in] url The url currently being loaded
354 void OnPageLoadFinished( const std::string& url );
357 * @brief Callback function to be called when there is an error in page loading.
358 * @param[in] url The url currently being loaded
359 * @param[in] errorCode The error code
361 void OnPageLoadError( const std::string& url, int errorCode );
364 * @brief Callback function to be called when scroll edge is reached.
365 * @param[in] e The scroll edge reached.
367 void OnScrollEdgeReached( Dali::WebEnginePlugin::ScrollEdge edge );
372 Dali::Toolkit::Visual::Base mVisual;
373 Dali::Size mWebViewSize;
374 Dali::WebEngine mWebEngine;
376 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadStartedSignal;
377 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadFinishedSignal;
378 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType mPageLoadErrorSignal;
379 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType mScrollEdgeReachedSignal;
381 std::unique_ptr<Dali::Toolkit::WebContext> mWebContext;
382 std::unique_ptr<Dali::Toolkit::WebCookieManager> mWebCookieManager;
383 std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
384 std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
385 Dali::Toolkit::ImageView mFaviconView;
387 Dali::PropertyNotification mPositionUpdateNotification;
388 Dali::PropertyNotification mSizeUpdateNotification;
389 Dali::PropertyNotification mScaleUpdateNotification;
390 bool mVideoHoleEnabled;
391 Dali::Rect< int > mWebViewArea;
394 } // namespace Internal
396 inline Toolkit::Internal::WebView& GetImpl( Toolkit::WebView& handle )
398 DALI_ASSERT_ALWAYS( handle );
399 Dali::RefObject& impl = handle.GetImplementation();
400 return static_cast< Toolkit::Internal::WebView& >( impl );
403 inline const Toolkit::Internal::WebView& GetImpl( const Toolkit::WebView& handle )
405 DALI_ASSERT_ALWAYS( handle );
406 const Dali::RefObject& impl = handle.GetImplementation();
407 return static_cast< const Toolkit::Internal::WebView& >( impl );
410 } // namespace Toolkit
414 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H