1 #ifndef DALI_TOOLKIT_WEB_VIEW_H
2 #define DALI_TOOLKIT_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.
25 #include <dali-toolkit/public-api/controls/control.h>
26 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
33 class WebBackForwardList;
35 class WebCookieManager;
38 namespace Internal DALI_INTERNAL
41 } // namespace DALI_INTERNAL
44 * @addtogroup dali_toolkit_controls_web_view
49 * @brief WebView is a control for displaying web content.
51 * This enables embedding web pages in the application.
53 * For working WebView, a web engine plugin for a platform should be provided.
56 class DALI_TOOLKIT_API WebView : public Control
60 * @brief Enumeration for the start and end property ranges for this control.
64 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
65 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000,
69 * @brief Enumeration for the instance of properties belonging to the WebView class.
76 * @brief The url to load.
77 * @details name "url", type Property::STRING.
79 URL = PROPERTY_START_INDEX,
82 * @brief The user agent string.
83 * @details name "userAgent", type Property::STRING.
88 * @brief The current position of scroll.
89 * @details name "scrollPosition", type Property::VECTOR2.
94 * @brief The current size of scroll.
95 * @details name "scrollSize", type Property::VECTOR2.
96 * @note The value is read-only.
101 * @brief The current size of content.
102 * @details name "contentSize", type Property::VECTOR2.
103 * @note The value is read-only.
108 * @brief The title of web page.
109 * @details name "title", type Property::STRING.
110 * @note The value is read-only.
115 * @brief Whether video hole is enabled or not.
116 * @details name "videoHoleEnabled", type Property::BOOLEAN.
117 * @note The value is read-only.
122 * @brief Whether mouse event is enabled.
123 * @details name "mouseEventsEnabled", type Property::BOOLEAN.
124 * @note Default is true.
126 MOUSE_EVENTS_ENABLED,
129 * @brief Whether key event is enabled.
130 * @details name "keyEventsEnabled", type Property::BOOLEAN.
131 * @note Default is true.
136 * @brief The background color of web page.
137 * @details name "documentBackgroundColor", type Property::VECTOR4.
139 DOCUMENT_BACKGROUND_COLOR,
142 * @brief Whether tiles can be cleared or not when hidden.
143 * @details name "tilesClearedWhenHidden", type BOOLEAN.
145 TILES_CLEARED_WHEN_HIDDEN,
148 * @brief The multiplier of cover area of tile when rendering web page.
149 * @details name "tileCoverAreaMultiplier", type FLOAT.
151 TILE_COVER_AREA_MULTIPLIER,
154 * @brief Whether cursor is enabled or not by client.
155 * @details name "cursorEnabledByClient", type BOOLEAN.
157 CURSOR_ENABLED_BY_CLIENT,
160 * @brief The selected text of web page.
161 * @details name "selectedText", type Property::STRING.
162 * @note The value is read-only.
169 * @brief Enumeration for indicating error code of page loading.
171 enum class LoadErrorCode
173 UNKNOWN = 0, ///< Unknown.
174 CANCELED, ///< User canceled.
175 CANT_SUPPORT_MIMETYPE, ///< Can't show the page for this MIME type.
176 FAILED_FILE_IO, ///< File IO error.
177 CANT_CONNECT, ///< Cannot connect to the network.
178 CANT_LOOKUP_HOST, ///< Fail to look up host from the DNS.
179 FAILED_TLS_HANDSHAKE, ///< Fail to SSL/TLS handshake.
180 INVALID_CERTIFICATE, ///< Received certificate is invalid.
181 REQUEST_TIMEOUT, ///< Connection timeout.
182 TOO_MANY_REDIRECTS, ///< Too many redirects.
183 TOO_MANY_REQUESTS, ///< Too many requests during this load.
184 BAD_URL, ///< Malformed URL.
185 UNSUPPORTED_SCHEME, ///< Unsupported scheme.
186 AUTHENTICATION, ///< User authentication failed on the server.
187 INTERNAL_SERVER ///< Web server has an internal server error.
191 * @brief WebView signal type related with page loading.
193 using WebViewPageLoadSignalType = Signal<void(WebView, const std::string&)>;
196 * @brief WebView signal type related with page loading error.
198 using WebViewPageLoadErrorSignalType = Signal<void(WebView, const std::string&, LoadErrorCode)>;
201 * @brief WebView signal type related with scroll edge reached.
203 using WebViewScrollEdgeReachedSignalType = Signal<void(WebView, Dali::WebEnginePlugin::ScrollEdge)>;
206 * @brief WebView signal type related with url changed.
208 using WebViewUrlChangedSignalType = Signal<void(WebView, const std::string&)>;
212 * @brief Creates an initialized WebView.
213 * @return A handle to a newly allocated Dali WebView
215 * @note WebView will not display anything
217 static WebView New();
220 * @brief Creates an initialized WebView.
222 * @param [in] locale The locale of Web
223 * @param [in] timezoneId The timezoneId of Web
225 static WebView New(const std::string& locale, const std::string& timezoneId);
228 * @brief Creates an initialized WebView.
230 * @param [in] argc The count of arguments of Applications
231 * @param [in] argv The string array of arguments of Applications
233 static WebView New(int argc, char** argv);
236 * @brief Creates an uninitialized WebView.
243 * This is non-virtual since derived Handel types must not contain data or virtual methods.
248 * @brief Copy constructor.
250 * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation
252 WebView(const WebView& WebView);
255 * @brief Assignment operator.
257 * @param[in] WebView The WebView to assign from
258 * @return The updated WebView
260 WebView& operator=(const WebView& WebView);
263 * @brief Downcasts a handle to WebView handle.
265 * If handle points to a WebView, the downcast produces valid handle.
266 * If not, the returned handle is left uninitialized.
268 * @param[in] handle Handle to an object
269 * @return Handle to a WebView or an uninitialized handle
271 static WebView DownCast(BaseHandle handle);
274 * @brief Get WebSettings of WebEngine.
276 Dali::Toolkit::WebSettings* GetSettings() const;
279 * @brief Get WebContext of WebEngine.
281 Dali::Toolkit::WebContext* GetContext() const;
284 * @brief Get CookieManager of WebEngine.
286 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
289 * @brief Get WebBackForwardList of WebEngine.
291 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
294 * @brief Get Favicon of web page.
296 * @return Handle to a fav icon
298 Dali::Toolkit::ImageView& GetFavicon();
301 * @brief Loads a web page based on a given URL.
303 * @param [in] url The URL of the resource to load
305 void LoadUrl(const std::string& url);
308 * @brief Loads a given string as web contents.
310 * @param [in] htmlString The string to use as the contents of the web page
312 void LoadHtmlString(const std::string& htmlString);
315 * @brief Reloads the Web.
320 * @brief Stops loading web contents on the current page.
325 * @brief Suspends the operation associated with the view.
330 * @brief Resumes the operation associated with the view object after calling Suspend().
335 * @brief Scrolls the webpage of view by deltaX and deltaY.
336 * @param[in] deltaX The delta x of scroll
337 * @param[in] deltaY The delta y of scroll
339 void ScrollBy(int deltaX, int deltaY);
342 * @brief Returns whether forward is possible.
344 * @return True if forward is possible, false otherwise
349 * @brief Goes forward in the navigation history.
354 * @brief Returns whether backward is possible.
356 * @return True if backward is possible, false otherwise
361 * @brief Goes back in the navigation history.
366 * @brief Evaluates JavaScript code represented as a string.
368 * @param[in] script The JavaScript code
369 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
371 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
374 * @brief Evaluates JavaScript code represented as a string.
376 * @param[in] script The JavaScript code
378 void EvaluateJavaScript(const std::string& script);
381 * @brief Inject a JavaScript object with a message handler into the WebView.
383 * @note The injected object will appear in the JavaScript context to be loaded next.
389 * webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
390 * printf( "Received a message from JS: %s", message.c_str() );
393 * // Start WebView by loading URL
394 * webview.LoadUrl( url );
398 * myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
401 * @param[in] exposedObjectName The name of exposed object
402 * @param[in] handler The callback function
404 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
407 * @brief Register alert callback for javascript.
409 * @param[in] callback The callback function to be called by the JavaScript runtime.
411 void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
414 * @brief Reply for JavaScript alert.
416 void JavaScriptAlertReply();
419 * @brief Register confirm callback for javascript.
421 * @param[in] callback The callback function to be called by the JavaScript runtime.
423 void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
426 * @brief Reply for JavaScript confirm.
427 * @param[in] confirmed True if confirmed, false otherwise
429 void JavaScriptConfirmReply(bool confirmed);
432 * @brief Register prompt callback for javascript.
434 * @param[in] callback The callback function to be called by the JavaScript runtime.
436 void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
439 * @brief Reply for JavaScript prompt.
440 * @param[in] result The result from input-field of prompt popup.
442 void JavaScriptPromptReply(const std::string& result);
445 * @brief Clears the history of Web.
450 * @brief Clears all tiles resources of Web.
452 void ClearAllTilesResources();
455 * @brief Connects to this signal to be notified when page loading is started.
457 * @return A signal object to connect with
459 WebViewPageLoadSignalType& PageLoadStartedSignal();
462 * @brief Connects to this signal to be notified when page loading is in progress.
464 * @return A signal object to connect with.
466 WebViewPageLoadSignalType& PageLoadInProgressSignal();
469 * @brief Connects to this signal to be notified when page loading is finished.
471 * @return A signal object to connect with
473 WebViewPageLoadSignalType& PageLoadFinishedSignal();
476 * @brief Connects to this signal to be notified when an error occurs in page loading.
478 * @return A signal object to connect with.
480 WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
483 * @brief Connects to this signal to be notified when scroll edge is reached.
485 * @return A signal object to connect with.
487 WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
490 * @brief Connects to this signal to be notified when url is changed.
492 * @return A signal object to connect with.
494 WebViewUrlChangedSignalType& UrlChangedSignal();
496 public: // Not intended for application developers
499 * @brief Creates a handle using the Toolkit::Internal implementation.
501 * @param[in] implementation The WebView implementation
503 DALI_INTERNAL WebView(Internal::WebView& implementation);
506 * @brief Allows the creation of this WebView from an Internal::CustomActor pointer.
508 * @param[in] internal A pointer to the internal CustomActor
510 explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal);
518 } // namespace Toolkit
522 #endif // DALI_TOOLKIT_WEB_VIEW_H