1 #ifndef DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
2 #define DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
5 * Copyright (c) 2021 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.
22 #include <dali/devel-api/adaptor-framework/web-engine.h>
23 #include <dali/public-api/images/image-operations.h>
24 #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>
39 class WebBackForwardList;
41 class WebCookieManager;
47 class WebView : public Control
52 WebView(const std::string& locale, const std::string& timezoneId);
54 WebView(int argc, char** argv);
60 * @copydoc Dali::Toolkit::WebView::New()
62 static Toolkit::WebView New();
65 * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
67 static Toolkit::WebView New(const std::string& locale, const std::string& timezoneId);
70 * @brief Get settings of WebEngine.
72 Dali::Toolkit::WebSettings* GetSettings() const;
75 * @brief Get context of WebEngine.
77 Dali::Toolkit::WebContext* GetContext() const;
80 * @brief Get cookie manager of WebEngine.
82 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
85 * @brief Get WebBackForwardList of WebEngine.
87 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
90 * @copydoc Dali::Toolkit::WebView::New( int, char** )
92 static Toolkit::WebView New(int argc, char** argv);
95 * @brief Get Favicon of web page.
97 * @return Handle to a fav icon
99 Dali::Toolkit::ImageView& GetFavicon();
102 * @copydoc Dali::Toolkit::WebView::LoadUrl()
104 void LoadUrl(const std::string& url);
107 * @copydoc Dali::WebEngine::LoadHTMLString()
109 void LoadHtmlString(const std::string& htmlString);
112 * @copydoc Dali::Toolkit::WebView::Reload()
117 * @copydoc Dali::Toolkit::WebView::StopLoading()
122 * @copydoc Dali::Toolkit::WebView::StopLoading()
127 * @copydoc Dali::Toolkit::WebView::Resume()
132 * @copydoc Dali::Toolkit::WebView::ScrollBy()
134 void ScrollBy(int deltaX, int deltaY);
137 * @copydoc Dali::Toolkit::WebView::CanGoForward()
142 * @copydoc Dali::Toolkit::WebView::GoForward()
147 * @copydoc Dali::Toolkit::WebView::CanGoBack()
152 * @copydoc Dali::Toolkit::WebView::GoBack()
157 * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
159 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
162 * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
164 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
167 * @brief Clears all tiles resources of Web.
169 void ClearAllTilesResources();
172 * @copydoc Dali::Toolkit::WebView::ClearHistory()
177 * @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
179 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
182 * @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
184 Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
187 * @copydoc Dali::Toolkit::WebView::PageLoadErrorSignal()
189 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
192 * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
194 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
196 public: // Properties
198 * @brief Called when a property of an object of this type is set.
200 * @param[in] object The object whose property is set.
201 * @param[in] index The property index.
202 * @param[in] value The new property value.
204 static void SetProperty(Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value);
207 * @brief Called to retrieve a property of an object of this type.
209 * @param[in] object The object whose property is to be retrieved.
210 * @param[in] index The property index.
211 * @return The current value of the property.
213 static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
216 * Connects a callback function with the object's signals.
217 * @param[in] object The object providing the signal.
218 * @param[in] tracker Used to disconnect the signal.
219 * @param[in] signalName The signal to connect to.
220 * @param[in] functor A newly allocated FunctorDelegate.
221 * @return True if the signal was connected.
222 * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
224 static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
226 private: // From Control
228 * @copydoc Toolkit::Control::OnInitialize()
230 void OnInitialize() override;
233 * @copydoc Toolkit::Control::GetNaturalSize
235 Vector3 GetNaturalSize() override;
238 * Signal occurs when the Web View has been touched.
239 * @param[in] actor The Actor Touched
240 * @param[in] touch The Touch Data.
241 * @return Whether to consume event or not.
243 bool OnTouchEvent(Actor actor, const Dali::TouchEvent& touch);
246 * @copydoc Toolkit::Control::OnKeyEvent()
248 bool OnKeyEvent(const Dali::KeyEvent& event) override;
251 * @copydoc Toolkit::Control::OnKeyInputFocusGained()
253 void OnKeyInputFocusGained() override;
256 * @copydoc Toolkit::Control::OnKeyInputFocusLost()
258 void OnKeyInputFocusLost() override;
261 * @copydoc Toolkit::Control::OnSceneConnection()
263 void OnSceneConnection(int depth) override;
267 WebView(const WebView& webView);
269 WebView& operator=(const WebView& webView);
272 * @brief Sets an absolute scroll of the given view.
273 * @param[in] x The coordinate x of scroll
274 * @param[in] y The coordinate y of scroll
276 void SetScrollPosition(int x, int y);
279 * @brief Gets the current scroll position of the given view.
280 * @param[out] x The coordinate x of scroll
281 * @param[out] y The coordinate y of scroll
283 Dali::Vector2 GetScrollPosition() const;
286 * @brief Gets the possible scroll size of the given view.
287 * @param[out] width The width of scroll size
288 * @param[out] height The height of scroll size
290 Dali::Vector2 GetScrollSize() const;
293 * @brief Gets the last known content's size.
294 * @param[out] width The width of content's size
295 * @param[out] height The height of content's size
297 Dali::Vector2 GetContentSize() const;
300 * @brief Returns the title of the Web.
302 * @return The title of web page
304 std::string GetTitle() const;
307 * @brief Get user agent string.
308 * @return The string value of user agent
310 const std::string& GetUserAgent() const;
313 * @brief Set user agent string.
314 * @param[in] userAgent The string value of user agent
316 void SetUserAgent(const std::string& userAgent);
319 * @brief Updates display area of web view.
320 * @param[in] source The soource triggers Notification.
322 void UpdateDisplayArea(Dali::PropertyNotification& source);
325 * @brief Enable/Disable video hole for video playing.
326 * @param[in] enabled True if video hole is enabled, false otherwise.
328 void EnableVideoHole(bool enabled);
331 * @brief Enable blend mode.
332 * @param[in] blendEnabled True if turn on blend mode, false otherwise.
334 void EnableBlendMode(bool blendEnabled);
337 * @brief Callback function to be called when page load started.
338 * @param[in] url The url currently being loaded
340 void OnPageLoadStarted(const std::string& url);
343 * @brief Callback function to be called when page load finished.
344 * @param[in] url The url currently being loaded
346 void OnPageLoadFinished(const std::string& url);
349 * @brief Callback function to be called when there is an error in page loading.
350 * @param[in] url The url currently being loaded
351 * @param[in] errorCode The error code
353 void OnPageLoadError(const std::string& url, int errorCode);
356 * @brief Callback function to be called when scroll edge is reached.
357 * @param[in] e The scroll edge reached.
359 void OnScrollEdgeReached(Dali::WebEnginePlugin::ScrollEdge edge);
363 Dali::Toolkit::Visual::Base mVisual;
364 Dali::Size mWebViewSize;
365 Dali::WebEngine mWebEngine;
367 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadStartedSignal;
368 Dali::Toolkit::WebView::WebViewPageLoadSignalType mPageLoadFinishedSignal;
369 Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType mPageLoadErrorSignal;
370 Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType mScrollEdgeReachedSignal;
372 std::unique_ptr<Dali::Toolkit::WebContext> mWebContext;
373 std::unique_ptr<Dali::Toolkit::WebCookieManager> mWebCookieManager;
374 std::unique_ptr<Dali::Toolkit::WebSettings> mWebSettings;
375 std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
376 Dali::Toolkit::ImageView mFaviconView;
378 Dali::PropertyNotification mPositionUpdateNotification;
379 Dali::PropertyNotification mSizeUpdateNotification;
380 Dali::PropertyNotification mScaleUpdateNotification;
381 bool mVideoHoleEnabled;
382 Dali::Rect<int> mWebViewArea;
385 } // namespace Internal
387 inline Toolkit::Internal::WebView& GetImpl(Toolkit::WebView& handle)
389 DALI_ASSERT_ALWAYS(handle);
390 Dali::RefObject& impl = handle.GetImplementation();
391 return static_cast<Toolkit::Internal::WebView&>(impl);
394 inline const Toolkit::Internal::WebView& GetImpl(const Toolkit::WebView& handle)
396 DALI_ASSERT_ALWAYS(handle);
397 const Dali::RefObject& impl = handle.GetImplementation();
398 return static_cast<const Toolkit::Internal::WebView&>(impl);
401 } // namespace Toolkit
405 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H