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>
39 class WebBackForwardList;
41 class WebCookieManager;
48 class WebView : public Control
54 WebView( const std::string& locale, const std::string& timezoneId );
61 * @copydoc Dali::Toolkit::WebView::New()
63 static Toolkit::WebView New();
66 * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
68 static Toolkit::WebView New( const std::string& locale, const std::string& timezoneId );
71 * @brief Get settings of WebEngine.
73 Dali::Toolkit::WebSettings* GetSettings() const;
76 * @brief Get context of WebEngine.
78 Dali::Toolkit::WebContext* GetContext() const;
81 * @brief Get cookie manager of WebEngine.
83 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
86 * @brief Get WebBackForwardList of WebEngine.
88 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
91 * @copydoc Dali::Toolkit::WebView::LoadUrl()
93 void LoadUrl( const std::string& url );
96 * @copydoc Dali::WebEngine::LoadHTMLString()
98 void LoadHtmlString( const std::string& htmlString );
101 * @copydoc Dali::Toolkit::WebView::Reload()
106 * @copydoc Dali::Toolkit::WebView::StopLoading()
111 * @copydoc Dali::Toolkit::WebView::StopLoading()
116 * @copydoc Dali::Toolkit::WebView::Resume()
121 * @copydoc Dali::Toolkit::WebView::ScrollBy()
123 void ScrollBy( int deltaX, int deltaY );
126 * @copydoc Dali::Toolkit::WebView::CanGoForward()
131 * @copydoc Dali::Toolkit::WebView::GoForward()
136 * @copydoc Dali::Toolkit::WebView::CanGoBack()
141 * @copydoc Dali::Toolkit::WebView::GoBack()
146 * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
148 void EvaluateJavaScript( const std::string& script, std::function< void( const std::string& ) > resultHandler );
151 * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
153 void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void( const std::string& ) > handler );
156 * @copydoc Dali::Toolkit::WebView::ClearHistory()
161 * @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
163 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
166 * @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
168 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
171 * @copydoc Dali::Toolkit::WebView::PageLoadErrorSignal()
173 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
176 * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
178 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
180 public: // Properties
183 * @brief Called when a property of an object of this type is set.
185 * @param[in] object The object whose property is set.
186 * @param[in] index The property index.
187 * @param[in] value The new property value.
189 static void SetProperty( Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value );
192 * @brief Called to retrieve a property of an object of this type.
194 * @param[in] object The object whose property is to be retrieved.
195 * @param[in] index The property index.
196 * @return The current value of the property.
198 static Dali::Property::Value GetProperty( Dali::BaseObject* object, Dali::Property::Index propertyIndex );
201 * Connects a callback function with the object's signals.
202 * @param[in] object The object providing the signal.
203 * @param[in] tracker Used to disconnect the signal.
204 * @param[in] signalName The signal to connect to.
205 * @param[in] functor A newly allocated FunctorDelegate.
206 * @return True if the signal was connected.
207 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
209 static bool DoConnectSignal( BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor );
211 private: // From Control
214 * @copydoc Toolkit::Control::OnInitialize()
216 void OnInitialize() override;
219 * @copydoc Toolkit::Control::GetNaturalSize
221 Vector3 GetNaturalSize() override;
224 * @copydoc Toolkit::Control::OnRelayout()
226 void OnRelayout( const Vector2& size, RelayoutContainer& container ) override;
229 * Signal occurs when the Web View has been touched.
230 * @param[in] actor The Actor Touched
231 * @param[in] touch The Touch Data.
232 * @return Whether to consume event or not.
234 bool OnTouchEvent( Actor actor, const Dali::TouchEvent& touch );
237 * @copydoc Toolkit::Control::OnKeyEvent()
239 bool OnKeyEvent( const Dali::KeyEvent& event ) override;
242 * @copydoc Toolkit::Control::OnKeyInputFocusGained()
244 void OnKeyInputFocusGained() override;
247 * @copydoc Toolkit::Control::OnKeyInputFocusLost()
249 void OnKeyInputFocusLost() override;
254 WebView( const WebView& webView );
256 WebView& operator=( const WebView& webView );
259 * @brief Sets an absolute scroll of the given view.
260 * @param[in] x The coordinate x of scroll
261 * @param[in] y The coordinate y of scroll
263 void SetScrollPosition( int x, int y );
266 * @brief Gets the current scroll position of the given view.
267 * @param[out] x The coordinate x of scroll
268 * @param[out] y The coordinate y of scroll
270 void GetScrollPosition( int& x, int& y ) const;
273 * @brief Gets the possible scroll size of the given view.
274 * @param[out] width The width of scroll size
275 * @param[out] height The height of scroll size
277 void GetScrollSize( int& width, int& height ) const;
280 * @brief Gets the last known content's size.
281 * @param[out] width The width of content's size
282 * @param[out] height The height of content's size
284 void GetContentSize( int& width, int& height ) const;
287 * @brief Get user agent string.
288 * @return The string value of user agent
290 const std::string& GetUserAgent() const;
293 * @brief Set user agent string.
294 * @param[in] userAgent The string value of user agent
296 void SetUserAgent( const std::string& userAgent );
299 * @brief Callback function to be called when page load started.
300 * @param[in] url The url currently being loaded
302 void OnPageLoadStarted( const std::string& url );
305 * @brief Callback function to be called when page load finished.
306 * @param[in] url The url currently being loaded
308 void OnPageLoadFinished( const std::string& url );
311 * @brief Callback function to be called when there is an error in page loading.
312 * @param[in] url The url currently being loaded
313 * @param[in] errorCode The error code
315 void OnPageLoadError( const std::string& url, int errorCode );
318 * @brief Callback function to be called when scroll edge is reached.
319 * @param[in] e The scroll edge reached.
321 void OnScrollEdgeReached( Dali::WebEnginePlugin::ScrollEdge edge );
326 Dali::Toolkit::Visual::Base mVisual;
327 Dali::Size mWebViewSize;
328 Dali::WebEngine mWebEngine;
330 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadStartedSignal;
331 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadFinishedSignal;
332 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType mPageLoadErrorSignal;
333 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType mScrollEdgeReachedSignal;
335 std::unique_ptr<Dali::Toolkit::WebContext> mWebContext;
336 std::unique_ptr<Dali::Toolkit::WebCookieManager> mWebCookieManager;
337 std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
338 std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
341 } // namespace Internal
343 inline Toolkit::Internal::WebView& GetImpl( Toolkit::WebView& handle )
345 DALI_ASSERT_ALWAYS( handle );
346 Dali::RefObject& impl = handle.GetImplementation();
347 return static_cast< Toolkit::Internal::WebView& >( impl );
350 inline const Toolkit::Internal::WebView& GetImpl( const Toolkit::WebView& handle )
352 DALI_ASSERT_ALWAYS( handle );
353 const Dali::RefObject& impl = handle.GetImplementation();
354 return static_cast< const Toolkit::Internal::WebView& >( impl );
357 } // namespace Toolkit
361 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H