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

   1 #ifndef DALI_WEB_ENGINE_PLUGIN_H
   2 #define DALI_WEB_ENGINE_PLUGIN_H
   3
   4 /*
   5  * Copyright (c) 2022 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/images/native-image-interface.h>
  23 #include <dali/public-api/math/rect.h>
  24 #include <dali/public-api/signals/dali-signal.h>
  25 #include <functional>
  26 #include <memory>
  27
  28 // INTERNAL INCLUDES
  29 #include <dali/devel-api/adaptor-framework/accessibility.h>
  30 #include <dali/devel-api/adaptor-framework/web-engine/web-engine-hit-test.h>
  31 #include <dali/devel-api/common/bitwise-enum.h>
  32 #include <dali/public-api/adaptor-framework/native-image-source.h>
  33
  34 namespace Dali
  35 {
  36 class KeyEvent;
  37 class PixelData;
  38 class TouchEvent;
  39 class WebEngineBackForwardList;
  40 class WebEngineCertificate;
  41 class WebEngineConsoleMessage;
  42 class WebEngineContext;
  43 class WebEngineContextMenu;
  44 class WebEngineCookieManager;
  45 class WebEngineFormRepostDecision;
  46 class WebEngineHitTest;
  47 class WebEngineHttpAuthHandler;
  48 class WebEngineLoadError;
  49 class WebEnginePolicyDecision;
  50 class WebEngineSettings;
  51 class HoverEvent;
  52 class WheelEvent;
  53
  54 /**
  55  * @brief WebEnginePlugin is an abstract interface, used by dali-adaptor to access WebEngine plugin.
  56  * A concrete implementation must be created for each platform and provided as dynamic library.
  57  */
  58 class WebEnginePlugin
  59 {
  60 public:
  61   /**
  62    * @brief WebView signal type related with frame rendered.
  63    */
  64   using WebEngineFrameRenderedSignalType = Signal<void(void)>;
  65
  66   /**
  67    * @brief WebEngine callback related with page loading.
  68    */
  69   using WebEnginePageLoadCallback = std::function<void(const std::string&)>;
  70
  71   /**
  72    * @brief WebView callback related with page loading error.
  73    */
  74   using WebEnginePageLoadErrorCallback = std::function<void(std::unique_ptr<Dali::WebEngineLoadError>)>;
  75
  76   // forward declaration.
  77   enum class ScrollEdge;
  78
  79   /**
  80    * @brief WebView callback related with scroll edge reached.
  81    */
  82   using WebEngineScrollEdgeReachedCallback = std::function<void(const ScrollEdge)>;
  83
  84   /**
  85    * @brief WebView callback related with page url changed.
  86    */
  87   using WebEngineUrlChangedCallback = std::function<void(const std::string&)>;
  88
  89   /**
  90    * @brief WebView callback related with screen captured.
  91    */
  92   using ScreenshotCapturedCallback = std::function<void(Dali::PixelData)>;
  93
  94   /**
  95    * @brief WebView callback related with geolocation permission.
  96    *  Host and protocol of security origin will be provided when requesting
  97    *  geolocation permission.
  98    *  It returns true if a pop-up is created successfully, false otherwise.
  99    */
 100   using GeolocationPermissionCallback = std::function<bool(const std::string&, const std::string&)>;
 101
 102   /**
 103    * @brief WebView callback related with video playing.
 104    */
 105   using VideoPlayingCallback = std::function<void(bool)>;
 106
 107   /**
 108    * @brief WebView callback related with console message logged.
 109    */
 110   using WebEngineConsoleMessageReceivedCallback = std::function<void(std::unique_ptr<Dali::WebEngineConsoleMessage>)>;
 111
 112   /**
 113    * @brief WebView callback related with certificate changed.
 114    */
 115   using WebEngineCertificateCallback = std::function<void(std::unique_ptr<Dali::WebEngineCertificate>)>;
 116
 117   /**
 118    * @brief WebView callback related with http authentication.
 119    */
 120   using WebEngineHttpAuthHandlerCallback = std::function<void(std::unique_ptr<Dali::WebEngineHttpAuthHandler>)>;
 121
 122   /**
 123    * @brief WebView callback related with context menu shown.
 124    */
 125   using WebEngineContextMenuShownCallback = std::function<void(std::unique_ptr<Dali::WebEngineContextMenu>)>;
 126
 127   /**
 128    * @brief WebView callback related with context menu hidden.
 129    */
 130   using WebEngineContextMenuHiddenCallback = std::function<void(std::unique_ptr<Dali::WebEngineContextMenu>)>;
 131
 132   /**
 133    * @brief Message result callback when JavaScript is executed with a message.
 134    */
 135   using JavaScriptMessageHandlerCallback = std::function<void(const std::string&)>;
 136
 137   /**
 138    * @brief Alert callback when JavaScript alert is called with a message.
 139    *  It returns true if a pop-up is created successfully, false otherwise.
 140    */
 141   using JavaScriptAlertCallback = std::function<bool(const std::string&)>;
 142
 143   /**
 144    * @brief Confirm callback when JavaScript confirm is called with a message.
 145    *  It returns true if a pop-up is created successfully, false otherwise.
 146    */
 147   using JavaScriptConfirmCallback = std::function<bool(const std::string&)>;
 148
 149   /**
 150    * @brief Prompt callback when JavaScript prompt is called with a message
 151    *  and an optional value that is the default value for the input field.
 152    *  It returns true if a pop-up is created successfully, false otherwise.
 153    */
 154   using JavaScriptPromptCallback = std::function<bool(const std::string&, const std::string&)>;
 155
 156   /**
 157    * @brief WebView callback related with form repost decision.
 158    */
 159   using WebEngineFormRepostDecidedCallback = std::function<void(std::unique_ptr<Dali::WebEngineFormRepostDecision>)>;
 160
 161   /**
 162    * @brief WebView callback related with frame rendered.
 163    */
 164   using WebEngineFrameRenderedCallback = std::function<void(void)>;
 165
 166   /**
 167    * @brief WebView callback related with response policy would be decided.
 168    */
 169   using WebEngineResponsePolicyDecidedCallback = std::function<void(std::unique_ptr<Dali::WebEnginePolicyDecision>)>;
 170
 171   /**
 172    * @brief WebView callback related with navigation policy would be decided.
 173    */
 174   using WebEngineNavigationPolicyDecidedCallback = std::function<void(std::unique_ptr<Dali::WebEnginePolicyDecision>)>;
 175
 176   /**
 177    * @brief Hit test callback called after hit test is created asynchronously.
 178    */
 179   using WebEngineHitTestCreatedCallback = std::function<bool(std::unique_ptr<Dali::WebEngineHitTest>)>;
 180
 181   /**
 182    * @brief The callback to be called when the web engine received a plain text of current web page.
 183    */
 184   using PlainTextReceivedCallback = std::function<void(const std::string&)>;
 185
 186   /**
 187    * @brief Enumeration for the scroll edge.
 188    */
 189   enum class ScrollEdge
 190   {
 191     LEFT,   ///< Left edge reached.
 192     RIGHT,  ///< Right edge reached.
 193     TOP,    ///< Top edge reached.
 194     BOTTOM, ///< Bottom edge reached.
 195   };
 196
 197   /**
 198    * @brief Enumeration that provides the option to find text.
 199    */
 200   enum class FindOption
 201   {
 202     NONE                               = 0,      ///<  No search flags, this means a case sensitive, no wrap, forward only search
 203     CASE_INSENSITIVE                   = 1 << 0, ///<  Case insensitive search
 204     AT_WORD_STARTS                     = 1 << 1, ///<  Search text only at the beginning of the words
 205     TREAT_MEDIAL_CAPITAL_AS_WORD_START = 1 << 2, ///<  Treat capital letters in the middle of words as word start
 206     BACKWARDS                          = 1 << 3, ///<  Search backwards
 207     WRAP_AROUND                        = 1 << 4, ///<  If not present the search stops at the end of the document
 208     SHOW_OVERLAY                       = 1 << 5, ///<  Show overlay
 209     SHOW_FIND_INDICATOR                = 1 << 6, ///<  Show indicator
 210     SHOW_HIGHLIGHT                     = 1 << 7, ///<  Show highlight
 211   };
 212
 213   /**
 214    * @brief Constructor.
 215    */
 216   WebEnginePlugin() = default;
 217
 218   /**
 219    * @brief Destructor.
 220    */
 221   virtual ~WebEnginePlugin() = default;
 222
 223   /**
 224    * @brief Create WebEngine instance.
 225    *
 226    * @param [in] width The width of Web
 227    * @param [in] height The height of Web
 228    * @param [in] locale The locale of Web
 229    * @param [in] timezoneId The timezoneID of Web
 230    */
 231   virtual void Create(uint32_t width, uint32_t height, const std::string& locale, const std::string& timezoneId) = 0;
 232
 233   /**
 234    * @brief Create WebEngine instance.
 235    *
 236    * @param [in] width The width of Web
 237    * @param [in] height The height of Web
 238    * @param [in] argc The count of application arguments
 239    * @param [in] argv The string array of application arguments
 240    */
 241   virtual void Create(uint32_t width, uint32_t height, uint32_t argc, char** argv) = 0;
 242
 243   /**
 244    * @brief Destroy WebEngine instance.
 245    */
 246   virtual void Destroy() = 0;
 247
 248   /**
 249    * @brief Get settings of WebEngine.
 250    */
 251   virtual WebEngineSettings& GetSettings() const = 0;
 252
 253   /**
 254    * @brief Get back-forward list of WebEngine.
 255    */
 256   virtual WebEngineBackForwardList& GetBackForwardList() const = 0;
 257
 258   /**
 259    * @brief Load a web page based on a given URL.
 260    *
 261    * @param [in] url The URL of the resource to load
 262    */
 263   virtual void LoadUrl(const std::string& url) = 0;
 264
 265   /**
 266    * @brief Return the title of the Web.
 267    *
 268    * @return The title of web page
 269    */
 270   virtual std::string GetTitle() const = 0;
 271
 272   /**
 273    * @brief Return the Favicon of the Web.
 274    *
 275    * @return Favicon of Dali::PixelData& type
 276    */
 277   virtual Dali::PixelData GetFavicon() const = 0;
 278
 279   /**
 280    * @brief Get image to render.
 281    */
 282   virtual NativeImageSourcePtr GetNativeImageSource() = 0;
 283
 284   /**
 285    * @brief Return the URL of the Web.
 286    *
 287    * @return Url of string type
 288    */
 289   virtual std::string GetUrl() const = 0;
 290
 291   /**
 292    * @brief Load a given string as web contents.
 293    *
 294    * @param [in] htmlString The string to use as the contents of the web page
 295    */
 296   virtual void LoadHtmlString(const std::string& htmlString) = 0;
 297
 298   /**
 299    * @brief Load the specified html string as the content of the view overriding current history entry
 300    *
 301    * @param[in] html HTML data to load
 302    * @param[in] basicUri Base URL used for relative paths to external objects
 303    * @param[in] unreachableUrl URL that could not be reached
 304    *
 305    * @return true if successfully loaded, false otherwise
 306    */
 307   virtual bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl) = 0;
 308
 309   /**
 310    * @brief Request loading the given contents by MIME type into the view object
 311    *
 312    * @param[in] contents The content to load
 313    * @param[in] contentSize The size of contents (in bytes)
 314    * @param[in] mimeType The type of contents, if 0 is given "text/html" is assumed
 315    * @param[in] encoding The encoding for contents, if 0 is given "UTF-8" is assumed
 316    * @param[in] baseUri The base URI to use for relative resources
 317    *
 318    * @return true if successfully request, false otherwise
 319    */
 320   virtual bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri) = 0;
 321
 322   /**
 323    * @brief Reload the Web.
 324    */
 325   virtual void Reload() = 0;
 326
 327   /**
 328    * @brief Reload the current page's document without cache
 329    */
 330   virtual bool ReloadWithoutCache() = 0;
 331
 332   /**
 333    * @brief Stop loading web contents on the current page.
 334    */
 335   virtual void StopLoading() = 0;
 336
 337   /**
 338    * @brief Suspend the operation associated with the view.
 339    */
 340   virtual void Suspend() = 0;
 341
 342   /**
 343    * @brief Resume the operation associated with the view object after calling Suspend().
 344    */
 345   virtual void Resume() = 0;
 346
 347   /**
 348    * @brief To suspend all url loading
 349    */
 350   virtual void SuspendNetworkLoading() = 0;
 351
 352   /**
 353    * @brief To resume new url network loading
 354    */
 355   virtual void ResumeNetworkLoading() = 0;
 356
 357   /**
 358    * @brief Add custom header
 359    *
 360    * @param[in] name custom header name to add the custom header
 361    * @param[in] value custom header value to add the custom header
 362    *
 363    * @return true if succeeded, false otherwise
 364    */
 365   virtual bool AddCustomHeader(const std::string& name, const std::string& value) = 0;
 366
 367   /**
 368    * @brief Remove custom header
 369    *
 370    * @param[in] name custom header name to remove the custom header
 371    *
 372    * @return true if succeeded, false otherwise
 373    */
 374   virtual bool RemoveCustomHeader(const std::string& name) = 0;
 375
 376   /**
 377    * @brief Start the inspector server
 378    *
 379    * @param[in] port port number
 380    *
 381    * @return the port number
 382    */
 383   virtual uint32_t StartInspectorServer(uint32_t port) = 0;
 384
 385   /**
 386    * @brief Stop the inspector server
 387    *
 388    * @return true if succeeded, false otherwise
 389    */
 390   virtual bool StopInspectorServer() = 0;
 391
 392   /**
 393    * @brief Scroll web page of view by deltaX and deltaY.
 394    *
 395    * @param[in] deltaX horizontal offset to scroll
 396    * @param[in] deltaY vertical offset to scroll
 397    */
 398   virtual void ScrollBy(int32_t deltaX, int32_t deltaY) = 0;
 399
 400   /**
 401    * @brief Scroll edge of view by deltaX and deltaY.
 402    *
 403    * @param[in] deltaX horizontal offset to scroll
 404    * @param[in] deltaY vertical offset to scroll
 405    *
 406    * @return true if succeeded, false otherwise
 407    */
 408   virtual bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY) = 0;
 409
 410   /**
 411    * @brief Scroll to the specified position of the given view.
 412    */
 413   virtual void SetScrollPosition(int32_t x, int32_t y) = 0;
 414
 415   /**
 416    * @brief Get the current scroll position of the given view.
 417    */
 418   virtual Dali::Vector2 GetScrollPosition() const = 0;
 419
 420   /**
 421    * @brief Get the possible scroll size of the given view.
 422    */
 423   virtual Dali::Vector2 GetScrollSize() const = 0;
 424
 425   /**
 426    * @brief Get the last known content's size.
 427    */
 428   virtual Dali::Vector2 GetContentSize() const = 0;
 429
 430   /**
 431    * @brief Return whether forward is possible.
 432    *
 433    * @return True if forward is possible, false otherwise
 434    */
 435   virtual bool CanGoForward() = 0;
 436
 437   /**
 438    * @brief Go to forward.
 439    */
 440   virtual void GoForward() = 0;
 441
 442   /**
 443    * @brief Return whether backward is possible.
 444    *
 445    * @return True if backward is possible, false otherwise
 446    */
 447   virtual bool CanGoBack() = 0;
 448
 449   /**
 450    * @brief Go to back.
 451    */
 452   virtual void GoBack() = 0;
 453
 454   /**
 455    * @brief Evaluate JavaScript code represented as a string.
 456    *
 457    * @param[in] script The JavaScript code
 458    * @param[in] resultHandler The callback function to be called by the JavaScript runtime. This carries evaluation result.
 459    */
 460   virtual void EvaluateJavaScript(const std::string& script, JavaScriptMessageHandlerCallback resultHandler) = 0;
 461
 462   /**
 463    * @brief Add a message handler into JavaScript.
 464    *
 465    * @param[in] exposedObjectName The name of exposed object
 466    * @param[in] handler The callback function
 467    */
 468   virtual void AddJavaScriptMessageHandler(const std::string& exposedObjectName, JavaScriptMessageHandlerCallback handler) = 0;
 469
 470   /**
 471    * @brief Register a callback for JavaScript alert.
 472    *
 473    * @param[in] callback The callback function
 474    */
 475   virtual void RegisterJavaScriptAlertCallback(JavaScriptAlertCallback callback) = 0;
 476
 477   /**
 478    * @brief Reply for JavaScript alert.
 479    */
 480   virtual void JavaScriptAlertReply() = 0;
 481
 482   /**
 483    * @brief Register a callback for JavaScript confirm.
 484    *
 485    * @param[in] callback The callback function
 486    */
 487   virtual void RegisterJavaScriptConfirmCallback(JavaScriptConfirmCallback callback) = 0;
 488
 489   /**
 490    * @brief Reply for JavaScript confirm.
 491    */
 492   virtual void JavaScriptConfirmReply(bool confirmed) = 0;
 493
 494   /**
 495    * @brief Register a callback for JavaScript prompt.
 496    *
 497    * @param[in] callback The callback function
 498    */
 499   virtual void RegisterJavaScriptPromptCallback(JavaScriptPromptCallback callback) = 0;
 500
 501   /**
 502    * @brief Reply for JavaScript prompt.
 503    */
 504   virtual void JavaScriptPromptReply(const std::string& result) = 0;
 505
 506   /**
 507    * @brief Create a new hit test.
 508    *
 509    * @param[in] x the horizontal position to query
 510    * @param[in] y the vertical position to query
 511    * @param[in] mode the mode of hit test
 512    *
 513    * @return a new hit test object.
 514    */
 515   virtual std::unique_ptr<Dali::WebEngineHitTest> CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode) = 0;
 516
 517   /**
 518    * @brief create a hit test asynchronously.
 519    *
 520    * @param[in] x the horizontal position to query
 521    * @param[in] y the vertical position to query
 522    * @param[in] mode the mode of hit test
 523    * @param[in] callback The callback function
 524    *
 525    * @return true if succeeded, false otherwise
 526    */
 527   virtual bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, WebEngineHitTestCreatedCallback callback) = 0;
 528
 529   /**
 530    * @brief Clear the history of Web.
 531    */
 532   virtual void ClearHistory() = 0;
 533
 534   /**
 535    * @brief Clear all tiles resources of Web.
 536    */
 537   virtual void ClearAllTilesResources() = 0;
 538
 539   /**
 540    * @brief Get user agent string.
 541    *
 542    * @return The string value of user agent
 543    */
 544   virtual std::string GetUserAgent() const = 0;
 545
 546   /**
 547    * @brief Set user agent string.
 548    *
 549    * @param[in] userAgent The string value of user agent
 550    */
 551   virtual void SetUserAgent(const std::string& userAgent) = 0;
 552
 553   /**
 554    * @brief Set size of Web Page.
 555    */
 556   virtual void SetSize(uint32_t width, uint32_t height) = 0;
 557
 558   /**
 559    * @brief Set background color of web page.
 560    *
 561    * @param[in] color Background color
 562    */
 563   virtual void SetDocumentBackgroundColor(Dali::Vector4 color) = 0;
 564
 565   /**
 566    * @brief Clear tiles when hidden.
 567    *
 568    * @param[in] cleared Whether tiles are cleared or not
 569    */
 570   virtual void ClearTilesWhenHidden(bool cleared) = 0;
 571
 572   /**
 573    * @brief Set multiplier of cover area of tile.
 574    *
 575    * @param[in] multiplier The multiplier of cover area
 576    */
 577   virtual void SetTileCoverAreaMultiplier(float multiplier) = 0;
 578
 579   /**
 580    * @brief Enable cursor by client.
 581    *
 582    * @param[in] enabled Whether cursor is enabled or not
 583    */
 584   virtual void EnableCursorByClient(bool enabled) = 0;
 585
 586   /**
 587    * @brief Get the selected text.
 588    *
 589    * @return the selected text
 590    */
 591   virtual std::string GetSelectedText() const = 0;
 592
 593   /**
 594    * @brief Send Touch Events.
 595    */
 596   virtual bool SendTouchEvent(const TouchEvent& touch) = 0;
 597
 598   /**
 599    * @brief Send Key Events.
 600    */
 601   virtual bool SendKeyEvent(const KeyEvent& event) = 0;
 602
 603   /**
 604    * @brief Support mouse events or not.
 605    * @param[in] enabled True if enabled, false othewise.
 606    */
 607   virtual void EnableMouseEvents(bool enabled) = 0;
 608
 609   /**
 610    * @brief Support key events or not.
 611    * @param[in] enabled True if enabled, false othewise.
 612    */
 613   virtual void EnableKeyEvents(bool enabled) = 0;
 614
 615   /**
 616    * @brief Set focus.
 617    * @param[in] focused True if focus is gained, false lost.
 618    */
 619   virtual void SetFocus(bool focused) = 0;
 620
 621   /**
 622    * @brief Set zoom factor of the current page.
 623    * @param[in] zoomFactor a new factor to be set.
 624    */
 625   virtual void SetPageZoomFactor(float zoomFactor) = 0;
 626
 627   /**
 628    * @brief Query the current zoom factor of the page。
 629    * @return The current page zoom factor.
 630    */
 631   virtual float GetPageZoomFactor() const = 0;
 632
 633   /**
 634    * @brief Set the current text zoom level。.
 635    * @param[in] zoomFactor a new factor to be set.
 636    */
 637   virtual void SetTextZoomFactor(float zoomFactor) = 0;
 638
 639   /**
 640    * @brief Get the current text zoom level.
 641    * @return The current text zoom factor.
 642    */
 643   virtual float GetTextZoomFactor() const = 0;
 644
 645   /**
 646    * @brief Get the current load progress of the page.
 647    * @return The load progress of the page.
 648    */
 649   virtual float GetLoadProgressPercentage() const = 0;
 650
 651   /**
 652    * @brief Scale the current page, centered at the given point.
 653    * @param[in] scaleFactor a new factor to be scaled.
 654    * @param[in] point a center coordinate.
 655    */
 656   virtual void SetScaleFactor(float scaleFactor, Dali::Vector2 point) = 0;
 657
 658   /**
 659    * @brief Get the current scale factor of the page.
 660    * @return The current scale factor.
 661    */
 662   virtual float GetScaleFactor() const = 0;
 663
 664   /**
 665    * @brief Request to activate/deactivate the accessibility usage set by web app.
 666    * @param[in] activated Activate accessibility or not.
 667    */
 668   virtual void ActivateAccessibility(bool activated) = 0;
 669
 670   /**
 671    * @brief Get the accessibility address (bus and path) for embedding.
 672    * @return Accessibility address of the root web content element.
 673    */
 674   virtual Accessibility::Address GetAccessibilityAddress() = 0;
 675
 676   /**
 677    * @brief Request to set the current page's visibility.
 678    * @param[in] visible Visible or not.
 679    *
 680    * @return true if succeeded, false otherwise
 681    */
 682   virtual bool SetVisibility(bool visible) = 0;
 683
 684   /**
 685    * @brief Search and highlight the given string in the document.
 686    * @param[in] text The text to find
 687    * @param[in] options The options to find
 688    * @param[in] maxMatchCount The maximum match count to find
 689    *
 690    * @return true if found & highlighted, false otherwise
 691    */
 692   virtual bool HighlightText(const std::string& text, FindOption options, uint32_t maxMatchCount) = 0;
 693
 694   /**
 695    * @brief Add dynamic certificate path.
 696    * @param[in] host host that required client authentication
 697    * @param[in] certPath the file path stored certificate
 698    */
 699   virtual void AddDynamicCertificatePath(const std::string& host, const std::string& certPath) = 0;
 700
 701   /**
 702    * @brief Get snapshot of the specified viewArea of page.
 703    *
 704    * @param[in] viewArea The rectangle of screen shot
 705    * @param[in] scaleFactor The scale factor
 706    *
 707    * @return pixel data of screen shot
 708    */
 709   virtual Dali::PixelData GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor) = 0;
 710
 711   /**
 712    * @brief Request to get snapshot of the specified viewArea of page asynchronously.
 713    *
 714    * @param[in] viewArea The rectangle of screen shot
 715    * @param[in] scaleFactor The scale factor
 716    * @param[in] callback The callback for screen shot
 717    *
 718    * @return true if requested successfully, false otherwise
 719    */
 720   virtual bool GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, ScreenshotCapturedCallback callback) = 0;
 721
 722   /**
 723    * @brief Asynchronously request to check if there is a video playing in the given view.
 724    *
 725    * @param[in] callback The callback called after checking if video is playing or not
 726    *
 727    * @return true if requested successfully, false otherwise
 728    */
 729   virtual bool CheckVideoPlayingAsynchronously(VideoPlayingCallback callback) = 0;
 730
 731   /**
 732    * @brief Set callback which will be called upon geolocation permission request.
 733    *
 734    * @param[in] callback The callback for requesting geolocation permission
 735    */
 736   virtual void RegisterGeolocationPermissionCallback(GeolocationPermissionCallback callback) = 0;
 737
 738   /**
 739    * @brief Update display area.
 740    * @param[in] displayArea The display area need be updated.
 741    */
 742   virtual void UpdateDisplayArea(Dali::Rect<int32_t> displayArea) = 0;
 743
 744   /**
 745    * @brief Enable video hole.
 746    * @param[in] enabled True if enabled, false othewise.
 747    */
 748   virtual void EnableVideoHole(bool enabled) = 0;
 749
 750   /**
 751    * @brief Send Hover Events.
 752    * @param[in] event The hover event would be sent.
 753    */
 754   virtual bool SendHoverEvent(const HoverEvent& event) = 0;
 755
 756   /**
 757    * @brief Send Wheel Events.
 758    * @param[in] event The wheel event would be sent.
 759    */
 760   virtual bool SendWheelEvent(const WheelEvent& event) = 0;
 761
 762   /**
 763    * @brief Connect to this signal to be notified when frame is rendered.
 764    *
 765    * @return A signal object to connect with.
 766    */
 767   virtual WebEngineFrameRenderedSignalType& FrameRenderedSignal() = 0;
 768
 769   /**
 770    * @brief Callback to be called when page loading is started.
 771    *
 772    * @param[in] callback
 773    */
 774   virtual void RegisterPageLoadStartedCallback(WebEnginePageLoadCallback callback) = 0;
 775
 776   /**
 777    * @brief Callback to be called when page loading is in progress.
 778    *
 779    * @param[in] callback
 780    */
 781   virtual void RegisterPageLoadInProgressCallback(WebEnginePageLoadCallback callback) = 0;
 782
 783   /**
 784    * @brief Callback to be called when page loading is finished.
 785    *
 786    * @param[in] callback
 787    */
 788   virtual void RegisterPageLoadFinishedCallback(WebEnginePageLoadCallback callback) = 0;
 789
 790   /**
 791    * @brief Callback to be called when an error occurs in page loading.
 792    *
 793    * @param[in] callback
 794    */
 795   virtual void RegisterPageLoadErrorCallback(WebEnginePageLoadErrorCallback callback) = 0;
 796
 797   /**
 798    * @brief Callback to be called when scroll edge is reached.
 799    *
 800    * @param[in] callback
 801    */
 802   virtual void RegisterScrollEdgeReachedCallback(WebEngineScrollEdgeReachedCallback callback) = 0;
 803
 804   /**
 805    * @brief Callback to be called when url is changed.
 806    *
 807    * @param[in] callback
 808    */
 809   virtual void RegisterUrlChangedCallback(WebEngineUrlChangedCallback callback) = 0;
 810
 811   /**
 812    * @brief Callback to be called when form repost decision is requested.
 813    *
 814    * @param[in] callback
 815    */
 816   virtual void RegisterFormRepostDecidedCallback(WebEngineFormRepostDecidedCallback callback) = 0;
 817
 818   /**
 819    * @brief Callback to be called when console message will be logged.
 820    *
 821    * @param[in] callback
 822    */
 823   virtual void RegisterConsoleMessageReceivedCallback(WebEngineConsoleMessageReceivedCallback callback) = 0;
 824
 825   /**
 826    * @brief Callback to be called when response policy would be decided.
 827    *
 828    * @param[in] callback
 829    */
 830   virtual void RegisterResponsePolicyDecidedCallback(WebEngineResponsePolicyDecidedCallback callback) = 0;
 831
 832   /**
 833    * @brief Callback to be called when navigation policy would be decided.
 834    *
 835    * @param[in] callback
 836    */
 837   virtual void RegisterNavigationPolicyDecidedCallback(WebEngineNavigationPolicyDecidedCallback callback) = 0;
 838
 839   /**
 840    * @brief Callback to be called when certificate need be confirmed.
 841    *
 842    * @param[in] callback
 843    */
 844   virtual void RegisterCertificateConfirmedCallback(WebEngineCertificateCallback callback) = 0;
 845
 846   /**
 847    * @brief Callback to be called when ssl certificate is changed.
 848    *
 849    * @param[in] callback
 850    */
 851   virtual void RegisterSslCertificateChangedCallback(WebEngineCertificateCallback callback) = 0;
 852
 853   /**
 854    * @brief Callback to be called when http authentication need be confirmed.
 855    *
 856    * @param[in] callback
 857    */
 858   virtual void RegisterHttpAuthHandlerCallback(WebEngineHttpAuthHandlerCallback callback) = 0;
 859
 860   /**
 861    * @brief Callback to be called when context menu would be shown.
 862    *
 863    * @param[in] callback
 864    */
 865   virtual void RegisterContextMenuShownCallback(WebEngineContextMenuShownCallback callback) = 0;
 866
 867   /**
 868    * @brief Callback to be called when context menu would be hidden.
 869    *
 870    * @param[in] callback
 871    */
 872   virtual void RegisterContextMenuHiddenCallback(WebEngineContextMenuHiddenCallback callback) = 0;
 873
 874   /**
 875    * @brief Get a plain text of current web page asynchronously.
 876    *
 877    * @param[in] callback The callback function called asynchronously.
 878    */
 879   virtual void GetPlainTextAsynchronously(PlainTextReceivedCallback callback) = 0;
 880 };
 881
 882 // specialization has to be done in the same namespace
 883 template<>
 884 struct EnableBitMaskOperators<WebEnginePlugin::FindOption>
 885 {
 886   static const bool ENABLE = true;
 887 };
 888
 889 } // namespace Dali
 890
 891 #endif