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.
147 * @brief WebView signal type related with page loading.
149 using WebViewPageLoadSignalType = Signal< void( WebView, const std::string& ) >;
152 * @brief WebView signal type related with page loading error.
154 using WebViewPageLoadErrorSignalType = Signal< void( WebView, const std::string&, LoadErrorCode ) >;
157 * @brief WebView signal type related with scroll edge reached.
159 using WebViewScrollEdgeReachedSignalType = Signal< void( WebView, Dali::WebEnginePlugin::ScrollEdge ) >;
163 * @brief Creates an initialized WebView.
164 * @return A handle to a newly allocated Dali WebView
166 * @note WebView will not display anything
168 static WebView New();
171 * @brief Creates an initialized WebView.
173 * @param [in] locale The locale of Web
174 * @param [in] timezoneId The timezoneId of Web
176 static WebView New(const std::string& locale, const std::string& timezoneId);
179 * @brief Creates an initialized WebView.
181 * @param [in] argc The count of arguments of Applications
182 * @param [in] argv The string array of arguments of Applications
184 static WebView New( int argc, char** argv );
187 * @brief Creates an uninitialized WebView.
194 * This is non-virtual since derived Handel types must not contain data or virtual methods.
199 * @brief Copy constructor.
201 * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation
203 WebView(const WebView& WebView);
206 * @brief Assignment operator.
208 * @param[in] WebView The WebView to assign from
209 * @return The updated WebView
211 WebView& operator=(const WebView& WebView);
214 * @brief Downcasts a handle to WebView handle.
216 * If handle points to a WebView, the downcast produces valid handle.
217 * If not, the returned handle is left uninitialized.
219 * @param[in] handle Handle to an object
220 * @return Handle to a WebView or an uninitialized handle
222 static WebView DownCast(BaseHandle handle);
225 * @brief Get WebSettings of WebEngine.
227 Dali::Toolkit::WebSettings* GetSettings() const;
230 * @brief Get WebContext of WebEngine.
232 Dali::Toolkit::WebContext* GetContext() const;
235 * @brief Get CookieManager of WebEngine.
237 Dali::Toolkit::WebCookieManager* GetCookieManager() const;
240 * @brief Get WebBackForwardList of WebEngine.
242 Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
245 * @brief Get Favicon of web page.
247 * @return Handle to a fav icon
249 Dali::Toolkit::ImageView& GetFavicon();
252 * @brief Loads a web page based on a given URL.
254 * @param [in] url The URL of the resource to load
256 void LoadUrl(const std::string& url);
259 * @brief Loads a given string as web contents.
261 * @param [in] htmlString The string to use as the contents of the web page
263 void LoadHtmlString(const std::string& htmlString);
266 * @brief Reloads the Web.
271 * @brief Stops loading web contents on the current page.
276 * @brief Suspends the operation associated with the view.
281 * @brief Resumes the operation associated with the view object after calling Suspend().
286 * @brief Scrolls the webpage of view by deltaX and deltaY.
287 * @param[in] deltaX The delta x of scroll
288 * @param[in] deltaY The delta y of scroll
290 void ScrollBy( int deltaX, int deltaY );
293 * @brief Returns whether forward is possible.
295 * @return True if forward is possible, false otherwise
300 * @brief Goes forward in the navigation history.
305 * @brief Returns whether backward is possible.
307 * @return True if backward is possible, false otherwise
312 * @brief Goes back in the navigation history.
317 * @brief Evaluates JavaScript code represented as a string.
319 * @param[in] script The JavaScript code
320 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
322 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
325 * @brief Evaluates JavaScript code represented as a string.
327 * @param[in] script The JavaScript code
329 void EvaluateJavaScript(const std::string& script);
332 * @brief Inject a JavaScript object with a message handler into the WebView.
334 * @note The injected object will appear in the JavaScript context to be loaded next.
340 * webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
341 * printf( "Received a message from JS: %s", message.c_str() );
344 * // Start WebView by loading URL
345 * webview.LoadUrl( url );
349 * myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
352 * @param[in] exposedObjectName The name of exposed object
353 * @param[in] handler The callback function
355 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
358 * @brief Clears all tiles resources of Web.
360 void ClearAllTilesResources();
363 * @brief Clears the history of Web.
368 * @brief Connects to this signal to be notified when page loading is started.
370 * @return A signal object to connect with
372 WebViewPageLoadSignalType& PageLoadStartedSignal();
375 * @brief Connects to this signal to be notified when page loading is finished.
377 * @return A signal object to connect with
379 WebViewPageLoadSignalType& PageLoadFinishedSignal();
382 * @brief Connects to this signal to be notified when an error occurs in page loading.
384 * @return A signal object to connect with.
386 WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
389 * @brief Connects to this signal to be notified when scroll edge is reached.
391 * @return A signal object to connect with.
393 WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
395 public: // Not intended for application developers
398 * @brief Creates a handle using the Toolkit::Internal implementation.
400 * @param[in] implementation The WebView implementation
402 DALI_INTERNAL WebView(Internal::WebView& implementation);
405 * @brief Allows the creation of this WebView from an Internal::CustomActor pointer.
407 * @param[in] internal A pointer to the internal CustomActor
409 explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal);
417 } // namespace Toolkit
421 #endif // DALI_TOOLKIT_WEB_VIEW_H