Add some APIs into web view.
[platform/core/uifw/dali-toolkit.git] / 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) 2021 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <dali/devel-api/actors/actor-devel.h>
23 #include <dali/devel-api/adaptor-framework/web-engine.h>
24 #include <dali/public-api/images/image-operations.h>
25 #include <dali/public-api/object/property-notification.h>
26 #include <memory>
27
28 // INTERNAL INCLUDES
29 #include <dali-toolkit/devel-api/controls/web-view/web-view.h>
30 #include <dali-toolkit/devel-api/visual-factory/visual-base.h>
31 #include <dali-toolkit/public-api/controls/control-impl.h>
32 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
33
34 namespace Dali
35 {
36 namespace Toolkit
37 {
38 class KeyEvent;
39 class TouchEvent;
40 class WebBackForwardList;
41 class WebContext;
42 class WebCookieManager;
43 class WebSettings;
44 class WebView;
45
46 namespace Internal
47 {
48 class WebView : public Control
49 {
50 protected:
51   WebView();
52
53   WebView(const std::string& locale, const std::string& timezoneId);
54
55   WebView(int argc, char** argv);
56
57   virtual ~WebView();
58
59 public:
60   /**
61    * @copydoc Dali::Toolkit::WebView::New()
62    */
63   static Toolkit::WebView New();
64
65   /**
66    * @copydoc Dali::Toolkit::WebView::New( const std::string&, const std::string& )
67    */
68   static Toolkit::WebView New(const std::string& locale, const std::string& timezoneId);
69
70   /**
71    * @copydoc Dali::Toolkit::WebView::New( int, char** )
72    */
73   static Toolkit::WebView New(int argc, char** argv);
74
75   /**
76    * @brief Get settings of WebEngine.
77    */
78   Dali::Toolkit::WebSettings* GetSettings() const;
79
80   /**
81    * @brief Get context of WebEngine.
82    */
83   Dali::Toolkit::WebContext* GetContext() const;
84
85   /**
86    * @brief Get cookie manager of WebEngine.
87    */
88   Dali::Toolkit::WebCookieManager* GetCookieManager() const;
89
90   /**
91    * @brief Get WebBackForwardList of WebEngine.
92    */
93   Dali::Toolkit::WebBackForwardList* GetBackForwardList() const;
94
95   /**
96    * @brief Get Favicon of web page.
97    *
98    * @return Handle to a fav icon
99    */
100   Dali::Toolkit::ImageView& GetFavicon();
101
102   /**
103    * @copydoc Dali::Toolkit::WebView::LoadUrl()
104    */
105   void LoadUrl(const std::string& url);
106
107   /**
108    * @copydoc Dali::WebEngine::LoadHTMLString()
109    */
110   void LoadHtmlString(const std::string& htmlString);
111
112   /**
113    * @copydoc Dali::WebEngine::LoadHtmlStringOverrideCurrentEntry()
114    */
115   bool LoadHtmlStringOverrideCurrentEntry(const std::string& html, const std::string& basicUri, const std::string& unreachableUrl);
116
117   /**
118    * @copydoc Dali::WebEngine::LoadContents()
119    */
120   bool LoadContents(const std::string& contents, uint32_t contentSize, const std::string& mimeType, const std::string& encoding, const std::string& baseUri);
121
122   /**
123    * @copydoc Dali::Toolkit::WebView::Reload()
124    */
125   void Reload();
126
127   /**
128    * @copydoc Dali::WebEngine::ReloadWithoutCache()
129    */
130   bool ReloadWithoutCache();
131
132   /**
133    * @copydoc Dali::Toolkit::WebView::StopLoading()
134    */
135   void StopLoading();
136
137   /**
138    * @copydoc Dali::Toolkit::WebView::StopLoading()
139    */
140   void Suspend();
141
142   /**
143    * @copydoc Dali::Toolkit::WebView::Resume()
144    */
145   void Resume();
146
147   /**
148    * @copydoc Dali::WebEngine::SuspendNetworkLoading()
149    */
150   void SuspendNetworkLoading();
151
152   /**
153    * @copydoc Dali::WebEngine::ResumeNetworkLoading()
154    */
155   void ResumeNetworkLoading();
156
157   /**
158    * @copydoc Dali::WebEngine::AddCustomHeader()
159    */
160   bool AddCustomHeader(const std::string& name, const std::string& value);
161
162   /**
163    * @copydoc Dali::WebEngine::RemoveCustomHeader()
164    */
165   bool RemoveCustomHeader(const std::string& name);
166
167   /**
168    * @copydoc Dali::WebEngine::StartInspectorServer()
169    */
170   uint32_t StartInspectorServer(uint32_t port);
171
172   /**
173    * @copydoc Dali::WebEngine::StopInspectorServer()
174    */
175   bool StopInspectorServer();
176
177   /**
178    * @copydoc Dali::Toolkit::WebView::ScrollBy()
179    */
180   void ScrollBy(int deltaX, int deltaY);
181
182   /**
183    * @copydoc Dali::WebEngine::ScrollEdgeBy()
184    */
185   bool ScrollEdgeBy(int deltaX, int deltaY);
186
187   /**
188    * @copydoc Dali::Toolkit::WebView::CanGoForward()
189    */
190   bool CanGoForward();
191
192   /**
193    * @copydoc Dali::Toolkit::WebView::GoForward()
194    */
195   void GoForward();
196
197   /**
198    * @copydoc Dali::Toolkit::WebView::CanGoBack()
199    */
200   bool CanGoBack();
201
202   /**
203    * @copydoc Dali::Toolkit::WebView::GoBack()
204    */
205   void GoBack();
206
207   /**
208    * @copydoc Dali::Toolkit::WebView::EvaluateJavaScript()
209    */
210   void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
211
212   /**
213    * @copydoc Dali::Toolkit::WebView::AddJavaScriptMessageHandler()
214    */
215   void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
216
217   /**
218    * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptAlertCallback()
219    */
220   void RegisterJavaScriptAlertCallback(Dali::WebEnginePlugin::JavaScriptAlertCallback callback);
221
222   /**
223    * @copydoc Dali::Toolkit::WebView::JavaScriptAlertReply()
224    */
225   void JavaScriptAlertReply();
226
227   /**
228    * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptConfirmCallback()
229    */
230   void RegisterJavaScriptConfirmCallback(Dali::WebEnginePlugin::JavaScriptConfirmCallback callback);
231
232   /**
233    * @copydoc Dali::Toolkit::WebView::JavaScriptConfirmReply()
234    */
235   void JavaScriptConfirmReply(bool confirmed);
236
237   /**
238    * @copydoc Dali::Toolkit::WebView::RegisterJavaScriptPromptCallback()
239    */
240   void RegisterJavaScriptPromptCallback(Dali::WebEnginePlugin::JavaScriptPromptCallback callback);
241
242   /**
243    * @copydoc Dali::Toolkit::WebView::JavaScriptPromptReply()
244    */
245   void JavaScriptPromptReply(const std::string& result);
246
247   /**
248    * @copydoc Dali::Toolkit::WebView::ClearHistory()
249    */
250   void ClearHistory();
251
252   /**
253    * @copydoc Dali::Toolkit::WebView::ClearAllTilesResources()
254    */
255   void ClearAllTilesResources();
256
257   /**
258    * @copydoc Dali::Toolkit::WebView::SetScaleFactor()
259    */
260   void SetScaleFactor(float scaleFactor, Dali::Vector2 point);
261
262   /**
263    * @copydoc Dali::Toolkit::WebView::GetScaleFactor()
264    */
265   float GetScaleFactor() const;
266
267   /**
268    * @copydoc Dali::Toolkit::WebView::ActivateAccessibility()
269    */
270   void ActivateAccessibility(bool activated);
271
272   /**
273    * @copydoc Dali::Toolkit::WebView::HighlightText()
274    */
275   bool HighlightText(const std::string& text, Dali::WebEnginePlugin::FindOption options, uint32_t maxMatchCount);
276
277   /**
278    * @copydoc Dali::Toolkit::WebView::AddDynamicCertificatePath()
279    */
280   void AddDynamicCertificatePath(const std::string& host, const std::string& certPath);
281
282   /**
283    * @copydoc Dali::Toolkit::WebView::GetScreenshot()
284    */
285   Dali::Toolkit::ImageView GetScreenshot(Dali::Rect<int> viewArea, float scaleFactor);
286
287   /**
288    * @copydoc Dali::Toolkit::WebView::GetScreenshotAsynchronously()
289    */
290   bool GetScreenshotAsynchronously(Dali::Rect<int> viewArea, float scaleFactor, Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback callback);
291
292   /**
293    * @copydoc Dali::Toolkit::WebView::CheckVideoPlayingAsynchronously()
294    */
295   bool CheckVideoPlayingAsynchronously(Dali::WebEnginePlugin::VideoPlayingCallback callback);
296
297   /**
298    * @copydoc Dali::Toolkit::WebView::RegisterGeolocationPermissionCallback()
299    */
300   void RegisterGeolocationPermissionCallback(Dali::WebEnginePlugin::GeolocationPermissionCallback callback);
301
302   /**
303    * @copydoc Dali::Toolkit::WebView::PageLoadStartedSignal()
304    */
305   Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadStartedSignal();
306
307   /**
308    * @copydoc Dali::Toolkit::WebView::PageLoadInProgressSignal()
309    */
310   Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadInProgressSignal();
311
312   /**
313    * @copydoc Dali::Toolkit::WebView::PageLoadFinishedSignal()
314    */
315   Dali::Toolkit::WebView::WebViewPageLoadSignalType& PageLoadFinishedSignal();
316
317   /**
318    * @copydoc Dali::Toolkit::WebView::PageLoadErrorSignal()
319    */
320   Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType& PageLoadErrorSignal();
321
322   /**
323    * @copydoc Dali::Toolkit::WebView::ScrollEdgeReachedSignal()
324    */
325   Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
326
327   /**
328    * @copydoc Dali::Toolkit::WebView::UrlChangedSignal()
329    */
330   Dali::Toolkit::WebView::WebViewUrlChangedSignalType& UrlChangedSignal();
331
332   /**
333    * @copydoc Dali::Toolkit::WebView::FormRepostDecisionSignal()
334    */
335   Dali::Toolkit::WebView::WebViewFormRepostDecisionSignalType& FormRepostDecisionSignal();
336
337   /**
338    * @copydoc Dali::Toolkit::WebView::FrameRenderedSignal()
339    */
340   Dali::Toolkit::WebView::WebViewFrameRenderedSignalType& FrameRenderedSignal();
341
342 public: // Properties
343   /**
344    * @brief Called when a property of an object of this type is set.
345    *
346    * @param[in] object The object whose property is set.
347    * @param[in] index The property index.
348    * @param[in] value The new property value.
349    */
350   static void SetProperty(Dali::BaseObject* object, Dali::Property::Index index, const Dali::Property::Value& value);
351
352   /**
353    * @brief Called to retrieve a property of an object of this type.
354    *
355    * @param[in] object The object whose property is to be retrieved.
356    * @param[in] index The property index.
357    * @return The current value of the property.
358    */
359   static Dali::Property::Value GetProperty(Dali::BaseObject* object, Dali::Property::Index propertyIndex);
360
361   /**
362    * Connects a callback function with the object's signals.
363    * @param[in] object The object providing the signal.
364    * @param[in] tracker Used to disconnect the signal.
365    * @param[in] signalName The signal to connect to.
366    * @param[in] functor A newly allocated FunctorDelegate.
367    * @return True if the signal was connected.
368    * @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the c
369    */
370   static bool DoConnectSignal(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
371
372 private: // From Control
373   /**
374    * @copydoc Toolkit::Control::OnInitialize()
375    */
376   void OnInitialize() override;
377
378   /**
379    * @copydoc Toolkit::Control::GetNaturalSize
380    */
381   Vector3 GetNaturalSize() override;
382
383   /**
384    * @copydoc Toolkit::Control::OnKeyEvent()
385    */
386   bool OnKeyEvent(const Dali::KeyEvent& event) override;
387
388   /**
389    * @copydoc Toolkit::Control::OnKeyInputFocusGained()
390    */
391   void OnKeyInputFocusGained() override;
392
393   /**
394    * @copydoc Toolkit::Control::OnKeyInputFocusLost()
395    */
396   void OnKeyInputFocusLost() override;
397
398   /**
399    * @copydoc Toolkit::Control::OnSceneConnection()
400    */
401   void OnSceneConnection(int depth) override;
402
403 private:
404   // Undefined
405   WebView(const WebView& webView);
406
407   WebView& operator=(const WebView& webView);
408
409   /**
410    * @brief Sets an absolute scroll of the given view.
411    * @param[in] x The coordinate x of scroll
412    * @param[in] y The coordinate y of scroll
413    */
414   void SetScrollPosition(int x, int y);
415
416   /**
417    * @brief Gets the current scroll position of the given view.
418    * @param[out] x The coordinate x of scroll
419    * @param[out] y The coordinate y of scroll
420    */
421   Dali::Vector2 GetScrollPosition() const;
422
423   /**
424    * @brief Gets the possible scroll size of the given view.
425    * @param[out] width The width of scroll size
426    * @param[out] height The height of scroll size
427    */
428   Dali::Vector2 GetScrollSize() const;
429
430   /**
431    * @brief Gets the last known content's size.
432    * @param[out] width The width of content's size
433    * @param[out] height The height of content's size
434    */
435   Dali::Vector2 GetContentSize() const;
436
437   /**
438    * @brief Returns the title of the Web.
439    *
440    * @return The title of web page
441    */
442   std::string GetTitle() const;
443
444   /**
445    * @brief Sets the background color of web page.
446    * @param[in] color The value of background color.
447    */
448   void SetDocumentBackgroundColor(Dali::Vector4 color);
449
450   /**
451    * @brief Clears tiles when hidden.
452    *
453    * @param[in] cleared Whether tiles are cleared or not
454    */
455   void ClearTilesWhenHidden(bool cleared);
456
457   /**
458    * @brief Sets multiplier of cover area of tile.
459    *
460    * @param[in] multiplier The multiplier of cover area
461    */
462   void SetTileCoverAreaMultiplier(float multiplier);
463
464   /**
465    * @brief Enables cursor by client.
466    * @param[in] enabled Whether cursor is enabled or not.
467    */
468   void EnableCursorByClient(bool enabled);
469
470   /**
471    * @brief Gets the selected text.
472    * @return The selected text
473    */
474   std::string GetSelectedText() const;
475
476   /**
477    * @brief Get user agent string.
478    * @return The string value of user agent
479    */
480   const std::string& GetUserAgent() const;
481
482   /**
483    * @brief Set user agent string.
484    * @param[in] userAgent The string value of user agent
485    */
486   void SetUserAgent(const std::string& userAgent);
487
488   /**
489    * @brief Sets zoom factor of the current page.
490    * @param[in] zoomFactor a new factor to be set.
491    */
492   void SetPageZoomFactor(float zoomFactor);
493
494   /**
495    * @brief Queries the current zoom factor of the page。
496    * @return The current page zoom factor.
497    */
498   float GetPageZoomFactor() const;
499
500   /**
501    * @brief Sets the current text zoom level。.
502    * @param[in] zoomFactor a new factor to be set.
503    */
504   void SetTextZoomFactor(float zoomFactor);
505
506   /**
507    * @brief Gets the current text zoom level.
508    * @return The current text zoom factor.
509    */
510   float GetTextZoomFactor() const;
511
512   /**
513    * @brief Gets the current load progress of the page.
514    * @return The load progress of the page.
515    */
516   float GetLoadProgressPercentage() const;
517
518   /**
519    * @brief Request to set the current page's visibility.
520    * @param[in] visible Visible or not.
521    *
522    * @return true if succeeded, false otherwise
523    */
524   bool SetVisibility(bool visible);
525
526   /**
527    * @brief Updates display area of web view.
528    * @param[in] source The soource triggers Notification.
529    */
530   void UpdateDisplayArea(Dali::PropertyNotification& source);
531
532   /**
533    * @brief Enable/Disable video hole for video playing.
534    * @param[in] enabled True if video hole is enabled, false otherwise.
535    */
536   void EnableVideoHole(bool enabled);
537
538   /**
539    * @brief Enable blend mode.
540    * @param[in] blendEnabled True if turn on blend mode, false otherwise.
541    */
542   void EnableBlendMode(bool blendEnabled);
543
544   /**
545    * @brief Enables/disables mouse events. The default is enabled.
546    *
547    * @param[in] enabled True if mouse events are enabled, false otherwise
548    */
549   void EnableMouseEvents(bool enabled);
550
551   /**
552    * @brief Enables/disables key events. The default is enabled.
553    *
554    * @param[in] enabled True if key events enabled, false otherwise
555    */
556   void EnableKeyEvents(bool enabled);
557
558   /**
559    * @brief Create image view by pixel data.
560    * @param[in] pixel Pixel data
561    * @return The new image view
562    */
563   Dali::Toolkit::ImageView CreateImageView(Dali::PixelData pixel);
564
565   /**
566    * @brief Callback function to be called when page load started.
567    * @param[in] url The url currently being loaded
568    */
569   void OnPageLoadStarted(const std::string& url);
570
571   /**
572    * @brief Callback function to be called when page is loading in progress.
573    * @param[in] url The url currently being loaded
574    */
575   void OnPageLoadInProgress(const std::string& url);
576
577   /**
578    * @brief Callback function to be called when page load finished.
579    * @param[in] url The url currently being loaded
580    */
581   void OnPageLoadFinished(const std::string& url);
582
583   /**
584    * @brief Callback function to be called when there is an error in page loading.
585    * @param[in] url The url currently being loaded
586    * @param[in] errorCode The error code
587    */
588   void OnPageLoadError(const std::string& url, int errorCode);
589
590   /**
591    * @brief Callback function to be called when scroll edge is reached.
592    * @param[in] e The scroll edge reached.
593    */
594   void OnScrollEdgeReached(Dali::WebEnginePlugin::ScrollEdge edge);
595
596   /**
597    * @brief Callback function to be called when url is changed.
598    * @param[in] url The url currently being loaded
599    */
600   void OnUrlChanged(const std::string& url);
601
602   /**
603    * Signal occurs when the Web View has been touched.
604    * @param[in] actor The Actor Touched
605    * @param[in] touch The Touch Data.
606    * @return Whether to consume event or not.
607    */
608   bool OnTouchEvent(Actor actor, const Dali::TouchEvent& touch);
609
610   /**
611    * Signal occurs when the Web View has been hovered.
612    * @param[in] actor The Actor Hovered
613    * @param[in] hover The Hover Data.
614    * @return Whether to consume event or not.
615    */
616   bool OnHoverEvent(Actor actor, const Dali::HoverEvent& hover);
617
618   /**
619    * Signal occurs when the Web View receives wheel event.
620    * @param[in] actor The Actor that receives Wheel event.
621    * @param[in] wheel The Wheel Data.
622    * @return Whether to consume event or not.
623    */
624   bool OnWheelEvent(Actor actor, const Dali::WheelEvent& wheel);
625
626   /**
627    * @brief Callback function to be called when form repost decision need be checked.
628    * @param[in] decision The new decision for form repost
629    */
630   void OnFormRepostDecision(std::shared_ptr<Dali::WebEngineFormRepostDecision> decision);
631
632   /**
633    * @brief Callback function to be called when frame is rendered.
634    */
635   void OnFrameRendered();
636
637   /**
638    * @brief Callback function to be called when visibility is changed.
639    * @param[in] actor The actor, or child of actor, whose visibility has changed
640    * @param[in] isVisible Whether the actor is now visible or not
641    * @param[in] type, Whether the actor's visible property has changed or a parent's
642    */
643   void OnVisibilityChanged(Actor actor, bool isVisible, Dali::DevelActor::VisibilityChange::Type type);
644
645   /**
646    * @brief callback for screen shot captured.
647    * @param[in] pixel Pixel data of screen shot.
648    */
649   void OnScreenshotCaptured(Dali::PixelData pixel);
650
651 private:
652   std::string                 mUrl;
653   Dali::Toolkit::Visual::Base mVisual;
654   Dali::Size                  mWebViewSize;
655   Dali::WebEngine             mWebEngine;
656
657   Dali::Toolkit::WebView::WebViewPageLoadSignalType           mPageLoadStartedSignal;
658   Dali::Toolkit::WebView::WebViewPageLoadSignalType           mPageLoadInProgressSignal;
659   Dali::Toolkit::WebView::WebViewPageLoadSignalType           mPageLoadFinishedSignal;
660   Dali::Toolkit::WebView::WebViewPageLoadErrorSignalType      mPageLoadErrorSignal;
661   Dali::Toolkit::WebView::WebViewUrlChangedSignalType         mUrlChangedSignal;
662   Dali::Toolkit::WebView::WebViewScrollEdgeReachedSignalType  mScrollEdgeReachedSignal;
663   Dali::Toolkit::WebView::WebViewFormRepostDecisionSignalType mFormRepostDecisionSignal;
664   Dali::Toolkit::WebView::WebViewFrameRenderedSignalType      mFrameRenderedSignal;
665
666   std::unique_ptr<Dali::Toolkit::WebContext>         mWebContext;
667   std::unique_ptr<Dali::Toolkit::WebCookieManager>   mWebCookieManager;
668   std::unique_ptr<Dali::Toolkit::WebSettings>        mWebSettings;
669   std::unique_ptr<Dali::Toolkit::WebBackForwardList> mWebBackForwardList;
670   Dali::Toolkit::ImageView                           mFaviconView;
671
672   Dali::PropertyNotification mPositionUpdateNotification;
673   Dali::PropertyNotification mSizeUpdateNotification;
674   Dali::PropertyNotification mScaleUpdateNotification;
675   bool                       mVideoHoleEnabled;
676   Dali::Rect<int>            mWebViewArea;
677   bool                       mMouseEventsEnabled;
678   bool                       mKeyEventsEnabled;
679
680   Dali::Toolkit::WebView::WebViewScreenshotCapturedCallback mScreenshotCapturedCallback;
681 };
682
683 } // namespace Internal
684
685 inline Toolkit::Internal::WebView& GetImpl(Toolkit::WebView& handle)
686 {
687   DALI_ASSERT_ALWAYS(handle);
688   Dali::RefObject& impl = handle.GetImplementation();
689   return static_cast<Toolkit::Internal::WebView&>(impl);
690 }
691
692 inline const Toolkit::Internal::WebView& GetImpl(const Toolkit::WebView& handle)
693 {
694   DALI_ASSERT_ALWAYS(handle);
695   const Dali::RefObject& impl = handle.GetImplementation();
696   return static_cast<const Toolkit::Internal::WebView&>(impl);
697 }
698
699 } // namespace Toolkit
700
701 } // namespace Dali
702
703 #endif // DALI_TOOLKIT_INTERNAL_WEB_VIEW_H