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>
27 #include <dali-toolkit/devel-api/controls/web-view/web-view.h>
28 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
29 #include <dali-toolkit/public-api/controls/control-impl.h>
30 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
40 class WebBackForwardList;
42 class WebCookieManager;
49 class WebView : public Control
55 WebView( const std::string& locale, const std::string& timezoneId );
57 WebView( int argc, char** argv );
64 * @copydoc Dali::Toolkit::WebView::New()
66 static Toolkit::WebView New();
69 * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
71 static Toolkit::WebView New( const std::string& locale, const std::string& timezoneId );
74 * @brief Get settings of WebEngine.
76 Dali::Toolkit::WebSettings* GetSettings() const;
79 * @brief Get context of WebEngine.
81 Dali::Toolkit::WebContext* GetContext() const;
84 * @brief Get cookie manager of WebEngine.
86 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
89 * @brief Get WebBackForwardList of WebEngine.
91 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
94 * @copydoc Dali::Toolkit::WebView::New( int, char** )
96 static Toolkit::WebView New( int argc, char** argv );
99 * @brief Get Favicon of web page.
101 * @return Handle to a fav icon
103 Dali::Toolkit::ImageView& GetFavicon();
106 * @copydoc Dali::Toolkit::WebView::LoadUrl()
108 void LoadUrl( const std::string& url );
111 * @copydoc Dali::WebEngine::LoadHTMLString()
113 void LoadHtmlString( const std::string& htmlString );
116 * @copydoc Dali::Toolkit::WebView::Reload()
121 * @copydoc Dali::Toolkit::WebView::StopLoading()
126 * @copydoc Dali::Toolkit::WebView::StopLoading()
131 * @copydoc Dali::Toolkit::WebView::Resume()
136 * @copydoc Dali::Toolkit::WebView::ScrollBy()
138 void ScrollBy( int deltaX, int deltaY );
141 * @copydoc Dali::Toolkit::WebView::CanGoForward()
146 * @copydoc Dali::Toolkit::WebView::GoForward()
151 * @copydoc Dali::Toolkit::WebView::CanGoBack()
156 * @copydoc Dali::Toolkit::WebView::GoBack()
161 * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
163 void EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler );
166 * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
168 void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler );
171 * @brief Clears all tiles resources of Web.
173 void ClearAllTilesResources();
176 * @copydoc Dali::Toolkit::WebView::ClearHistory()
181 * @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
183 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
186 * @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
188 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
191 * @copydoc Dali::Toolkit::WebView::PageLoadErrorSignal()
193 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
196 * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
198 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
200 public: // Properties
203 * @brief Called when a property of an object of this type is set.
205 * @param[in] object The object whose property is set.
206 * @param[in] index The property index.
207 * @param[in] value The new property value.
209 static void SetProperty( Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value );
212 * @brief Called to retrieve a property of an object of this type.
214 * @param[in] object The object whose property is to be retrieved.
215 * @param[in] index The property index.
216 * @return The current value of the property.
218 static Dali::Property::Value GetProperty( Dali::BaseObject* object, Dali::Property::Index propertyIndex );
221 * Connects a callback function with the object's signals.
222 * @param[in] object The object providing the signal.
223 * @param[in] tracker Used to disconnect the signal.
224 * @param[in] signalName The signal to connect to.
225 * @param[in] functor A newly allocated FunctorDelegate.
226 * @return True if the signal was connected.
227 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
229 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
231 private: // From Control
234 * @copydoc Toolkit::Control::OnInitialize()
236 void OnInitialize() override;
239 * @copydoc Toolkit::Control::GetNaturalSize
241 Vector3 GetNaturalSize() override;
244 * @copydoc Toolkit::Control::OnRelayout()
246 void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
249 * Signal occurs when the Web View has been touched.
250 * @param[in] actor The Actor Touched
251 * @param[in] touch The Touch Data.
252 * @return Whether to consume event or not.
254 bool OnTouchEvent( Actor actor, const Dali::TouchEvent& touch );
257 * @copydoc Toolkit::Control::OnKeyEvent()
259 bool OnKeyEvent( const Dali::KeyEvent& event ) override;
262 * @copydoc Toolkit::Control::OnKeyInputFocusGained()
264 void OnKeyInputFocusGained() override;
267 * @copydoc Toolkit::Control::OnKeyInputFocusLost()
269 void OnKeyInputFocusLost() override;
274 WebView( const WebView& webView );
276 WebView& operator=( const WebView& webView );
279 * @brief Sets an absolute scroll of the given view.
280 * @param[in] x The coordinate x of scroll
281 * @param[in] y The coordinate y of scroll
283 void SetScrollPosition( int x, int y );
286 * @brief Gets the current scroll position of the given view.
287 * @param[out] x The coordinate x of scroll
288 * @param[out] y The coordinate y of scroll
290 void GetScrollPosition( int& x, int& y ) const;
293 * @brief Gets the possible scroll size of the given view.
294 * @param[out] width The width of scroll size
295 * @param[out] height The height of scroll size
297 void GetScrollSize( int& width, int& height ) const;
300 * @brief Gets the last known content's size.
301 * @param[out] width The width of content's size
302 * @param[out] height The height of content's size
304 void GetContentSize( int& width, int& height ) const;
307 * @brief Returns the title of the Web.
309 * @return The title of web page
311 std::string GetTitle() const;
314 * @brief Get user agent string.
315 * @return The string value of user agent
317 const std::string& GetUserAgent() const;
320 * @brief Set user agent string.
321 * @param[in] userAgent The string value of user agent
323 void SetUserAgent( const std::string& userAgent );
326 * @brief Callback function to be called when page load started.
327 * @param[in] url The url currently being loaded
329 void OnPageLoadStarted( const std::string& url );
332 * @brief Callback function to be called when page load finished.
333 * @param[in] url The url currently being loaded
335 void OnPageLoadFinished( const std::string& url );
338 * @brief Callback function to be called when there is an error in page loading.
339 * @param[in] url The url currently being loaded
340 * @param[in] errorCode The error code
342 void OnPageLoadError( const std::string& url, int errorCode );
345 * @brief Callback function to be called when scroll edge is reached.
346 * @param[in] e The scroll edge reached.
348 void OnScrollEdgeReached( Dali::WebEnginePlugin::ScrollEdge edge );
353 Dali::Toolkit::Visual::Base mVisual;
354 Dali::Size mWebViewSize;
355 Dali::WebEngine mWebEngine;
357 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadStartedSignal;
358 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadFinishedSignal;
359 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType mPageLoadErrorSignal;
360 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType mScrollEdgeReachedSignal;
362 std::unique_ptr<Dali::Toolkit::WebContext> mWebContext;
363 std::unique_ptr<Dali::Toolkit::WebCookieManager> mWebCookieManager;
364 std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
365 std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
366 Dali::Toolkit::ImageView mFaviconView;
369 } // namespace Internal
371 inline Toolkit::Internal::WebView& GetImpl( Toolkit::WebView& handle )
373 DALI_ASSERT_ALWAYS( handle );
374 Dali::RefObject& impl = handle.GetImplementation();
375 return static_cast< Toolkit::Internal::WebView& >( impl );
378 inline const Toolkit::Internal::WebView& GetImpl( const Toolkit::WebView& handle )
380 DALI_ASSERT_ALWAYS( handle );
381 const Dali::RefObject& impl = handle.GetImplementation();
382 return static_cast< const Toolkit::Internal::WebView& >( impl );
385 } // namespace Toolkit
389 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H