1 #ifndef DALI_WEB_ENGINE_H
2 #define DALI_WEB_ENGINE_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.
22 #include <dali/public-api/object/base-handle.h>
25 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
26 #include <dali/public-api/dali-adaptor-common.h>
35 } // namespace Adaptor
37 } // namespace Internal
40 * @brief Proxy class to dynamically load, use and unload web engine plugin.
42 * The purpose of this class is to dynamically load the web engine plugin if and when its needed.
43 * So we don't slow down every application startup if they never need web engine.
45 class DALI_ADAPTOR_API WebEngine : public BaseHandle
59 * @brief Creates a new instance of a WebEngine.
61 static WebEngine New();
64 * @brief Copy constructor.
66 * @param[in] WebEngine WebEngine to copy. The copied WebEngine will point at the same implementation
68 WebEngine(const WebEngine& WebEngine);
71 * @brief Assignment operator.
73 * @param[in] WebEngine The WebEngine to assign from.
74 * @return The updated WebEngine.
76 WebEngine& operator=(const WebEngine& WebEngine);
79 * @brief Downcast a handle to WebEngine handle.
81 * If handle points to a WebEngine the downcast produces valid
82 * handle. If not the returned handle is left uninitialized.
84 * @param[in] handle Handle to an object
85 * @return Handle to a WebEngine or an uninitialized handle
87 static WebEngine DownCast(BaseHandle handle);
90 * @brief Creates WebEngine instance.
92 * @param [in] width The width of Web
93 * @param [in] height The height of Web
94 * @param [in] locale The locale of Web
95 * @param [in] timezoneId The timezoneID of Web
97 void Create(int width, int height, const std::string& locale, const std::string& timezoneId);
100 * @brief Destroys WebEngine instance.
105 * @brief Gets native image source to render.
107 NativeImageInterfacePtr GetNativeImageSource();
110 * @brief Loads a web page based on a given URL.
112 * @param [in] url The URL of the resource to load
114 void LoadUrl(const std::string& url);
117 * @brief Gets the url.
119 const std::string& GetUrl();
122 * @brief Loads a given string as web contents.
124 * @param [in] htmlString The string to use as the contents of the web page
126 void LoadHTMLString(const std::string& htmlString);
129 * @brief Reloads the Web.
134 * @brief Stops loading web contents on the current page.
139 * @brief Suspends the operation associated with the view.
144 * @brief Resumes the operation associated with the view object after calling Suspend().
149 * @brief Scrolls the webpage of view by deltaX and deltaY.
151 void ScrollBy( int deltaX, int deltaY );
154 * @brief Sets an absolute scroll of the given view.
156 void SetScrollPosition( int x, int y );
159 * @brief Gets the current scroll position of the given view.
161 void GetScrollPosition( int& x, int& y ) const;
164 * @brief Gets the possible scroll size of the given view.
166 void GetScrollSize( int& width, int& height ) const;
169 * @brief Gets the last known content's size.
171 void GetContentSize( int& width, int& height ) const;
174 * @brief Returns whether forward is possible.
176 * @return True if forward is possible, false otherwise
181 * @brief Goes to forward.
186 * @brief Returns whether backward is possible.
188 * @return True if backward is possible, false otherwise
193 * @brief Goes to back.
198 * @brief Evaluates JavaScript code represented as a string.
200 * @param[in] script The JavaScript code
201 * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
203 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
206 * @brief Add a message handler into JavaScript.
208 * @param[in] exposedObjectName The name of exposed object
209 * @param[in] handler The callback function
211 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
214 * @brief Clears the history of Web.
219 * @brief Clears the cache of Web.
224 * @brief Clears all the cookies of Web.
229 * @brief Get cache model option. The default is DOCUMENT_VIEWER.
231 * @return The cache model option
233 Dali::WebEnginePlugin::CacheModel GetCacheModel() const;
236 * @brief Set cache model option. The default is DOCUMENT_VIEWER.
238 * @param[in] cacheModel The cache model option
240 void SetCacheModel(Dali::WebEnginePlugin::CacheModel cacheModel);
243 * @brief Gets the cookie acceptance policy. The default is NO_THIRD_PARTY.
245 * @return The cookie acceptance policy
247 Dali::WebEnginePlugin::CookieAcceptPolicy GetCookieAcceptPolicy() const;
250 * @brief Sets the cookie acceptance policy. The default is NO_THIRD_PARTY.
252 * @param[in] policy The cookie acceptance policy
254 void SetCookieAcceptPolicy(Dali::WebEnginePlugin::CookieAcceptPolicy policy);
257 * @brief Get user agent string.
259 * @return The string value of user agent
261 const std::string& GetUserAgent() const;
264 * @brief Set user agent string.
266 * @param[in] userAgent The string value of user agent
268 void SetUserAgent(const std::string& userAgent);
271 * @brief Returns whether JavaScript can be executable. The default is true.
273 * @return true if JavaScript executing is enabled, false otherwise
275 bool IsJavaScriptEnabled() const;
278 * @brief Enables/disables JavaScript executing. The default is enabled.
280 * @param[in] enabled True if JavaScript executing is enabled, false otherwise
282 void EnableJavaScript(bool enabled);
285 * @brief Returns whether JavaScript can be executable. The default is true.
287 * @return true if images are loaded automatically, false otherwise
289 bool AreImagesAutomaticallyLoaded() const;
292 * @brief Enables/disables auto loading of images. The default is enabled.
294 * @param[in] automatic True if images are loaded automatically, false otherwise
296 void LoadImagesAutomatically(bool automatic);
299 * @brief Gets the default text encoding name.
301 * @return The default text encoding name
303 const std::string& GetDefaultTextEncodingName() const;
306 * @brief Sets the default text encoding name.
308 * @param[in] defaultTextEncodingName The default text encoding name
310 void SetDefaultTextEncodingName(const std::string& defaultTextEncodingName);
313 * @brief Returns the default font size in pixel. The default value is 16.
315 * @return The default font size
317 int GetDefaultFontSize() const;
320 * @brief Sets the default font size in pixel. The default value is 16.
322 * @param[in] defaultFontSize A new default font size to set
324 void SetDefaultFontSize(int defaultFontSize);
327 * @brief Sets the size of Web Pages.
329 void SetSize(int width, int height);
332 * @brief Sends Touch Events.
334 bool SendTouchEvent(const TouchEvent& touch);
337 * @brief Sends key Events.
339 bool SendKeyEvent(const KeyEvent& event);
344 void SetFocus( bool focused );
347 * @brief Connects to this signal to be notified when page loading is started.
349 * @return A signal object to connect with.
351 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
354 * @brief Connects to this signal to be notified when page loading is finished.
356 * @return A signal object to connect with.
358 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
361 * @brief Connects to this signal to be notified when an error occurs in page loading.
363 * @return A signal object to connect with.
365 Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
368 * @brief Connects to this signal to be notified when scroll edge is reached.
370 * @return A signal object to connect with.
372 Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
374 private: // Not intended for application developers
376 * @brief Internal constructor
378 explicit DALI_INTERNAL WebEngine(Internal::Adaptor::WebEngine* internal);
383 #endif // DALI_WEB_ENGINE_H