1 #ifndef DALI_WEB_ENGINE_IMPL_H
2 #define DALI_WEB_ENGINE_IMPL_H
5 * Copyright (c) 2021 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/object/base-object.h>
25 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
26 #include <dali/devel-api/adaptor-framework/web-engine.h>
30 // forward declaration
31 class WebEngineBackForwardList;
32 class WebEngineContext;
33 class WebEngineCookieManager;
34 class WebEngineSettings;
42 typedef IntrusivePtr<WebEngine> WebEnginePtr;
45 * @brief WebEngine class is used for Web.
47 class WebEngine : public Dali::BaseObject
51 * @brief Creates a new WebEngine handle
53 * @return WebEngine pointer
55 static WebEnginePtr New();
58 * @copydoc Dali::WebEngine::Create()
60 void Create(int width, int height, const std::string& locale, const std::string& timezoneId);
63 * @copydoc Dali::WebEngine::Create()
65 void Create(int width, int height, int argc, char** argv);
68 * @copydoc Dali::WebEngine::Destroy()
73 * @copydoc Dali::WebEngine::GetNativeImageSource()
75 Dali::NativeImageInterfacePtr GetNativeImageSource();
78 * @copydoc Dali::WebEngine::GetSettings()
80 Dali::WebEngineSettings& GetSettings() const;
83 * @copydoc Dali::WebEngine::GetContext()
85 Dali::WebEngineContext& GetContext() const;
88 * @copydoc Dali::WebEngine::GetCookieManager()
90 Dali::WebEngineCookieManager& GetCookieManager() const;
93 * @copydoc Dali::WebEngine::GetBackForwardList()
95 Dali::WebEngineBackForwardList& GetBackForwardList() const;
98 * @copydoc Dali::WebEngine::LoadUrl()
100 void LoadUrl(const std::string& url);
103 * @copydoc Dali::WebEngine::GetTitle()
105 std::string GetTitle() const;
108 * @copydoc Dali::WebEngine::GetFavicon()
110 Dali::PixelData GetFavicon() const;
113 * @copydoc Dali::WebEngine::GetUrl()
115 const std::string& GetUrl();
118 * @copydoc Dali::WebEngine::GetUserAgent()
120 const std::string& GetUserAgent() const;
123 * @copydoc Dali::WebEngine::SetUserAgent()
125 void SetUserAgent(const std::string& userAgent);
128 * @copydoc Dali::WebEngine::LoadHtmlString()
130 void LoadHtmlString(const std::string& htmlString);
133 * @copydoc Dali::WebEngine::Reload()
138 * @copydoc Dali::WebEngine::StopLoading()
143 * @copydoc Dali::WebEngine::Suspend()
148 * @copydoc Dali::WebEngine::Resume()
153 * @copydoc Dali::WebEngine::ScrollBy()
155 void ScrollBy(int deltaX, int deltaY);
158 * @copydoc Dali::WebEngine::SetScrollPosition()
160 void SetScrollPosition(int x, int y);
163 * @copydoc Dali::WebEngine::GetScrollPosition()
165 Dali::Vector2 GetScrollPosition() const;
168 * @copydoc Dali::WebEngine::GetScrollSize()
170 Dali::Vector2 GetScrollSize() const;
173 * @copydoc Dali::WebEngine::GetContentSize()
175 Dali::Vector2 GetContentSize() const;
178 * @copydoc Dali::WebEngine::RegisterJavaScriptAlertCallback()
180 void RegisterJavaScriptAlertCallback( Dali::WebEnginePlugin::JavaScriptAlertCallback callback );
183 * @copydoc Dali::WebEngine::JavaScriptAlertReply()
185 void JavaScriptAlertReply();
188 * @copydoc Dali::WebEngine::RegisterJavaScriptConfirmCallback()
190 void RegisterJavaScriptConfirmCallback( Dali::WebEnginePlugin::JavaScriptConfirmCallback callback );
193 * @copydoc Dali::WebEngine::JavaScriptConfirmReply()
195 void JavaScriptConfirmReply( bool confirmed );
198 * @copydoc Dali::WebEngine::RegisterJavaScriptPromptCallback()
200 void RegisterJavaScriptPromptCallback( Dali::WebEnginePlugin::JavaScriptPromptCallback callback );
203 * @copydoc Dali::WebEngine::JavaScriptPromptReply()
205 void JavaScriptPromptReply( const std::string& result );
208 * @copydoc Dali::WebEngine::CanGoForward()
213 * @copydoc Dali::WebEngine::GoForward()
218 * @copydoc Dali::WebEngine::CanGoBack()
223 * @copydoc Dali::WebEngine::GoBack()
228 * @copydoc Dali::WebEngine::EvaluateJavaScript()
230 void EvaluateJavaScript(const std::string& script, std::function<void(const std::string&)> resultHandler);
233 * @copydoc Dali::WebEngine::AddJavaScriptMessageHandler()
235 void AddJavaScriptMessageHandler(const std::string& exposedObjectName, std::function<void(const std::string&)> handler);
238 * @copydoc Dali::WebEngine::ClearAllTilesResources()
240 void ClearAllTilesResources();
243 * @copydoc Dali::WebEngine::ClearHistory()
248 * @copydoc Dali::WebEngine::SetSize()
250 void SetSize(int width, int height);
253 * @copydoc Dali::WebEngine::SendTouchEvent()
255 bool SendTouchEvent(const Dali::TouchEvent& touch);
258 * @copydoc Dali::WebEngine::SendKeyEvent()
260 bool SendKeyEvent(const Dali::KeyEvent& event);
263 * @copydoc Dali::WebEngine::SetFocus()
265 void SetFocus(bool focused);
268 * @copydoc Dali::WebEngine::UpdateDisplayArea()
270 void UpdateDisplayArea(Dali::Rect<int> displayArea);
273 * @copydoc Dali::WebEngine::EnableVideoHole()
275 void EnableVideoHole(bool enabled);
278 * @copydoc Dali::WebEngine::PageLoadStartedSignal()
280 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
283 * @copydoc Dali::WebEngine::PageLoadProgressSignal()
285 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadInProgressSignal();
288 * @copydoc Dali::WebEngine::PageLoadFinishedSignal()
290 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
293 * @copydoc Dali::WebEngine::PageLoadErrorSignal()
295 Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
298 * @copydoc Dali::WebEngine::ScrollEdgeReachedSignal()
300 Dali::WebEnginePlugin::WebEngineScrollEdgeReachedSignalType& ScrollEdgeReachedSignal();
303 * @copydoc Dali::WebEngine::UrlChangedSignal()
305 Dali::WebEnginePlugin::WebEngineUrlChangedSignalType& UrlChangedSignal();
309 * @brief Constructor.
316 virtual ~WebEngine();
318 // Undefined copy constructor
319 WebEngine(const WebEngine& WebEngine);
321 // Undefined assignment operator
322 WebEngine& operator=(const WebEngine& WebEngine);
325 * @brief Initializes member data.
327 * @return Whether the initialization succeed or not.
332 * @brief Initializes library handle by loading web engine plugin.
334 * @return Whether the initialization succeed or not.
336 bool InitializePluginHandle();
339 typedef Dali::WebEnginePlugin* (*CreateWebEngineFunction)();
340 typedef void (*DestroyWebEngineFunction)(Dali::WebEnginePlugin* plugin);
342 Dali::WebEnginePlugin* mPlugin; ///< WebEnginePlugin instance
343 void* mHandle; ///< Handle for the loaded library
344 CreateWebEngineFunction mCreateWebEnginePtr; ///< Function to create plugin instance
345 DestroyWebEngineFunction mDestroyWebEnginePtr; ///< Function to destroy plugin instance
348 } // namespace Adaptor
349 } // namespace Internal
351 inline static Internal::Adaptor::WebEngine& GetImplementation(Dali::WebEngine& webEngine)
353 DALI_ASSERT_ALWAYS(webEngine && "WebEngine handle is empty.");
355 BaseObject& handle = webEngine.GetBaseObject();
357 return static_cast<Internal::Adaptor::WebEngine&>(handle);
360 inline static const Internal::Adaptor::WebEngine& GetImplementation(const Dali::WebEngine& webEngine)
362 DALI_ASSERT_ALWAYS(webEngine && "WebEngine handle is empty.");
364 const BaseObject& handle = webEngine.GetBaseObject();
366 return static_cast<const Internal::Adaptor::WebEngine&>(handle);