1 #ifndef DALI_TOOLKIT_WEB_VIEW_H
2 #define DALI_TOOLKIT_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.
25 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
26 #include <dali-toolkit/public-api/controls/control.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
61 * @brief Enumeration for the start and end property ranges for this control.
65 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
66 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000,
70 * @brief Enumeration for the instance of properties belonging to the WebView class.
77 * @brief The url to load.
78 * @details name "url", type Property::STRING.
80 URL = PROPERTY_START_INDEX,
83 * @brief The user agent string.
84 * @details name "userAgent", type Property::STRING.
89 * @brief The current position of scroll.
90 * @details name "scrollPosition", type Property::VECTOR2.
95 * @brief The current size of scroll.
96 * @details name "scrollSize", type Property::VECTOR2.
97 * @note The value is read-only.
102 * @brief The current size of content.
103 * @details name "contentSize", type Property::VECTOR2.
104 * @note The value is read-only.
109 * @brief The title of web page.
110 * @details name "title", type Property::STRING.
111 * @note The value is read-only.
116 * @brief Whether video hole is enabled or not.
117 * @details name "videoHoleEnabled", type Property::BOOLEAN.
118 * @note The value is read-only.
125 * @brief Enumeration for indicating error code of page loading.
127 enum class LoadErrorCode
129 UNKNOWN = 0, ///< Unknown.
130 CANCELED, ///< User canceled.
131 CANT_SUPPORT_MIMETYPE, ///< Can't show the page for this MIME type.
132 FAILED_FILE_IO, ///< File IO error.
133 CANT_CONNECT, ///< Cannot connect to the network.
134 CANT_LOOKUP_HOST, ///< Fail to look up host from the DNS.
135 FAILED_TLS_HANDSHAKE, ///< Fail to SSL/TLS handshake.
136 INVALID_CERTIFICATE, ///< Received certificate is invalid.
137 REQUEST_TIMEOUT, ///< Connection timeout.
138 TOO_MANY_REDIRECTS, ///< Too many redirects.
139 TOO_MANY_REQUESTS, ///< Too many requests during this load.
140 BAD_URL, ///< Malformed URL.
141 UNSUPPORTED_SCHEME, ///< Unsupported scheme.
142 AUTHENTICATION, ///< User authentication failed on the server.
143 INTERNAL_SERVER ///< Web server has an internal server error.
148 * @brief Creates an initialized WebView.
149 * @return A handle to a newly allocated Dali WebView
151 * @note WebView will not display anything
153 static WebView New();
156 * @brief Creates an initialized WebView.
158 * @param [in] locale The locale of Web
159 * @param [in] timezoneId The timezoneId of Web
161 static WebView New(const std::string& locale, const std::string& timezoneId);
164 * @brief Creates an initialized WebView.
166 * @param [in] argc The count of arguments of Applications
167 * @param [in] argv The string array of arguments of Applications
169 static WebView New( int argc, char** argv );
172 * @brief Creates an uninitialized WebView.
179 * This is non-virtual since derived Handel types must not contain data or virtual methods.
184 * @brief Copy constructor.
186 * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation
188 WebView(const WebView& WebView);
191 * @brief Assignment operator.
193 * @param[in] WebView The WebView to assign from
194 * @return The updated WebView
196 WebView& operator=(const WebView& WebView);
199 * @brief Downcasts a handle to WebView handle.
201 * If handle points to a WebView, the downcast produces valid handle.
202 * If not, the returned handle is left uninitialized.
204 * @param[in] handle Handle to an object
205 * @return Handle to a WebView or an uninitialized handle
207 static WebView DownCast(BaseHandle handle);
210 * @brief Get WebSettings of WebEngine.
212 Dali::Toolkit::WebSettings* GetSettings() const;
215 * @brief Get WebContext of WebEngine.
217 Dali::Toolkit::WebContext* GetContext() const;
220 * @brief Get CookieManager of WebEngine.
222 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
225 * @brief Get WebBackForwardList of WebEngine.
227 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
230 * @brief Get favicon of web page.
232 * @return Handle to a favicon
234 Dali::Toolkit::ImageView GetFavicon() const;
237 * @brief Loads a web page based on a given URL.
239 * @param [in] url The URL of the resource to load
241 void LoadUrl(const std::string& url);
244 * @brief Loads a given string as web contents.
246 * @param [in] htmlString The string to use as the contents of the web page
248 void LoadHtmlString(const std::string& htmlString);
251 * @brief Reloads the Web.
256 * @brief Stops loading web contents on the current page.
261 * @brief Suspends the operation associated with the view.
266 * @brief Resumes the operation associated with the view object after calling Suspend().
271 * @brief Scrolls the webpage of view by deltaX and deltaY.
272 * @param[in] deltaX The delta x of scroll
273 * @param[in] deltaY The delta y of scroll
275 void ScrollBy( int deltaX, int deltaY );
278 * @brief Returns whether forward is possible.
280 * @return True if forward is possible, false otherwise
285 * @brief Goes forward in the navigation history.
290 * @brief Returns whether backward is possible.
292 * @return True if backward is possible, false otherwise
297 * @brief Goes back in the navigation history.
302 * @brief Evaluates JavaScript code represented as a string.
304 * @param[in] script The JavaScript code
305 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
307 void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler);
310 * @brief Evaluates JavaScript code represented as a string.
312 * @param[in] script The JavaScript code
314 void EvaluateJavaScript(const std::string& script);
317 * @brief Inject a JavaScript object with a message handler into the WebView.
319 * @note The injected object will appear in the JavaScript context to be loaded next.
325 * webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
326 * printf( "Received a message from JS: %s", message.c_str() );
329 * // Start WebView by loading URL
330 * webview.LoadUrl( url );
334 * myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
337 * @param[in] exposedObjectName The name of exposed object
338 * @param[in] handler The callback function
340 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler);
343 * @brief Clears all tiles resources of Web.
345 void ClearAllTilesResources();
348 * @brief Clears the history of Web.
353 * @brief Set or unset TTS focus of the webview.
354 * @param[in] focused True if it is gained, false lost.
355 * @note It only works when the webview does not have keyinput focus. If it has keyinput focus, the TTS focus is set automatically.
357 void SetTtsFocus(bool focused);
360 * @brief Callback to be called when page loading is started.
362 * @param[in] callback
364 void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
367 * @brief Callback to be called when page loading is finished.
369 * @param[in] callback
371 void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
374 * @brief Callback to be called when an error occurs in page loading.
376 * @param[in] callback
378 void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
381 * @brief Callback to be called when scroll edge is reached.
383 * @param[in] callback
385 void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
388 * @brief Callback to be called when navigation policy would be decided.
390 * @param[in] callback
392 void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback);
395 * @brief Get a plain text of current web page asynchronously.
397 * @param[in] callback The callback function called asynchronously.
399 void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
401 public: // Not intended for application developers
404 * @brief Creates a handle using the Toolkit::Internal implementation.
406 * @param[in] implementation The WebView implementation
408 DALI_INTERNAL WebView(Internal::WebView& implementation);
411 * @brief Allows the creation of this WebView from an Internal::CustomActor pointer.
413 * @param[in] internal A pointer to the internal CustomActor
415 explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal);
423 } // namespace Toolkit
427 #endif // DALI_TOOLKIT_WEB_VIEW_H