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) 2021 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 Creates WebEngine instance.
 101    *
 102    * @param [in] width The width of Web
 103    * @param [in] height The height of Web
 104    * @param [in] argc The count of application arguments
 105    * @param [in] argv The string array of application arguments
 106    */
 107   void Create(int width, int height, int argc, char** argv);
 108
 109   /**
 110    * @brief Destroys WebEngine instance.
 111    */
 112   void Destroy();
 113
 114   /**
 115    * @brief Gets native image source to render.
 116    */
 117   NativeImageInterfacePtr GetNativeImageSource();
 118
 119   /**
 120    * @brief Get settings of WebEngine.
 121    */
 122   Dali::WebEngineSettings& GetSettings() const;
 123
 124   /**
 125    * @brief Get context of WebEngine.
 126    */
 127   Dali::WebEngineContext& GetContext() const;
 128
 129   /**
 130    * @brief Get cookie manager of WebEngine.
 131    */
 132   Dali::WebEngineCookieManager& GetCookieManager() const;
 133
 134   /**
 135    * @brief Get back-forward list of WebEngine.
 136    */
 137   Dali::WebEngineBackForwardList& GetBackForwardList() const;
 138
 139   /**
 140    * @brief Loads a web page based on a given URL.
 141    *
 142    * @param [in] url The URL of the resource to load
 143    */
 144   void LoadUrl(const std::string& url);
 145
 146   /**
 147    * @brief Returns the title of the Web.
 148    *
 149    * @return The title of web page
 150    */
 151   std::string GetTitle() const;
 152
 153   /**
 154    * @brief Returns the Favicon of the Web.
 155    *
 156    * @return FavIcon of Dali::PixelData& type
 157    */
 158   Dali::PixelData GetFavicon() const;
 159
 160   /**
 161    * @brief Gets the url.
 162    */
 163   const std::string& GetUrl();
 164
 165   /**
 166    * @brief Loads a given string as web contents.
 167    *
 168    * @param [in] htmlString The string to use as the contents of the web page
 169    */
 170   void LoadHtmlString(const std::string& htmlString);
 171
 172   /**
 173    * @brief Reloads the Web.
 174    */
 175   void Reload();
 176
 177   /**
 178    * @brief Stops loading web contents on the current page.
 179    */
 180   void StopLoading();
 181
 182   /**
 183    * @brief Suspends the operation associated with the view.
 184    */
 185   void Suspend();
 186
 187   /**
 188    * @brief Resumes the operation associated with the view object after calling Suspend().
 189    */
 190   void Resume();
 191
 192   /**
 193    * @brief Scrolls the webpage of view by deltaX and deltaY.
 194    */
 195   void ScrollBy(int deltaX, int deltaY);
 196
 197   /**
 198    * @brief Sets an absolute scroll of the given view.
 199    */
 200   void SetScrollPosition(int x, int y);
 201
 202   /**
 203    * @brief Gets the current scroll position of the given view.
 204    */
 205   Dali::Vector2 GetScrollPosition() const;
 206
 207   /**
 208    * @brief Gets the possible scroll size of the given view.
 209    */
 210   Dali::Vector2 GetScrollSize() const;
 211
 212   /**
 213    * @brief Gets the last known content's size.
 214    */
 215   Dali::Vector2 GetContentSize() const;
 216
 217   /**
 218    * @brief Returns whether forward is possible.
 219    *
 220    * @return True if forward is possible, false otherwise
 221    */
 222   bool CanGoForward();
 223
 224   /**
 225    * @brief Goes to forward.
 226    */
 227   void GoForward();
 228
 229   /**
 230    * @brief Returns whether backward is possible.
 231    *
 232    * @return True if backward is possible, false otherwise
 233    */
 234   bool CanGoBack();
 235
 236   /**
 237    * @brief Goes to back.
 238    */
 239   void GoBack();
 240
 241   /**
 242    * @brief Evaluates JavaScript code represented as a string.
 243    *
 244    * @param[in] script The JavaScript code
 245    * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
 246    */
 247   void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
 248
 249   /**
 250    * @brief Add a message handler into JavaScript.
 251    *
 252    * @param[in] exposedObjectName The name of exposed object
 253    * @param[in] handler The callback function
 254    */
 255   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
 256
 257   /**
 258    * @brief Register a callback for JavaScript alert.
 259    *
 260    * @param[in] callback The callback function
 261    */
 262   void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
 263
 264   /**
 265    * @brief Reply for JavaScript alert.
 266    */
 267   void JavaScriptAlertReply();
 268
 269   /**
 270    * @brief Register a callback for JavaScript confirm.
 271    *
 272    * @param[in] callback The callback function
 273    */
 274   void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
 275
 276   /**
 277    * @brief Reply for JavaScript confirm.
 278    */
 279   void JavaScriptConfirmReply(bool confirmed);
 280
 281   /**
 282    * @brief Register a callback for JavaScript prompt.
 283    *
 284    * @param[in] callback The callback function
 285    */
 286   void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
 287
 288   /**
 289    * @brief Reply for JavaScript prompt.
 290    */
 291   void JavaScriptPromptReply(const std::string& result);
 292
 293   /**
 294    * @brief Clears the history of Web.
 295    */
 296   void ClearHistory();
 297
 298   /**
 299    * @brief Clears all tiles resources of Web.
 300    */
 301   void ClearAllTilesResources();
 302
 303   /**
 304    * @brief Get user agent string.
 305    *
 306    * @return The string value of user agent
 307    */
 308   const std::string& GetUserAgent() const;
 309
 310   /**
 311    * @brief Set user agent string.
 312    *
 313    * @param[in] userAgent The string value of user agent
 314    */
 315   void SetUserAgent(const std::string& userAgent);
 316
 317   /**
 318    * @brief Sets the size of Web Pages.
 319    */
 320   void SetSize(int width, int height);
 321
 322   /**
 323    * @brief Sets background color of web page.
 324    *
 325    * @param[in] color Background color
 326    */
 327   void SetDocumentBackgroundColor(Dali::Vector4 color);
 328
 329   /**
 330    * @brief Clears tiles when hidden.
 331    *
 332    * @param[in] cleared Whether tiles are cleared or not
 333    */
 334   void ClearTilesWhenHidden(bool cleared);
 335
 336   /**
 337    * @brief Sets multiplier of cover area of tile.
 338    *
 339    * @param[in] multiplier The multiplier of cover area
 340    */
 341   void SetTileCoverAreaMultiplier(float multiplier);
 342
 343   /**
 344    * @brief Enables cursor by client.
 345    *
 346    * @param[in] enabled Whether cursor is enabled or not
 347    */
 348   void EnableCursorByClient(bool enabled);
 349
 350   /**
 351    * @brief Gets the selected text.
 352    *
 353    * @return the selected text
 354    */
 355   std::string GetSelectedText() const;
 356
 357   /**
 358    * @brief Sends Touch Events.
 359    */
 360   bool SendTouchEvent(const TouchEvent& touch);
 361
 362   /**
 363    * @brief Sends key Events.
 364    */
 365   bool SendKeyEvent(const KeyEvent& event);
 366
 367   /**
 368    * @brief Set focus.
 369    * @param[in] focused True if web view is focused, false otherwise
 370    */
 371   void SetFocus(bool focused);
 372
 373   /**
 374    * @brief Enables/disables mouse events. The default is enabled.
 375    *
 376    * @param[in] enabled True if mouse events are enabled, false otherwise
 377    */
 378   void EnableMouseEvents( bool enabled );
 379
 380   /**
 381    * @brief Enables/disables key events. The default is enabled.
 382    *
 383    * @param[in] enabled True if key events are enabled, false otherwise
 384    */
 385   void EnableKeyEvents( bool enabled );
 386
 387   /**
 388    * @brief Update display area.
 389    * @param[in] displayArea The area to display web page.
 390    */
 391   void UpdateDisplayArea(Dali::Rect<int> displayArea);
 392
 393   /**
 394    * @brief Enable video hole.
 395    * @param[in] enabled True if video hole is enabled, false otherwise
 396    */
 397   void EnableVideoHole(bool enabled);
 398
 399   /**
 400    * @brief Sends hover events.
 401    * @param[in] event The hover event would be sent.
 402    */
 403   bool SendHoverEvent( const HoverEvent& event );
 404
 405   /**
 406    * @brief Sends wheel events.
 407    * @param[in] event The wheel event would be sent.
 408    */
 409   bool SendWheelEvent( const WheelEvent& event );
 410
 411   /**
 412    * @brief Connects to this signal to be notified when page loading is started.
 413    *
 414    * @return A signal object to connect with.
 415    */
 416   Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
 417
 418   /**
 419    * @brief Connects to this signal to be notified when page loading is in progress.
 420    *
 421    * @return A signal object to connect with.
 422    */
 423   Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadInProgressSignal();
 424
 425   /**
 426    * @brief Connects to this signal to be notified when page loading is finished.
 427    *
 428    * @return A signal object to connect with.
 429    */
 430   Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
 431
 432   /**
 433    * @brief Connects to this signal to be notified when an error occurs in page loading.
 434    *
 435    * @return A signal object to connect with.
 436    */
 437   Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
 438
 439   /**
 440    * @brief Connects to this signal to be notified when scroll edge is reached.
 441    *
 442    * @return A signal object to connect with.
 443    */
 444   Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
 445
 446   /**
 447    * @brief Connects to this signal to be notified when url is changed.
 448    *
 449    * @return A signal object to connect with.
 450    */
 451   Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& UrlChangedSignal();
 452
 453 private: // Not intended for application developers
 454   /**
 455    * @brief Internal constructor
 456    */
 457   explicit DALI_INTERNAL WebEngine(Internal::Adaptor::WebEngine* internal);
 458 };
 459
 460 } // namespace Dali
 461
 462 #endif // DALI_WEB_ENGINE_H