dali/devel-api/adaptor-framework/web-engine.h

   1 #ifndef DALI_WEB_ENGINE_H
   2 #define DALI_WEB_ENGINE_H
   3
   4 /*
   5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23
  24 //INTERNAL INCLUDES
  25 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 namespace Internal
  31 {
  32 namespace Adaptor
  33 {
  34 class WebEngine;
  35 } // namespace Adaptor
  36
  37 } // namespace Internal
  38
  39 /**
  40  * @brief Proxy class to dynamically load, use and unload web engine plugin.
  41  *
  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.
  44  */
  45 class DALI_ADAPTOR_API WebEngine : public BaseHandle
  46 {
  47 public:
  48   /**
  49    * @brief Constructor.
  50    */
  51   WebEngine();
  52
  53   /**
  54    * @brief Destructor.
  55    */
  56   ~WebEngine();
  57
  58   /**
  59    * @brief Creates a new instance of a WebEngine.
  60    */
  61   static WebEngine New();
  62
  63   /**
  64    * @brief Copy constructor.
  65    *
  66    * @param[in] WebEngine WebEngine to copy. The copied WebEngine will point at the same implementation
  67    */
  68   WebEngine(const WebEngine& WebEngine);
  69
  70   /**
  71    * @brief Assignment operator.
  72    *
  73    * @param[in] WebEngine The WebEngine to assign from.
  74    * @return The updated WebEngine.
  75    */
  76   WebEngine& operator=(const WebEngine& WebEngine);
  77
  78   /**
  79    * @brief Downcast a handle to WebEngine handle.
  80    *
  81    * If handle points to a WebEngine the downcast produces valid
  82    * handle. If not the returned handle is left uninitialized.
  83    *
  84    * @param[in] handle Handle to an object
  85    * @return Handle to a WebEngine or an uninitialized handle
  86    */
  87   static WebEngine DownCast(BaseHandle handle);
  88
  89   /**
  90    * @brief Creates WebEngine instance.
  91    *
  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
  96    */
  97   void Create(int width, int height, const std::string& locale, const std::string& timezoneId);
  98
  99   /**
 100    * @brief Destroys WebEngine instance.
 101    */
 102   void Destroy();
 103
 104   /**
 105    * @brief Gets native image source to render.
 106    */
 107   NativeImageInterfacePtr GetNativeImageSource();
 108
 109   /**
 110    * @brief Loads a web page based on a given URL.
 111    *
 112    * @param [in] url The URL of the resource to load
 113    */
 114   void LoadUrl(const std::string& url);
 115
 116   /**
 117    * @brief Gets the url.
 118    */
 119   const std::string& GetUrl();
 120
 121   /**
 122    * @brief Loads a given string as web contents.
 123    *
 124    * @param [in] htmlString The string to use as the contents of the web page
 125    */
 126   void LoadHTMLString(const std::string& htmlString);
 127
 128   /**
 129    * @brief Reloads the Web.
 130    */
 131   void Reload();
 132
 133   /**
 134    * @brief Stops loading web contents on the current page.
 135    */
 136   void StopLoading();
 137
 138   /**
 139    * @brief Suspends the operation associated with the view.
 140    */
 141   void Suspend();
 142
 143   /**
 144    * @brief Resumes the operation associated with the view object after calling Suspend().
 145    */
 146   void Resume();
 147
 148   /**
 149    * @brief Returns whether forward is possible.
 150    *
 151    * @return True if forward is possible, false otherwise
 152    */
 153   bool CanGoForward();
 154
 155   /**
 156    * @brief Goes to forward.
 157    */
 158   void GoForward();
 159
 160   /**
 161    * @brief Returns whether backward is possible.
 162    *
 163    * @return True if backward is possible, false otherwise
 164    */
 165   bool CanGoBack();
 166
 167   /**
 168    * @brief Goes to back.
 169    */
 170   void GoBack();
 171
 172   /**
 173    * @brief Evaluates JavaScript code represented as a string.
 174    *
 175    * @param[in] script The JavaScript code
 176    * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
 177    */
 178   void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
 179
 180   /**
 181    * @brief Add a message handler into JavaScript.
 182    *
 183    * @param[in] exposedObjectName The name of exposed object
 184    * @param[in] handler The callback function
 185    */
 186   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
 187
 188   /**
 189    * @brief Clears the history of Web.
 190    */
 191   void ClearHistory();
 192
 193   /**
 194    * @brief Clears the cache of Web.
 195    */
 196   void ClearCache();
 197
 198   /**
 199    * @brief Clears all the cookies of Web.
 200    */
 201   void ClearCookies();
 202
 203   /**
 204    * @brief Get cache model option. The default is DOCUMENT_VIEWER.
 205    *
 206    * @return The cache model option
 207    */
 208   Dali::WebEnginePlugin::CacheModel GetCacheModel() const;
 209
 210   /**
 211    * @brief Set cache model option. The default is DOCUMENT_VIEWER.
 212    *
 213    * @param[in] cacheModel The cache model option
 214    */
 215   void SetCacheModel(Dali::WebEnginePlugin::CacheModel cacheModel);
 216
 217   /**
 218    * @brief Gets the cookie acceptance policy. The default is NO_THIRD_PARTY.
 219    *
 220    * @return The cookie acceptance policy
 221    */
 222   Dali::WebEnginePlugin::CookieAcceptPolicy GetCookieAcceptPolicy() const;
 223
 224   /**
 225    * @brief Sets the cookie acceptance policy. The default is NO_THIRD_PARTY.
 226    *
 227    * @param[in] policy The cookie acceptance policy
 228    */
 229   void SetCookieAcceptPolicy(Dali::WebEnginePlugin::CookieAcceptPolicy policy);
 230
 231   /**
 232    * @brief Get user agent string.
 233    *
 234    * @return The string value of user agent
 235    */
 236   const std::string& GetUserAgent() const;
 237
 238   /**
 239    * @brief Set user agent string.
 240    *
 241    * @param[in] userAgent The string value of user agent
 242    */
 243   void SetUserAgent(const std::string& userAgent);
 244
 245   /**
 246    * @brief Returns whether JavaScript can be executable. The default is true.
 247    *
 248    * @return true if JavaScript executing is enabled, false otherwise
 249    */
 250   bool IsJavaScriptEnabled() const;
 251
 252   /**
 253    * @brief Enables/disables JavaScript executing. The default is enabled.
 254    *
 255    * @param[in] enabled True if JavaScript executing is enabled, false otherwise
 256    */
 257   void EnableJavaScript(bool enabled);
 258
 259   /**
 260    * @brief Returns whether JavaScript can be executable. The default is true.
 261    *
 262    * @return true if images are loaded automatically, false otherwise
 263    */
 264   bool AreImagesAutomaticallyLoaded() const;
 265
 266   /**
 267    * @brief Enables/disables auto loading of images. The default is enabled.
 268    *
 269    * @param[in] automatic True if images are loaded automatically, false otherwise
 270    */
 271   void LoadImagesAutomatically(bool automatic);
 272
 273   /**
 274    * @brief Gets the default text encoding name.
 275    *
 276    * @return The default text encoding name
 277    */
 278   const std::string& GetDefaultTextEncodingName() const;
 279
 280   /**
 281    * @brief Sets the default text encoding name.
 282    *
 283    * @param[in] defaultTextEncodingName The default text encoding name
 284    */
 285   void SetDefaultTextEncodingName(const std::string& defaultTextEncodingName);
 286
 287   /**
 288    * @brief Returns the default font size in pixel. The default value is 16.
 289    *
 290    * @return The default font size
 291    */
 292   int GetDefaultFontSize() const;
 293
 294   /**
 295    * @brief Sets the default font size in pixel. The default value is 16.
 296    *
 297    * @param[in] defaultFontSize A new default font size to set
 298    */
 299   void SetDefaultFontSize(int defaultFontSize);
 300
 301   /**
 302    * @brief Sets the size of Web Pages.
 303    */
 304   void SetSize(int width, int height);
 305
 306   /**
 307    * @brief Sends Touch Events.
 308    */
 309   bool SendTouchEvent(const TouchEvent& touch);
 310
 311   /**
 312    * @brief Sends key Events.
 313    */
 314   bool SendKeyEvent(const KeyEvent& event);
 315
 316   /**
 317    * @brief Set focus.
 318    */
 319   void SetFocus( bool focused );
 320
 321   /**
 322    * @brief Connects to this signal to be notified when page loading is started.
 323    *
 324    * @return A signal object to connect with.
 325    */
 326   Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
 327
 328   /**
 329    * @brief Connects to this signal to be notified when page loading is finished.
 330    *
 331    * @return A signal object to connect with.
 332    */
 333   Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
 334
 335   /**
 336    * @brief Connects to this signal to be notified when an error occurs in page loading.
 337    *
 338    * @return A signal object to connect with.
 339    */
 340   Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
 341
 342 private: // Not intended for application developers
 343   /**
 344    * @brief Internal constructor
 345    */
 346   explicit DALI_INTERNAL WebEngine(Internal::Adaptor::WebEngine* internal);
 347 };
 348
 349 } // namespace Dali
 350
 351 #endif // DALI_WEB_ENGINE_H