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 WebView callback related with screen-shot captured.
 191    */
 192   using WebViewScreenshotCapturedCallback = std::function<void(Dali::Toolkit::ImageView)>;
 193
 194   /**
 195    * @brief WebView signal type related with page loading.
 196    */
 197   using WebViewPageLoadSignalType = Signal<void(WebView, const std::string&)>;
 198
 199   /**
 200    * @brief WebView signal type related with page loading error.
 201    */
 202   using WebViewPageLoadErrorSignalType = Signal<void(WebView, std::shared_ptr<Dali::WebEngineLoadError>)>;
 203
 204   /**
 205    * @brief WebView signal type related with scroll edge reached.
 206    */
 207   using WebViewScrollEdgeReachedSignalType = Signal<void(WebView, Dali::WebEnginePlugin::ScrollEdge)>;
 208
 209   /**
 210    * @brief WebView signal type related with url changed.
 211    */
 212   using WebViewUrlChangedSignalType = Signal<void(WebView, const std::string&)>;
 213
 214   /**
 215    * @brief WebView signal type related with form repost decision.
 216    */
 217   using WebViewFormRepostDecisionSignalType = Signal<void(WebView, std::shared_ptr<Dali::Toolkit::WebFormRepostDecision>)>;
 218
 219   /**
 220    * @brief WebView signal type related with frame rendered.
 221    */
 222   using WebViewFrameRenderedSignalType = Signal<void(WebView)>;
 223
 224   /**
 225    * @brief WebView signal type related with http request interceptor.
 226    */
 227   using WebViewRequestInterceptorSignalType = Signal<void(WebView, std::shared_ptr<Dali::WebEngineRequestInterceptor>)>;
 228
 229   /**
 230    * @brief WebView signal type related with console message.
 231    */
 232   using WebViewConsoleMessageSignalType = Signal<void(WebView, std::shared_ptr<Dali::WebEngineConsoleMessage>)>;
 233
 234   /**
 235    * @brief WebView signal type related with policy decision.
 236    */
 237   using WebViewPolicyDecisionSignalType = Signal<void(WebView, std::shared_ptr<Dali::WebEnginePolicyDecision>)>;
 238
 239 public:
 240   /**
 241    * @brief Creates an initialized WebView.
 242    * @return A handle to a newly allocated Dali WebView
 243    *
 244    * @note WebView will not display anything
 245    */
 246   static WebView New();
 247
 248   /**
 249    * @brief Creates an initialized WebView.
 250    *
 251    * @param [in] locale The locale of Web
 252    * @param [in] timezoneId The timezoneId of Web
 253    */
 254   static WebView New(const std::string& locale, const std::string& timezoneId);
 255
 256   /**
 257    * @brief Creates an initialized WebView.
 258    *
 259    * @param [in] argc The count of arguments of Applications
 260    * @param [in] argv The string array of arguments of Applications
 261    */
 262   static WebView New(int argc, char** argv);
 263
 264   /**
 265    * @brief Creates an uninitialized WebView.
 266    */
 267   WebView();
 268
 269   /**
 270    * @brief Destructor.
 271    *
 272    * This is non-virtual since derived Handel types must not contain data or virtual methods.
 273    */
 274   ~WebView();
 275
 276   /*
 277    * @brief Copy constructor.
 278    *
 279    * @param[in] WebView WebView to copy. The copied WebView will point at the same implementation
 280    */
 281   WebView(const WebView& WebView);
 282
 283   /**
 284    * @brief Assignment operator.
 285    *
 286    * @param[in] WebView The WebView to assign from
 287    * @return The updated WebView
 288    */
 289   WebView& operator=(const WebView& WebView);
 290
 291   /**
 292    * @brief Downcasts a handle to WebView handle.
 293    *
 294    * If handle points to a WebView, the downcast produces valid handle.
 295    * If not, the returned handle is left uninitialized.
 296    *
 297    * @param[in] handle Handle to an object
 298    * @return Handle to a WebView or an uninitialized handle
 299    */
 300   static WebView DownCast(BaseHandle handle);
 301
 302   /**
 303    * @brief Get WebSettings of WebEngine.
 304    */
 305   Dali::Toolkit::WebSettings* GetSettings() const;
 306
 307   /**
 308    * @brief Get WebContext of WebEngine.
 309    */
 310   Dali::Toolkit::WebContext* GetContext() const;
 311
 312   /**
 313    * @brief Get CookieManager of WebEngine.
 314    */
 315   Dali::Toolkit::WebCookieManager* GetCookieManager() const;
 316
 317   /**
 318    * @brief Get WebBackForwardList of WebEngine.
 319    */
 320   Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
 321
 322   /**
 323    * @brief Get Favicon of web page.
 324    *
 325    * @return Handle to a fav icon
 326    */
 327   Dali::Toolkit::ImageView& GetFavicon();
 328
 329   /**
 330    * @brief Loads a web page based on a given URL.
 331    *
 332    * @param [in] url The URL of the resource to load
 333    */
 334   void LoadUrl(const std::string& url);
 335
 336   /**
 337    * @brief Loads a given string as web contents.
 338    *
 339    * @param [in] htmlString The string to use as the contents of the web page
 340    */
 341   void LoadHtmlString(const std::string& htmlString);
 342
 343   /**
 344    * @brief Load the specified html string as the content of the view overriding current history entry
 345    *
 346    * @param[in] html HTML data to load
 347    * @param[in] basicUri Base URL used for relative paths to external objects
 348    * @param[in] unreachableUrl URL that could not be reached
 349    *
 350    * @return true if successfully loaded, false otherwise
 351    */
 352   bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
 353
 354   /**
 355    * @brief Requests loading the given contents by MIME type into the view object
 356    *
 357    * @param[in] contents The content to load
 358    * @param[in] contentSize The size of contents (in bytes)
 359    * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
 360    * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
 361    * @param[in] baseUri The base URI to use for relative resources
 362    *
 363    * @return true if successfully request, false otherwise
 364    */
 365   bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
 366
 367   /**
 368    * @brief Reloads the Web.
 369    */
 370   void Reload();
 371
 372   /**
 373    * @brief Reloads the current page's document without cache
 374    */
 375   bool ReloadWithoutCache();
 376
 377   /**
 378    * @brief Stops loading web contents on the current page.
 379    */
 380   void StopLoading();
 381
 382   /**
 383    * @brief Suspends the operation associated with the view.
 384    */
 385   void Suspend();
 386
 387   /**
 388    * @brief Resumes the operation associated with the view object after calling Suspend().
 389    */
 390   void Resume();
 391
 392   /**
 393    * @brief To suspend all url loading
 394    */
 395   void SuspendNetworkLoading();
 396
 397   /**
 398    * @brief To resume new url network loading
 399    */
 400   void ResumeNetworkLoading();
 401
 402   /**
 403    * @brief Add custom header
 404    *
 405    * @param[in] name custom header name to add the custom header
 406    * @param[in] value custom header value to add the custom header
 407    *
 408    * @return true if succeeded, false otherwise
 409    */
 410   bool AddCustomHeader(const std::string& name, const std::string& value);
 411
 412   /**
 413    * @brief Remove custom header
 414    *
 415    * @param[in] name custom header name to remove the custom header
 416    *
 417    * @return true if succeeded, false otherwise
 418    */
 419   bool RemoveCustomHeader(const std::string& name);
 420
 421   /**
 422    * @brief Start the inspector server
 423    *
 424    * @param[in] port port number
 425    *
 426    * @return the port number
 427    */
 428   uint32_t StartInspectorServer(uint32_t port);
 429
 430   /**
 431    * @brief Stop the inspector server
 432    *
 433    * @return true if succeeded, false otherwise
 434    */
 435   bool StopInspectorServer();
 436
 437   /**
 438    * @brief Scrolls web page of view by deltaX and deltaY.
 439    * @param[in] deltaX The delta x of scroll
 440    * @param[in] deltaY The delta y of scroll
 441    */
 442   void ScrollBy(int deltaX, int deltaY);
 443
 444   /**
 445    * @brief Scrolls edge of view by deltaX and deltaY.
 446    *
 447    * @param[in] deltaX horizontal offset to scroll
 448    * @param[in] deltaY vertical offset to scroll
 449    *
 450    * @return true if succeeded, false otherwise
 451    */
 452   bool ScrollEdgeBy(int deltaX, int deltaY);
 453
 454   /**
 455    * @brief Returns whether forward is possible.
 456    *
 457    * @return True if forward is possible, false otherwise
 458    */
 459   bool CanGoForward();
 460
 461   /**
 462    * @brief Goes forward in the navigation history.
 463    */
 464   void GoForward();
 465
 466   /**
 467    * @brief Returns whether backward is possible.
 468    *
 469    * @return True if backward is possible, false otherwise
 470    */
 471   bool CanGoBack();
 472
 473   /**
 474    * @brief Goes back in the navigation history.
 475    */
 476   void GoBack();
 477
 478   /**
 479    * @brief Evaluates JavaScript code represented as a string.
 480    *
 481    * @param[in] script The JavaScript code
 482    * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result
 483    */
 484   void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
 485
 486   /**
 487    * @brief Evaluates JavaScript code represented as a string.
 488    *
 489    * @param[in] script The JavaScript code
 490    */
 491   void EvaluateJavaScript(const std::string& script);
 492
 493   /**
 494    * @brief Inject a JavaScript object with a message handler into the WebView.
 495    *
 496    * @note The injected object will appear in the JavaScript context to be loaded next.
 497    *
 498    * Example:
 499    *
 500    * 1. Native
 501    *
 502    *     webview.AddJavaScriptMessageHandler( "myObject", []( const std::string& message ) {
 503    *         printf( "Received a message from JS: %s", message.c_str() );
 504    *     });
 505    *
 506    *     // Start WebView by loading URL
 507    *     webview.LoadUrl( url );
 508    *
 509    * 2. JavaScript
 510    *
 511    *     myObject.postMessage( "Hello World!" ); // "Received a message from JS: Hello World!"
 512    *
 513    *
 514    * @param[in] exposedObjectName The name of exposed object
 515    * @param[in] handler The callback function
 516    */
 517   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
 518
 519   /**
 520    * @brief Register alert callback for javascript.
 521    *
 522    * @param[in] callback The callback function to be called by the JavaScript runtime.
 523    */
 524   void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
 525
 526   /**
 527    * @brief Reply for JavaScript alert.
 528    */
 529   void JavaScriptAlertReply();
 530
 531   /**
 532    * @brief Register confirm callback for javascript.
 533    *
 534    * @param[in] callback The callback function to be called by the JavaScript runtime.
 535    */
 536   void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
 537
 538   /**
 539    * @brief Reply for JavaScript confirm.
 540    * @param[in] confirmed True if confirmed, false otherwise
 541    */
 542   void JavaScriptConfirmReply(bool confirmed);
 543
 544   /**
 545    * @brief Register prompt callback for javascript.
 546    *
 547    * @param[in] callback The callback function to be called by the JavaScript runtime.
 548    */
 549   void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
 550
 551   /**
 552    * @brief Reply for JavaScript prompt.
 553    * @param[in] result The result from input-field of prompt popup.
 554    */
 555   void JavaScriptPromptReply(const std::string& result);
 556
 557   /**
 558    * @brief Clears the history of Web.
 559    */
 560   void ClearHistory();
 561
 562   /**
 563    * @brief Clears all tiles resources of Web.
 564    */
 565   void ClearAllTilesResources();
 566
 567   /**
 568    * @brief Scales the current page, centered at the given point.
 569    * @param[in] scaleFactor a new factor to be scaled.
 570    * @param[in] point a center coordinate.
 571    */
 572   void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
 573
 574   /**
 575    * @brief Gets the current scale factor of the page.
 576    * @return The current scale factor.
 577    */
 578   float GetScaleFactor() const;
 579
 580   /**
 581    * @brief Request to activate/deactivate the accessibility usage set by web app.
 582    * @param[in] activated Activate accessibility or not.
 583    */
 584   void ActivateAccessibility(bool activated);
 585
 586   /**
 587    * @brief Searches and highlights the given string in the document.
 588    * @param[in] text The text to find
 589    * @param[in] options The options to find
 590    * @param[in] maxMatchCount The maximum match count to find
 591    *
 592    * @return true if found & highlighted, false otherwise
 593    */
 594   bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
 595
 596   /**
 597    * @brief Add dynamic certificate path.
 598    * @param[in] host host that required client authentication
 599    * @param[in] certPath the file path stored certificate
 600    */
 601   void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
 602
 603   /**
 604    * @brief Get snapshot of the specified viewArea of page.
 605    *
 606    * @param[in] viewArea The rectangle of screen shot
 607    * @param[in] scaleFactor The scale factor
 608    *
 609    * @return image view of screen shot
 610    */
 611   Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor);
 612
 613   /**
 614    * @brief Request to get snapshot of the specified viewArea of page asynchronously.
 615    *
 616    * @param[in] viewArea The rectangle of screen shot
 617    * @param[in] scaleFactor The scale factor
 618    * @param[in] callback The callback for screen shot
 619    *
 620    * @return true if requested successfully, false otherwise
 621    */
 622   bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, WebViewScreenshotCapturedCallback callback);
 623
 624   /**
 625    * @brief Asynchronous request to check if there is a video playing in the given view.
 626    *
 627    * @param[in] callback The callback called after checking if video is playing or not
 628    *
 629    * @return true if requested successfully, false otherwise
 630    */
 631   bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
 632
 633   /**
 634    * @brief Sets callback which will be called upon geolocation permission request.
 635    *
 636    * @param[in] callback The callback for requesting geolocation permission
 637    */
 638   void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
 639
 640   /**
 641    * @brief Connects to this signal to be notified when page loading is started.
 642    *
 643    * @return A signal object to connect with
 644    */
 645   WebViewPageLoadSignalType& PageLoadStartedSignal();
 646
 647   /**
 648    * @brief Connects to this signal to be notified when page loading is in progress.
 649    *
 650    * @return A signal object to connect with
 651    */
 652   WebViewPageLoadSignalType& PageLoadInProgressSignal();
 653
 654   /**
 655    * @brief Connects to this signal to be notified when page loading is finished.
 656    *
 657    * @return A signal object to connect with
 658    */
 659   WebViewPageLoadSignalType& PageLoadFinishedSignal();
 660
 661   /**
 662    * @brief Connects to this signal to be notified when an error occurs in page loading.
 663    *
 664    * @return A signal object to connect with
 665    */
 666   WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
 667
 668   /**
 669    * @brief Connects to this signal to be notified when scroll edge is reached.
 670    *
 671    * @return A signal object to connect with
 672    */
 673   WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
 674
 675   /**
 676    * @brief Connects to this signal to be notified when url is changed.
 677    *
 678    * @return A signal object to connect with
 679    */
 680   WebViewUrlChangedSignalType& UrlChangedSignal();
 681
 682   /**
 683    * @brief Connects to this signal to be notified when form repost decision is requested.
 684    *
 685    * @return A signal object to connect with.
 686    */
 687   WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal();
 688
 689   /**
 690    * @brief Connects to this signal to be notified when frame is rendered.
 691    *
 692    * @return A signal object to connect with.
 693    */
 694   WebViewFrameRenderedSignalType& FrameRenderedSignal();
 695
 696   /**
 697    * @brief Connects to this signal to be notified when http request need be intercepted.
 698    *
 699    * @return A signal object to connect with.
 700    */
 701   WebViewRequestInterceptorSignalType& RequestInterceptorSignal();
 702
 703   /**
 704    * @brief Connects to this signal to be notified when console message will be logged.
 705    *
 706    * @return A signal object to connect with.
 707    */
 708   WebViewConsoleMessageSignalType& ConsoleMessageSignal();
 709
 710   /**
 711    * @brief Connects to this signal to be notified when new policy would be decided.
 712    *
 713    * @return A signal object to connect with.
 714    */
 715   WebViewPolicyDecisionSignalType& PolicyDecisionSignal();
 716
 717 public: // Not intended for application developers
 718   /// @cond internal
 719   /**
 720    * @brief Creates a handle using the Toolkit::Internal implementation.
 721    *
 722    * @param[in] implementation The WebView implementation
 723    */
 724   DALI_INTERNAL WebView(Internal::WebView& implementation);
 725
 726   /**
 727    * @brief Allows the creation of this WebView from an Internal::CustomActor pointer.
 728    *
 729    * @param[in] internal A pointer to the internal CustomActor
 730    */
 731   explicit DALI_INTERNAL WebView(Dali::Internal::CustomActor* internal);
 732   /// @endcond
 733 };
 734
 735 /**
 736  * @}
 737  */
 738
 739 } // namespace Toolkit
 740
 741 } // namespace Dali
 742
 743 #endif // DALI_TOOLKIT_WEB_VIEW_H