dali-toolkit/internal/controls/web-view/web-view-impl.h

   1 #ifndef DALI_TOOLKIT_INTERNAL_WEB_VIEW_H
   2 #define DALI_TOOLKIT_INTERNAL_WEB_VIEW_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/devel-api/actors/actor-devel.h>
  23 #include <dali/devel-api/adaptor-framework/proxy-accessible.h>
  24 #include <dali/devel-api/adaptor-framework/web-engine/web-engine.h>
  25 #include <dali/public-api/images/image-operations.h>
  26 #include <dali/public-api/object/property-notification.h>
  27 #include <memory>
  28 #include <unordered_map>
  29
  30 // INTERNAL INCLUDES
  31 #include <dali-toolkit/devel-api/controls/control-accessible.h>
  32 #include <dali-toolkit/devel-api/controls/web-view/web-view.h>
  33 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
  34 #include <dali-toolkit/public-api/controls/control-impl.h>
  35 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
  36
  37 namespace Dali
  38 {
  39 namespace Toolkit
  40 {
  41 class KeyEvent;
  42 class TouchEvent;
  43 class WebBackForwardList;
  44 class WebSettings;
  45 class WebView;
  46
  47 namespace Internal
  48 {
  49 class WebView : public Control
  50 {
  51 protected:
  52   WebView();
  53
  54   WebView(const std::string& locale, const std::string& timezoneId);
  55
  56   WebView(uint32_t argc, char** argv);
  57
  58   virtual ~WebView();
  59
  60 public:
  61   /**
  62    * @copydoc Dali::Toolkit::WebView::New()
  63    */
  64   static Toolkit::WebView New();
  65
  66   /**
  67    * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
  68    */
  69   static Toolkit::WebView New(const std::string& locale, const std::string& timezoneId);
  70
  71   /**
  72    * @copydoc Dali::Toolkit::WebView::New( uint32_t, char** )
  73    */
  74   static Toolkit::WebView New(uint32_t argc, char** argv);
  75
  76   /**
  77    * @copydoc Dali::Toolkit::WebView::FindWebView()
  78    */
  79   static Toolkit::WebView FindWebView(Dali::WebEnginePlugin* plugin);
  80
  81   /**
  82    * @copydoc Dali::Toolkit::WebView::GetContext()
  83    */
  84   static Dali::WebEngineContext* GetContext();
  85
  86   /**
  87    * @copydoc Dali::Toolkit::WebView::GetCookieManager()
  88    */
  89   static Dali::WebEngineCookieManager* GetCookieManager();
  90
  91   /**
  92    * @copydoc Dali::Toolkit::WebView::GetSettings()
  93    */
  94   Dali::Toolkit::WebSettings* GetSettings() const;
  95
  96   /**
  97    * @copydoc Dali::Toolkit::WebView::GetBackForwardList()
  98    */
  99   Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
 100
 101   /**
 102    * @copydoc Dali::Toolkit::WebView::GetFavicon()
 103    */
 104   Dali::Toolkit::ImageView GetFavicon() const;
 105
 106   /**
 107    * @copydoc Dali::Toolkit::WebView::LoadUrl()
 108    */
 109   void LoadUrl(const std::string& url);
 110
 111   /**
 112    * @copydoc Dali::WebEngine::LoadHTMLString()
 113    */
 114   void LoadHtmlString(const std::string& htmlString);
 115
 116   /**
 117    * @copydoc Dali::WebEngine::LoadHtmlStringOverrideCurrentEntry()
 118    */
 119   bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
 120
 121   /**
 122    * @copydoc Dali::WebEngine::LoadContents()
 123    */
 124   bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
 125
 126   /**
 127    * @copydoc Dali::Toolkit::WebView::Reload()
 128    */
 129   void Reload();
 130
 131   /**
 132    * @copydoc Dali::WebEngine::ReloadWithoutCache()
 133    */
 134   bool ReloadWithoutCache();
 135
 136   /**
 137    * @copydoc Dali::Toolkit::WebView::StopLoading()
 138    */
 139   void StopLoading();
 140
 141   /**
 142    * @copydoc Dali::Toolkit::WebView::StopLoading()
 143    */
 144   void Suspend();
 145
 146   /**
 147    * @copydoc Dali::Toolkit::WebView::Resume()
 148    */
 149   void Resume();
 150
 151   /**
 152    * @copydoc Dali::WebEngine::SuspendNetworkLoading()
 153    */
 154   void SuspendNetworkLoading();
 155
 156   /**
 157    * @copydoc Dali::WebEngine::ResumeNetworkLoading()
 158    */
 159   void ResumeNetworkLoading();
 160
 161   /**
 162    * @copydoc Dali::WebEngine::AddCustomHeader()
 163    */
 164   bool AddCustomHeader(const std::string& name, const std::string& value);
 165
 166   /**
 167    * @copydoc Dali::WebEngine::RemoveCustomHeader()
 168    */
 169   bool RemoveCustomHeader(const std::string& name);
 170
 171   /**
 172    * @copydoc Dali::WebEngine::StartInspectorServer()
 173    */
 174   uint32_t StartInspectorServer(uint32_t port);
 175
 176   /**
 177    * @copydoc Dali::WebEngine::StopInspectorServer()
 178    */
 179   bool StopInspectorServer();
 180
 181   /**
 182    * @copydoc Dali::Toolkit::WebView::ScrollBy()
 183    */
 184   void ScrollBy(int32_t deltaX, int32_t deltaY);
 185
 186   /**
 187    * @copydoc Dali::WebEngine::ScrollEdgeBy()
 188    */
 189   bool ScrollEdgeBy(int32_t deltaX, int32_t deltaY);
 190
 191   /**
 192    * @copydoc Dali::Toolkit::WebView::CanGoForward()
 193    */
 194   bool CanGoForward();
 195
 196   /**
 197    * @copydoc Dali::Toolkit::WebView::GoForward()
 198    */
 199   void GoForward();
 200
 201   /**
 202    * @copydoc Dali::Toolkit::WebView::CanGoBack()
 203    */
 204   bool CanGoBack();
 205
 206   /**
 207    * @copydoc Dali::Toolkit::WebView::GoBack()
 208    */
 209   void GoBack();
 210
 211   /**
 212    * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
 213    */
 214   void EvaluateJavaScript(const std::string& script, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback resultHandler);
 215
 216   /**
 217    * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
 218    */
 219   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, Dali::WebEnginePlugin::JavaScriptMessageHandlerCallback handler);
 220
 221   /**
 222    * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptAlertCallback()
 223    */
 224   void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
 225
 226   /**
 227    * @copydoc Dali::Toolkit::WebView::JavaScriptAlertReply()
 228    */
 229   void JavaScriptAlertReply();
 230
 231   /**
 232    * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptConfirmCallback()
 233    */
 234   void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
 235
 236   /**
 237    * @copydoc Dali::Toolkit::WebView::JavaScriptConfirmReply()
 238    */
 239   void JavaScriptConfirmReply(bool confirmed);
 240
 241   /**
 242    * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptPromptCallback()
 243    */
 244   void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
 245
 246   /**
 247    * @copydoc Dali::Toolkit::WebView::JavaScriptPromptReply()
 248    */
 249   void JavaScriptPromptReply(const std::string& result);
 250
 251   /**
 252    * @copydoc Dali::Toolkit::WebView::CreateHitTest()
 253    */
 254   std::unique_ptr<Dali::WebEngineHitTest> CreateHitTest(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode);
 255
 256   /**
 257    * @copydoc Dali::Toolkit::WebView::CreateHitTestAsynchronously()
 258    */
 259   bool CreateHitTestAsynchronously(int32_t x, int32_t y, Dali::WebEngineHitTest::HitTestMode mode, Dali::WebEnginePlugin::WebEngineHitTestCreatedCallback callback);
 260
 261   /**
 262    * @copydoc Dali::Toolkit::WebView::ClearHistory()
 263    */
 264   void ClearHistory();
 265
 266   /**
 267    * @copydoc Dali::Toolkit::WebView::ClearAllTilesResources()
 268    */
 269   void ClearAllTilesResources();
 270
 271   /**
 272    * @copydoc Dali::Toolkit::WebView::SetScaleFactor()
 273    */
 274   void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
 275
 276   /**
 277    * @copydoc Dali::Toolkit::WebView::GetScaleFactor()
 278    */
 279   float GetScaleFactor() const;
 280
 281   /**
 282    * @copydoc Dali::Toolkit::WebView::ActivateAccessibility()
 283    */
 284   void ActivateAccessibility(bool activated);
 285
 286   /**
 287    * @copydoc Dali::Toolkit::WebView::HighlightText()
 288    */
 289   bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
 290
 291   /**
 292    * @copydoc Dali::Toolkit::WebView::AddDynamicCertificatePath()
 293    */
 294   void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
 295
 296   /**
 297    * @copydoc Dali::Toolkit::WebView::GetScreenshot()
 298    */
 299   Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int32_t> viewArea, float scaleFactor);
 300
 301   /**
 302    * @copydoc Dali::Toolkit::WebView::GetScreenshotAsynchronously()
 303    */
 304   bool GetScreenshotAsynchronously(Dali::Rect<int32_t> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback);
 305
 306   /**
 307    * @copydoc Dali::Toolkit::WebView::CheckVideoPlayingAsynchronously()
 308    */
 309   bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
 310
 311   /**
 312    * @copydoc Dali::Toolkit::WebView::RegisterGeolocationPermissionCallback()
 313    */
 314   void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
 315
 316   /**
 317    * @copydoc Dali::Toolkit::WebView::SetTtsFocus()
 318    */
 319   void SetTtsFocus(bool focused);
 320
 321   /**
 322    * @copydoc Dali::Toolkit::WebView::RegisterPageLoadStartedCallback()
 323    */
 324   void RegisterPageLoadStartedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 325
 326   /**
 327    * @copydoc Dali::Toolkit::WebView::RegisterPageLoadInProgressCallback()
 328    */
 329   void RegisterPageLoadInProgressCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 330
 331   /**
 332    * @copydoc Dali::Toolkit::WebView::RegisterPageLoadFinishedCallback()
 333    */
 334   void RegisterPageLoadFinishedCallback(Dali::WebEnginePlugin::WebEnginePageLoadCallback callback);
 335
 336   /**
 337    * @copydoc Dali::Toolkit::WebView::RegisterPageLoadErrorCallback()
 338    */
 339   void RegisterPageLoadErrorCallback(Dali::WebEnginePlugin::WebEnginePageLoadErrorCallback callback);
 340
 341   /**
 342    * @copydoc Dali::Toolkit::WebView::RegisterScrollEdgeReachedCallback()
 343    */
 344   void RegisterScrollEdgeReachedCallback(Dali::WebEnginePlugin::WebEngineScrollEdgeReachedCallback callback);
 345
 346   /**
 347    * @copydoc Dali::Toolkit::WebView::RegisterUrlChangedCallback()
 348    */
 349   void RegisterUrlChangedCallback(Dali::WebEnginePlugin::WebEngineUrlChangedCallback callback);
 350
 351   /**
 352    * @copydoc Dali::Toolkit::WebView::RegisterFormRepostDecidedCallback()
 353    */
 354   void RegisterFormRepostDecidedCallback(Dali::WebEnginePlugin::WebEngineFormRepostDecidedCallback callback);
 355
 356   /**
 357    * @copydoc Dali::Toolkit::WebView::RegisterFrameRenderedCallback()
 358    */
 359   void RegisterFrameRenderedCallback(Dali::WebEnginePlugin::WebEngineFrameRenderedCallback callback);
 360
 361   /**
 362    * @copydoc Dali::Toolkit::WebView::RegisterConsoleMessageReceivedCallback()
 363    */
 364   void RegisterConsoleMessageReceivedCallback(Dali::WebEnginePlugin::WebEngineConsoleMessageReceivedCallback callback);
 365
 366   /**
 367    * @copydoc Dali::Toolkit::WebView::RegisterResponsePolicyDecidedCallback()
 368    */
 369   void RegisterResponsePolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineResponsePolicyDecidedCallback callback);
 370
 371   /**
 372    * @copydoc Dali::Toolkit::WebView::RegisterNavigationPolicyDecidedCallback()
 373    */
 374   void RegisterNavigationPolicyDecidedCallback(Dali::WebEnginePlugin::WebEngineNavigationPolicyDecidedCallback callback);
 375
 376   /**
 377    * @copydoc Dali::Toolkit::WebView::RegisterCertificateConfirmedCallback()
 378    */
 379   void RegisterCertificateConfirmedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
 380
 381   /**
 382    * @copydoc Dali::Toolkit::WebView::RegisterSslCertificateChangedCallback()
 383    */
 384   void RegisterSslCertificateChangedCallback(Dali::WebEnginePlugin::WebEngineCertificateCallback callback);
 385
 386   /**
 387    * @copydoc Dali::Toolkit::WebView::RegisterHttpAuthHandlerCallback()
 388    */
 389   void RegisterHttpAuthHandlerCallback(Dali::WebEnginePlugin::WebEngineHttpAuthHandlerCallback callback);
 390
 391   /**
 392    * @copydoc Dali::Toolkit::WebView::RegisterContextMenuShownCallback()
 393    */
 394   void RegisterContextMenuShownCallback(Dali::WebEnginePlugin::WebEngineContextMenuShownCallback callback);
 395
 396   /**
 397    * @copydoc Dali::Toolkit::WebView::RegisterContextMenuHiddenCallback()
 398    */
 399   void RegisterContextMenuHiddenCallback(Dali::WebEnginePlugin::WebEngineContextMenuHiddenCallback callback);
 400
 401   /**
 402    * @copydoc Dali::Toolkit::WebView::GetPlainTextAsynchronously()
 403    */
 404   void GetPlainTextAsynchronously(Dali::WebEnginePlugin::PlainTextReceivedCallback callback);
 405
 406 public: // Properties
 407   /**
 408    * @brief Called when a property of an object of this type is set.
 409    *
 410    * @param[in] object The object whose property is set.
 411    * @param[in] index The property index.
 412    * @param[in] value The new property value.
 413    */
 414   static void SetProperty(Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value);
 415
 416   /**
 417    * @brief Called to retrieve a property of an object of this type.
 418    *
 419    * @param[in] object The object whose property is to be retrieved.
 420    * @param[in] index The property index.
 421    * @return The current value of the property.
 422    */
 423   static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
 424
 425 private: // From Control
 426   /**
 427    * @copydoc Toolkit::Control::OnInitialize()
 428    */
 429   void OnInitialize() override;
 430
 431   /**
 432    * @copydoc Toolkit::Internal::Control::CreateAccessibleObject()
 433    */
 434   DevelControl::ControlAccessible* CreateAccessibleObject() override;
 435
 436   /**
 437    * @copydoc Toolkit::Control::GetNaturalSize
 438    */
 439   Vector3 GetNaturalSize() override;
 440
 441   /**
 442    * @copydoc Toolkit::Control::OnKeyEvent()
 443    */
 444   bool OnKeyEvent(const Dali::KeyEvent& event) override;
 445
 446   /**
 447    * @copydoc Toolkit::Control::OnKeyInputFocusGained()
 448    */
 449   void OnKeyInputFocusGained() override;
 450
 451   /**
 452    * @copydoc Toolkit::Control::OnKeyInputFocusLost()
 453    */
 454   void OnKeyInputFocusLost() override;
 455
 456   /**
 457    * @copydoc Toolkit::Control::OnSceneConnection()
 458    */
 459   void OnSceneConnection(int depth) override;
 460
 461 private:
 462   // Undefined
 463   WebView(const WebView& webView);
 464
 465   WebView& operator=(const WebView& webView);
 466
 467   /**
 468    * @brief Gets web engine plugin.
 469    */
 470   Dali::WebEnginePlugin* GetPlugin() const;
 471
 472   /**
 473    * @brief Set an absolute scroll of the given view.
 474    * @param[in] x The coordinate x of scroll
 475    * @param[in] y The coordinate y of scroll
 476    */
 477   void SetScrollPosition(int32_t x, int32_t y);
 478
 479   /**
 480    * @brief Get the current scroll position of the given view.
 481    * @param[out] x The coordinate x of scroll
 482    * @param[out] y The coordinate y of scroll
 483    */
 484   Dali::Vector2 GetScrollPosition() const;
 485
 486   /**
 487    * @brief Get the possible scroll size of the given view.
 488    * @param[out] width The width of scroll size
 489    * @param[out] height The height of scroll size
 490    */
 491   Dali::Vector2 GetScrollSize() const;
 492
 493   /**
 494    * @brief Get the last known content's size.
 495    * @param[out] width The width of content's size
 496    * @param[out] height The height of content's size
 497    */
 498   Dali::Vector2 GetContentSize() const;
 499
 500   /**
 501    * @brief Return the title of the Web.
 502    *
 503    * @return The title of web page
 504    */
 505   std::string GetTitle() const;
 506
 507   /**
 508    * @brief Set the background color of web page.
 509    * @param[in] color The value of background color.
 510    */
 511   void SetDocumentBackgroundColor(Dali::Vector4 color);
 512
 513   /**
 514    * @brief Clear tiles when hidden.
 515    *
 516    * @param[in] cleared Whether tiles are cleared or not
 517    */
 518   void ClearTilesWhenHidden(bool cleared);
 519
 520   /**
 521    * @brief Set multiplier of cover area of tile.
 522    *
 523    * @param[in] multiplier The multiplier of cover area
 524    */
 525   void SetTileCoverAreaMultiplier(float multiplier);
 526
 527   /**
 528    * @brief Enable cursor by client.
 529    * @param[in] enabled Whether cursor is enabled or not.
 530    */
 531   void EnableCursorByClient(bool enabled);
 532
 533   /**
 534    * @brief Get the selected text.
 535    * @return The selected text
 536    */
 537   std::string GetSelectedText() const;
 538
 539   /**
 540    * @brief Get url of web page.
 541    * @return The string of url
 542    */
 543   std::string GetUrl() const;
 544
 545   /**
 546    * @brief Get user agent string.
 547    * @return The string value of user agent
 548    */
 549   std::string GetUserAgent() const;
 550
 551   /**
 552    * @brief Set user agent string.
 553    * @param[in] userAgent The string value of user agent
 554    */
 555   void SetUserAgent(const std::string& userAgent);
 556
 557   /**
 558    * @brief Set zoom factor of the current page.
 559    * @param[in] zoomFactor a new factor to be set.
 560    */
 561   void SetPageZoomFactor(float zoomFactor);
 562
 563   /**
 564    * @brief Query the current zoom factor of the page。
 565    * @return The current page zoom factor.
 566    */
 567   float GetPageZoomFactor() const;
 568
 569   /**
 570    * @brief Set the current text zoom level。.
 571    * @param[in] zoomFactor a new factor to be set.
 572    */
 573   void SetTextZoomFactor(float zoomFactor);
 574
 575   /**
 576    * @brief Get the current text zoom level.
 577    * @return The current text zoom factor.
 578    */
 579   float GetTextZoomFactor() const;
 580
 581   /**
 582    * @brief Get the current load progress of the page.
 583    * @return The load progress of the page.
 584    */
 585   float GetLoadProgressPercentage() const;
 586
 587   /**
 588    * @brief Request to set the current page's visibility.
 589    * @param[in] visible Visible or not.
 590    *
 591    * @return true if succeeded, false otherwise
 592    */
 593   bool SetVisibility(bool visible);
 594
 595   /**
 596    * @brief Update display area of web view.
 597    * @param[in] source The soource triggers Notification.
 598    */
 599   void UpdateDisplayArea(Dali::PropertyNotification& source);
 600
 601   /**
 602    * @brief Enable/Disable video hole for video playing.
 603    * @param[in] enabled True if video hole is enabled, false otherwise.
 604    */
 605   void EnableVideoHole(bool enabled);
 606
 607   /**
 608    * @brief Enable blend mode.
 609    * @param[in] blendEnabled True if turn on blend mode, false otherwise.
 610    */
 611   void EnableBlendMode(bool blendEnabled);
 612
 613   /**
 614    * @brief Enable/disable mouse events. The default is enabled.
 615    *
 616    * @param[in] enabled True if mouse events are enabled, false otherwise
 617    */
 618   void EnableMouseEvents(bool enabled);
 619
 620   /**
 621    * @brief Enable/disable key events. The default is enabled.
 622    *
 623    * @param[in] enabled True if key events enabled, false otherwise
 624    */
 625   void EnableKeyEvents(bool enabled);
 626
 627   /**
 628    * @brief Create image view by pixel data.
 629    * @param[in] pixel Pixel data
 630    * @return The new image view
 631    */
 632   Dali::Toolkit::ImageView CreateImageView(Dali::PixelData pixel) const;
 633
 634   /**
 635    * @brief Signal occurs when the Web View has been touched.
 636    * @param[in] actor The Actor Touched
 637    * @param[in] touch The Touch Data.
 638    * @return Whether to consume event or not.
 639    */
 640   bool OnTouchEvent(Actor actor, const Dali::TouchEvent& touch);
 641
 642   /**
 643    * @brief Signal occurs when the Web View has been hovered.
 644    * @param[in] actor The Actor Hovered
 645    * @param[in] hover The Hover Data.
 646    * @return Whether to consume event or not.
 647    */
 648   bool OnHoverEvent(Actor actor, const Dali::HoverEvent& hover);
 649
 650   /**
 651    * @brief Signal occurs when the Web View receives wheel event.
 652    * @param[in] actor The Actor that receives Wheel event.
 653    * @param[in] wheel The Wheel Data.
 654    * @return Whether to consume event or not.
 655    */
 656   bool OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel);
 657
 658   /**
 659    * @brief Callback function to be called when frame is rendered.
 660    */
 661   void OnFrameRendered();
 662
 663   /**
 664    * @brief Callback function to be called when frame is rendered. This is to check initial buffer is ready.
 665    */
 666   void OnInitialFrameRendered();
 667
 668   /**
 669    * @brief Callback function to be called when visibility is changed.
 670    * @param[in] actor The actor, or child of actor, whose visibility has changed
 671    * @param[in] isVisible Whether the actor is now visible or not
 672    * @param[in] type, Whether the actor's visible property has changed or a parent's
 673    */
 674   void OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type);
 675
 676   /**
 677    * @brief callback for screen shot captured.
 678    * @param[in] pixel Pixel data of screen shot.
 679    */
 680   void OnScreenshotCaptured(Dali::PixelData pixel);
 681
 682 protected:
 683   class WebViewAccessible : public DevelControl::ControlAccessible
 684   {
 685   public:
 686     WebViewAccessible() = delete;
 687
 688     WebViewAccessible(Dali::Actor self, Dali::WebEngine& webEngine);
 689
 690   protected:
 691     /**
 692      * @copydoc Dali::Accessibility::ActorAccessible::DoGetChildren()
 693      */
 694     void DoGetChildren(std::vector<Dali::Accessibility::Accessible*>& children) override;
 695
 696   private:
 697     void OnAccessibilityEnabled();
 698     void OnAccessibilityDisabled();
 699     void SetRemoteChildAddress(Dali::Accessibility::Address address);
 700
 701     Dali::Accessibility::ProxyAccessible mRemoteChild;
 702     Dali::WebEngine&                     mWebEngine;
 703   };
 704
 705 private:
 706   Dali::Toolkit::Visual::Base mVisual;
 707   Dali::Size                  mWebViewSize;
 708   Dali::WebEngine             mWebEngine;
 709
 710   std::unique_ptr<Dali::Toolkit::WebSettings>        mWebSettings;
 711   std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
 712
 713   Dali::PropertyNotification mPositionUpdateNotification;
 714   Dali::PropertyNotification mSizeUpdateNotification;
 715   Dali::PropertyNotification mScaleUpdateNotification;
 716   Dali::Rect<int32_t>        mWebViewArea;
 717   bool                       mVideoHoleEnabled;
 718   bool                       mMouseEventsEnabled;
 719   bool                       mKeyEventsEnabled;
 720
 721   Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback mScreenshotCapturedCallback;
 722   Dali::WebEnginePlugin::WebEngineFrameRenderedCallback     mFrameRenderedCallback;
 723
 724   static std::unordered_map<Dali::WebEnginePlugin*, Dali::WeakHandle<Toolkit::WebView>> mPluginWebViewMap;
 725 };
 726
 727 } // namespace Internal
 728
 729 inline Toolkit::Internal::WebView& GetImpl(Toolkit::WebView& handle)
 730 {
 731   DALI_ASSERT_ALWAYS(handle);
 732   Dali::RefObject& impl = handle.GetImplementation();
 733   return static_cast<Toolkit::Internal::WebView&>(impl);
 734 }
 735
 736 inline const Toolkit::Internal::WebView& GetImpl(const Toolkit::WebView& handle)
 737 {
 738   DALI_ASSERT_ALWAYS(handle);
 739   const Dali::RefObject& impl = handle.GetImplementation();
 740   return static_cast<const Toolkit::Internal::WebView&>(impl);
 741 }
 742
 743 } // namespace Toolkit
 744
 745 } // namespace Dali
 746
 747 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H