dali-toolkit/devel-api/controls/web-view/web-view.h

   1 #ifndef DALI_TOOLKIT_WEB_VIEW_H
   2 #define DALI_TOOLKIT_WEB_VIEW_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 <functional>
  23 #include <memory>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali-toolkit/public-api/controls/control.h>
  27 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
  28
  29 namespace Dali
  30 {
  31 namespace Toolkit
  32 {
  33 class ImageView;
  34 class WebBackForwardList;
  35 class WebContext;
  36 class WebCookieManager;
  37 class WebFormRepostDecision;
  38 class WebSettings;
  39
  40 namespace Internal DALI_INTERNAL
  41 {
  42 class WebView;
  43 } // namespace DALI_INTERNAL
  44
  45 /**
  46  * @addtogroup dali_toolkit_controls_web_view
  47  * @{
  48  */
  49
  50 /**
  51  * @brief WebView is a control for displaying web content.
  52  *
  53  * This enables embedding web pages in the application.
  54  *
  55  * For working WebView, a web engine plugin for a platform should be provided.
  56  *
  57  */
  58 class DALI_TOOLKIT_API WebView : public Control
  59 {
  60 public:
  61   /**
  62    * @brief Enumeration for the start and end property ranges for this control.
  63    */
  64   enum PropertyRange
  65   {
  66     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  67     PROPERTY_END_INDEX   = PROPERTY_START_INDEX + 1000,
  68   };
  69
  70   /**
  71    * @brief Enumeration for the instance of properties belonging to the WebView class.
  72    */
  73   struct Property
  74   {
  75     enum
  76     {
  77       /**
  78        * @brief The url to load.
  79        * @details name "url", type Property::STRING.
  80        */
  81       URL = PROPERTY_START_INDEX,
  82
  83       /**
  84        * @brief The user agent string.
  85        * @details name "userAgent", type Property::STRING.
  86        */
  87       USER_AGENT,
  88
  89       /**
  90        * @brief The current position of scroll.
  91        * @details name "scrollPosition", type Property::VECTOR2.
  92        */
  93       SCROLL_POSITION,
  94
  95       /**
  96        * @brief The current size of scroll.
  97        * @details name "scrollSize", type Property::VECTOR2.
  98        * @note The value is read-only.
  99        */
 100       SCROLL_SIZE,
 101
 102       /**
 103        * @brief The current size of content.
 104        * @details name "contentSize", type Property::VECTOR2.
 105        * @note The value is read-only.
 106        */
 107       CONTENT_SIZE,
 108
 109       /**
 110        * @brief The title of web page.
 111        * @details name "title", type Property::STRING.
 112        * @note The value is read-only.
 113        */
 114       TITLE,
 115
 116       /**
 117        * @brief Whether video hole is enabled or not.
 118        * @details name "videoHoleEnabled", type Property::BOOLEAN.
 119        * @note The value is read-only.
 120        */
 121       VIDEO_HOLE_ENABLED,
 122
 123       /**
 124        * @brief Whether mouse event is enabled.
 125        * @details name "mouseEventsEnabled", type Property::BOOLEAN.
 126        * @note Default is true.
 127        */
 128       MOUSE_EVENTS_ENABLED,
 129
 130       /**
 131        * @brief Whether key event is enabled.
 132        * @details name "keyEventsEnabled", type Property::BOOLEAN.
 133        * @note Default is true.
 134        */
 135       KEY_EVENTS_ENABLED,
 136
 137       /**
 138        * @brief The background color of web page.
 139        * @details name "documentBackgroundColor", type Property::VECTOR4.
 140        */
 141       DOCUMENT_BACKGROUND_COLOR,
 142
 143       /**
 144        * @brief Whether tiles can be cleared or not when hidden.
 145        * @details name "tilesClearedWhenHidden", type BOOLEAN.
 146        */
 147       TILES_CLEARED_WHEN_HIDDEN,
 148
 149       /**
 150        * @brief The multiplier of cover area of tile when rendering web page.
 151        * @details name "tileCoverAreaMultiplier", type FLOAT.
 152        */
 153       TILE_COVER_AREA_MULTIPLIER,
 154
 155       /**
 156        * @brief Whether cursor is enabled or not by client.
 157        * @details name "cursorEnabledByClient", type BOOLEAN.
 158        */
 159       CURSOR_ENABLED_BY_CLIENT,
 160
 161       /**
 162        * @brief The selected text of web page.
 163        * @details name "selectedText", type Property::STRING.
 164        * @note The value is read-only.
 165        */
 166       SELECTED_TEXT,
 167
 168       /**
 169        * @brief Zoom factor of web page.
 170        * @details name "pageZoomFactor", type Property::FLOAT.
 171        */
 172       PAGE_ZOOM_FACTOR,
 173
 174       /**
 175        * @brief Zoom factor of text.
 176        * @details name "textZoomFactor", type Property::FLOAT.
 177        */
 178       TEXT_ZOOM_FACTOR,
 179
 180       /**
 181        * @brief progress percentage of loading a web page.
 182        * @details name "loadProgressPercentage", type Property::FLOAT.
 183        * @note The value is read-only.
 184        */
 185       LOAD_PROGRESS_PERCENTAGE,
 186     };
 187   };
 188
 189   /**
 190    * @brief Enumeration for indicating error code of page loading.
 191    */
 192   enum class LoadErrorCode
 193   {
 194     UNKNOWN = 0,           ///< Unknown.
 195     CANCELED,              ///< User canceled.
 196     CANT_SUPPORT_MIMETYPE, ///< Can't show the page for this MIME type.
 197     FAILED_FILE_IO,        ///< File IO error.
 198     CANT_CONNECT,          ///< Cannot connect to the network.
 199     CANT_LOOKUP_HOST,      ///< Fail to look up host from the DNS.
 200     FAILED_TLS_HANDSHAKE,  ///< Fail to SSL/TLS handshake.
 201     INVALID_CERTIFICATE,   ///< Received certificate is invalid.
 202     REQUEST_TIMEOUT,       ///< Connection timeout.
 203     TOO_MANY_REDIRECTS,    ///< Too many redirects.
 204     TOO_MANY_REQUESTS,     ///< Too many requests during this load.
 205     BAD_URL,               ///< Malformed URL.
 206     UNSUPPORTED_SCHEME,    ///< Unsupported scheme.
 207     AUTHENTICATION,        ///< User authentication failed on the server.
 208     INTERNAL_SERVER        ///< Web server has an internal server error.
 209   };
 210
 211   /**
 212    * @brief WebView callback related with screen-shot captured.
 213    */
 214   using WebViewScreenshotCapturedCallback = std::function<void(Dali::Toolkit::ImageView)>;
 215
 216   /**
 217    * @brief WebView signal type related with page loading.
 218    */
 219   using WebViewPageLoadSignalType = Signal<void(WebView, const std::string&)>;
 220
 221   /**
 222    * @brief WebView signal type related with page loading error.
 223    */
 224   using WebViewPageLoadErrorSignalType = Signal<void(WebView, const std::string&, LoadErrorCode)>;
 225
 226   /**
 227    * @brief WebView signal type related with scroll edge reached.
 228    */
 229   using WebViewScrollEdgeReachedSignalType = Signal<void(WebView, Dali::WebEnginePlugin::ScrollEdge)>;
 230
 231   /**
 232    * @brief WebView signal type related with url changed.
 233    */
 234   using WebViewUrlChangedSignalType = Signal<void(WebView, const std::string&)>;
 235
 236   /**
 237    * @brief WebView signal type related with form repost decision.
 238    */
 239   using WebViewFormRepostDecisionSignalType = Signal<void(WebView, std::shared_ptr<Dali::Toolkit::WebFormRepostDecision>)>;
 240
 241   /**
 242    * @brief WebView signal type related with frame rendered.
 243    */
 244   using WebViewFrameRenderedSignalType = Signal<void(WebView)>;
 245
 246 public:
 247   /**
 248    * @brief Creates an initialized WebView.
 249    * @return A handle to a newly allocated Dali WebView
 250    *
 251    * @note WebView will not display anything
 252    */
 253   static WebView New();
 254
 255   /**
 256    * @brief Creates an initialized WebView.
 257    *
 258    * @param [in] locale The locale of Web
 259    * @param [in] timezoneId The timezoneId of Web
 260    */
 261   static WebView New(const std::string& locale, const std::string& timezoneId);
 262
 263   /**
 264    * @brief Creates an initialized WebView.
 265    *
 266    * @param [in] argc The count of arguments of Applications
 267    * @param [in] argv The string array of arguments of Applications
 268    */
 269   static WebView New(int argc, char** argv);
 270
 271   /**
 272    * @brief Creates an uninitialized WebView.
 273    */
 274   WebView();
 275
 276   /**
 277    * @brief Destructor.
 278    *
 279    * This is non-virtual since derived Handel types must not contain data or virtual methods.
 280    */
 281   ~WebView();
 282
 283   /*
 284    * @brief Copy constructor.
 285    *
 286    * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation
 287    */
 288   WebView(const WebView& WebView);
 289
 290   /**
 291    * @brief Assignment operator.
 292    *
 293    * @param[in] WebView The WebView to assign from
 294    * @return The updated WebView
 295    */
 296   WebView& operator=(const WebView& WebView);
 297
 298   /**
 299    * @brief Downcasts a handle to WebView handle.
 300    *
 301    * If handle points to a WebView, the downcast produces valid handle.
 302    * If not, the returned handle is left uninitialized.
 303    *
 304    * @param[in] handle Handle to an object
 305    * @return Handle to a WebView or an uninitialized handle
 306    */
 307   static WebView DownCast(BaseHandle handle);
 308
 309   /**
 310    * @brief Get WebSettings of WebEngine.
 311    */
 312   Dali::Toolkit::WebSettings* GetSettings() const;
 313
 314   /**
 315    * @brief Get WebContext of WebEngine.
 316    */
 317   Dali::Toolkit::WebContext* GetContext() const;
 318
 319   /**
 320    * @brief Get CookieManager of WebEngine.
 321    */
 322   Dali::Toolkit::WebCookieManager* GetCookieManager() const;
 323
 324   /**
 325    * @brief Get WebBackForwardList of WebEngine.
 326    */
 327   Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
 328
 329   /**
 330    * @brief Get Favicon of web page.
 331    *
 332    * @return Handle to a fav icon
 333    */
 334   Dali::Toolkit::ImageView& GetFavicon();
 335
 336   /**
 337    * @brief Loads a web page based on a given URL.
 338    *
 339    * @param [in] url The URL of the resource to load
 340    */
 341   void LoadUrl(const std::string& url);
 342
 343   /**
 344    * @brief Loads a given string as web contents.
 345    *
 346    * @param [in] htmlString The string to use as the contents of the web page
 347    */
 348   void LoadHtmlString(const std::string& htmlString);
 349
 350   /**
 351    * @brief Load the specified html string as the content of the view overriding current history entry
 352    *
 353    * @param[in] html HTML data to load
 354    * @param[in] basicUri Base URL used for relative paths to external objects
 355    * @param[in] unreachableUrl URL that could not be reached
 356    *
 357    * @return true if successfully loaded, false otherwise
 358    */
 359   bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
 360
 361   /**
 362    * @brief Requests loading the given contents by MIME type into the view object
 363    *
 364    * @param[in] contents The content to load
 365    * @param[in] contentSize The size of contents (in bytes)
 366    * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
 367    * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
 368    * @param[in] baseUri The base URI to use for relative resources
 369    *
 370    * @return true if successfully request, false otherwise
 371    */
 372   bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
 373
 374   /**
 375    * @brief Reloads the Web.
 376    */
 377   void Reload();
 378
 379   /**
 380    * @brief Reloads the current page's document without cache
 381    */
 382   bool ReloadWithoutCache();
 383
 384   /**
 385    * @brief Stops loading web contents on the current page.
 386    */
 387   void StopLoading();
 388
 389   /**
 390    * @brief Suspends the operation associated with the view.
 391    */
 392   void Suspend();
 393
 394   /**
 395    * @brief Resumes the operation associated with the view object after calling Suspend().
 396    */
 397   void Resume();
 398
 399   /**
 400    * @brief To suspend all url loading
 401    */
 402   void SuspendNetworkLoading();
 403
 404   /**
 405    * @brief To resume new url network loading
 406    */
 407   void ResumeNetworkLoading();
 408
 409   /**
 410    * @brief Add custom header
 411    *
 412    * @param[in] name custom header name to add the custom header
 413    * @param[in] value custom header value to add the custom header
 414    *
 415    * @return true if succeeded, false otherwise
 416    */
 417   bool AddCustomHeader(const std::string& name, const std::string& value);
 418
 419   /**
 420    * @brief Remove custom header
 421    *
 422    * @param[in] name custom header name to remove the custom header
 423    *
 424    * @return true if succeeded, false otherwise
 425    */
 426   bool RemoveCustomHeader(const std::string& name);
 427
 428   /**
 429    * @brief Start the inspector server
 430    *
 431    * @param[in] port port number
 432    *
 433    * @return the port number
 434    */
 435   uint32_t StartInspectorServer(uint32_t port);
 436
 437   /**
 438    * @brief Stop the inspector server
 439    *
 440    * @return true if succeeded, false otherwise
 441    */
 442   bool StopInspectorServer();
 443
 444   /**
 445    * @brief Scrolls web page of view by deltaX and deltaY.
 446    * @param[in] deltaX The delta x of scroll
 447    * @param[in] deltaY The delta y of scroll
 448    */
 449   void ScrollBy(int deltaX, int deltaY);
 450
 451   /**
 452    * @brief Scrolls edge of view by deltaX and deltaY.
 453    *
 454    * @param[in] deltaX horizontal offset to scroll
 455    * @param[in] deltaY vertical offset to scroll
 456    *
 457    * @return true if succeeded, false otherwise
 458    */
 459   bool ScrollEdgeBy(int deltaX, int deltaY);
 460
 461   /**
 462    * @brief Returns whether forward is possible.
 463    *
 464    * @return True if forward is possible, false otherwise
 465    */
 466   bool CanGoForward();
 467
 468   /**
 469    * @brief Goes forward in the navigation history.
 470    */
 471   void GoForward();
 472
 473   /**
 474    * @brief Returns whether backward is possible.
 475    *
 476    * @return True if backward is possible, false otherwise
 477    */
 478   bool CanGoBack();
 479
 480   /**
 481    * @brief Goes back in the navigation history.
 482    */
 483   void GoBack();
 484
 485   /**
 486    * @brief Evaluates JavaScript code represented as a string.
 487    *
 488    * @param[in] script The JavaScript code
 489    * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result
 490    */
 491   void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
 492
 493   /**
 494    * @brief Evaluates JavaScript code represented as a string.
 495    *
 496    * @param[in] script The JavaScript code
 497    */
 498   void EvaluateJavaScript(const std::string& script);
 499
 500   /**
 501    * @brief Inject a JavaScript object with a message handler into the WebView.
 502    *
 503    * @note The injected object will appear in the JavaScript context to be loaded next.
 504    *
 505    * Example:
 506    *
 507    * 1. Native
 508    *
 509    *     webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
 510    *         printf( "Received a message from JS: %s", message.c_str() );
 511    *     });
 512    *
 513    *     // Start WebView by loading URL
 514    *     webview.LoadUrl( url );
 515    *
 516    * 2. JavaScript
 517    *
 518    *     myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
 519    *
 520    *
 521    * @param[in] exposedObjectName The name of exposed object
 522    * @param[in] handler The callback function
 523    */
 524   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
 525
 526   /**
 527    * @brief Register alert callback for javascript.
 528    *
 529    * @param[in] callback The callback function to be called by the JavaScript runtime.
 530    */
 531   void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
 532
 533   /**
 534    * @brief Reply for JavaScript alert.
 535    */
 536   void JavaScriptAlertReply();
 537
 538   /**
 539    * @brief Register confirm callback for javascript.
 540    *
 541    * @param[in] callback The callback function to be called by the JavaScript runtime.
 542    */
 543   void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
 544
 545   /**
 546    * @brief Reply for JavaScript confirm.
 547    * @param[in] confirmed True if confirmed, false otherwise
 548    */
 549   void JavaScriptConfirmReply(bool confirmed);
 550
 551   /**
 552    * @brief Register prompt callback for javascript.
 553    *
 554    * @param[in] callback The callback function to be called by the JavaScript runtime.
 555    */
 556   void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
 557
 558   /**
 559    * @brief Reply for JavaScript prompt.
 560    * @param[in] result The result from input-field of prompt popup.
 561    */
 562   void JavaScriptPromptReply(const std::string& result);
 563
 564   /**
 565    * @brief Clears the history of Web.
 566    */
 567   void ClearHistory();
 568
 569   /**
 570    * @brief Clears all tiles resources of Web.
 571    */
 572   void ClearAllTilesResources();
 573
 574   /**
 575    * @brief Scales the current page, centered at the given point.
 576    * @param[in] scaleFactor a new factor to be scaled.
 577    * @param[in] point a center coordinate.
 578    */
 579   void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
 580
 581   /**
 582    * @brief Gets the current scale factor of the page.
 583    * @return The current scale factor.
 584    */
 585   float GetScaleFactor() const;
 586
 587   /**
 588    * @brief Request to activate/deactivate the accessibility usage set by web app.
 589    * @param[in] activated Activate accessibility or not.
 590    */
 591   void ActivateAccessibility(bool activated);
 592
 593   /**
 594    * @brief Searches and highlights the given string in the document.
 595    * @param[in] text The text to find
 596    * @param[in] options The options to find
 597    * @param[in] maxMatchCount The maximum match count to find
 598    *
 599    * @return true if found & highlighted, false otherwise
 600    */
 601   bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
 602
 603   /**
 604    * @brief Add dynamic certificate path.
 605    * @param[in] host host that required client authentication
 606    * @param[in] certPath the file path stored certificate
 607    */
 608   void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
 609
 610   /**
 611    * @brief Get snapshot of the specified viewArea of page.
 612    *
 613    * @param[in] viewArea The rectangle of screen shot
 614    * @param[in] scaleFactor The scale factor
 615    *
 616    * @return image view of screen shot
 617    */
 618   Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor);
 619
 620   /**
 621    * @brief Request to get snapshot of the specified viewArea of page asynchronously.
 622    *
 623    * @param[in] viewArea The rectangle of screen shot
 624    * @param[in] scaleFactor The scale factor
 625    * @param[in] callback The callback for screen shot
 626    *
 627    * @return true if requested successfully, false otherwise
 628    */
 629   bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, WebViewScreenshotCapturedCallback callback);
 630
 631   /**
 632    * @brief Asynchronous request to check if there is a video playing in the given view.
 633    *
 634    * @param[in] callback The callback called after checking if video is playing or not
 635    *
 636    * @return true if requested successfully, false otherwise
 637    */
 638   bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
 639
 640   /**
 641    * @brief Sets callback which will be called upon geolocation permission request.
 642    *
 643    * @param[in] callback The callback for requesting geolocation permission
 644    */
 645   void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
 646
 647   /**
 648    * @brief Connects to this signal to be notified when page loading is started.
 649    *
 650    * @return A signal object to connect with
 651    */
 652   WebViewPageLoadSignalType& PageLoadStartedSignal();
 653
 654   /**
 655    * @brief Connects to this signal to be notified when page loading is in progress.
 656    *
 657    * @return A signal object to connect with
 658    */
 659   WebViewPageLoadSignalType& PageLoadInProgressSignal();
 660
 661   /**
 662    * @brief Connects to this signal to be notified when page loading is finished.
 663    *
 664    * @return A signal object to connect with
 665    */
 666   WebViewPageLoadSignalType& PageLoadFinishedSignal();
 667
 668   /**
 669    * @brief Connects to this signal to be notified when an error occurs in page loading.
 670    *
 671    * @return A signal object to connect with
 672    */
 673   WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
 674
 675   /**
 676    * @brief Connects to this signal to be notified when scroll edge is reached.
 677    *
 678    * @return A signal object to connect with
 679    */
 680   WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
 681
 682   /**
 683    * @brief Connects to this signal to be notified when url is changed.
 684    *
 685    * @return A signal object to connect with
 686    */
 687   WebViewUrlChangedSignalType& UrlChangedSignal();
 688
 689   /**
 690    * @brief Connects to this signal to be notified when form repost decision is requested.
 691    *
 692    * @return A signal object to connect with.
 693    */
 694   WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal();
 695
 696   /**
 697    * @brief Connects to this signal to be notified when frame is rendered.
 698    *
 699    * @return A signal object to connect with.
 700    */
 701   WebViewFrameRenderedSignalType& FrameRenderedSignal();
 702
 703 public: // Not intended for application developers
 704   /// @cond internal
 705   /**
 706    * @brief Creates a handle using the Toolkit::Internal implementation.
 707    *
 708    * @param[in] implementation The WebView implementation
 709    */
 710   DALI_INTERNAL WebView(Internal::WebView& implementation);
 711
 712   /**
 713    * @brief Allows the creation of this WebView from an Internal::CustomActor pointer.
 714    *
 715    * @param[in] internal A pointer to the internal CustomActor
 716    */
 717   explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal);
 718   /// @endcond
 719 };
 720
 721 /**
 722  * @}
 723  */
 724
 725 } // namespace Toolkit
 726
 727 } // namespace Dali
 728
 729 #endif // DALI_TOOLKIT_WEB_VIEW_H