1 #ifndef DALI_WEB_ENGINE_IMPL_H
2 #define DALI_WEB_ENGINE_IMPL_H
5 * Copyright (c) 2020 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.h>
26 #include <dali/devel-api/adaptor-framework/web-engine-plugin.h>
39 typedef IntrusivePtr< WebEngine > WebEnginePtr;
42 * @brief WebEngine class is used for Web.
44 class WebEngine : public Dali::BaseObject
49 * @brief Creates a new WebEngine handle
51 * @return WebEngine pointer
53 static WebEnginePtr New();
56 * @copydoc Dali::WebEngine::Create()
58 void Create( int width, int height, const std::string& locale, const std::string& timezoneId );
61 * @copydoc Dali::WebEngine::Destroy()
66 * @copydoc Dali::WebEngine::GetNativeImageSource()
68 Dali::NativeImageInterfacePtr GetNativeImageSource();
71 * @copydoc Dali::WebEngine::LoadUrl()
73 void LoadUrl( const std::string& url );
76 * @copydoc Dali::WebEngine::GetUrl()
78 const std::string& GetUrl();
81 * @copydoc Dali::WebEngine::LoadHTMLString()
83 void LoadHTMLString( const std::string& htmlString );
86 * @copydoc Dali::WebEngine::Reload()
91 * @copydoc Dali::WebEngine::StopLoading()
96 * @copydoc Dali::WebEngine::Suspend()
101 * @copydoc Dali::WebEngine::Resume()
106 * @copydoc Dali::WebEngine::CanGoForward()
111 * @copydoc Dali::WebEngine::GoForward()
116 * @copydoc Dali::WebEngine::CanGoBack()
121 * @copydoc Dali::WebEngine::GoBack()
126 * @copydoc Dali::WebEngine::EvaluateJavaScript()
128 void EvaluateJavaScript( const std::string& script, std::function< void(const std::string&) > resultHandler );
131 * @copydoc Dali::WebEngine::AddJavaScriptMessageHandler()
133 void AddJavaScriptMessageHandler( const std::string& exposedObjectName, std::function< void(const std::string&) > handler );
136 * @copydoc Dali::WebEngine::ClearHistory()
141 * @copydoc Dali::WebEngine::ClearCache()
146 * @copydoc Dali::WebEngine::ClearCookies()
151 * @copydoc Dali::WebEngine::GetCacheModel()
153 Dali::WebEnginePlugin::CacheModel GetCacheModel() const;
156 * @copydoc Dali::WebEngine::SetCacheModel()
158 void SetCacheModel( Dali::WebEnginePlugin::CacheModel cacheModel );
161 * @copydoc Dali::WebEngine::GetCookieAcceptPolicy()
163 Dali::WebEnginePlugin::CookieAcceptPolicy GetCookieAcceptPolicy() const;
166 * @copydoc Dali::WebEngine::SetCookieAcceptPolicy()
168 void SetCookieAcceptPolicy( Dali::WebEnginePlugin::CookieAcceptPolicy policy );
171 * @copydoc Dali::WebEngine::GetUserAgent()
173 const std::string& GetUserAgent() const;
176 * @copydoc Dali::WebEngine::SetUserAgent()
178 void SetUserAgent( const std::string& userAgent );
181 * @copydoc Dali::WebEngine::IsJavaScriptEnabled()
183 bool IsJavaScriptEnabled() const;
186 * @copydoc Dali::WebEngine::EnableJavaScript()
188 void EnableJavaScript( bool enabled );
191 * @copydoc Dali::WebEngine::AreImagesAutomaticallyLoaded()
193 bool AreImagesAutomaticallyLoaded() const;
196 * @copydoc Dali::WebEngine::LoadImagesAutomatically()
198 void LoadImagesAutomatically( bool automatic );
201 * @copydoc Dali::WebEngine::GetDefaultTextEncodingName()
203 const std::string& GetDefaultTextEncodingName() const;
206 * @copydoc Dali::WebEngine::SetDefaultTextEncodingName()
208 void SetDefaultTextEncodingName( const std::string& defaultTextEncodingName );
211 * @copydoc Dali::WebEngine::GetDefaultFontSize()
213 int GetDefaultFontSize() const;
216 * @copydoc Dali::WebEngine::SetDefaultFontSize()
218 void SetDefaultFontSize( int defaultFontSize );
221 * @copydoc Dali::WebEngine::SetSize()
223 void SetSize( int width, int height );
226 * @copydoc Dali::WebEngine::SendTouchEvent()
228 bool SendTouchEvent( const Dali::TouchEvent& touch );
231 * @copydoc Dali::WebEngine::SendKeyEvent()
233 bool SendKeyEvent( const Dali::KeyEvent& event );
236 * @copydoc Dali::WebEngine::PageLoadStartedSignal()
238 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadStartedSignal();
241 * @copydoc Dali::WebEngine::PageLoadFinishedSignal()
243 Dali::WebEnginePlugin::WebEnginePageLoadSignalType& PageLoadFinishedSignal();
246 * @copydoc Dali::WebEngine::PageLoadErrorSignal()
248 Dali::WebEnginePlugin::WebEnginePageLoadErrorSignalType& PageLoadErrorSignal();
253 * @brief Constructor.
260 virtual ~WebEngine();
262 // Undefined copy constructor
263 WebEngine( const WebEngine& WebEngine );
265 // Undefined assignment operator
266 WebEngine& operator=( const WebEngine& WebEngine );
269 * @brief Initializes member data.
271 * @return Whether the initialization succeed or not.
276 * @brief Initializes library handle by loading web engine plugin.
278 * @return Whether the initialization succeed or not.
280 bool InitializePluginHandle();
284 typedef Dali::WebEnginePlugin* (*CreateWebEngineFunction)();
285 typedef void (*DestroyWebEngineFunction)( Dali::WebEnginePlugin* plugin );
287 Dali::WebEnginePlugin* mPlugin; ///< WebEnginePlugin instance
288 void* mHandle; ///< Handle for the loaded library
289 CreateWebEngineFunction mCreateWebEnginePtr; ///< Function to create plugin instance
290 DestroyWebEngineFunction mDestroyWebEnginePtr; ///< Function to destroy plugin instance
293 } // namespace Adaptor
294 } // namespace Internal
296 inline static Internal::Adaptor::WebEngine& GetImplementation( Dali::WebEngine& webEngine )
298 DALI_ASSERT_ALWAYS( webEngine && "WebEngine handle is empty." );
300 BaseObject& handle = webEngine.GetBaseObject();
302 return static_cast< Internal::Adaptor::WebEngine& >( handle );
305 inline static const Internal::Adaptor::WebEngine& GetImplementation( const Dali::WebEngine& webEngine )
307 DALI_ASSERT_ALWAYS( webEngine && "WebEngine handle is empty." );
309 const BaseObject& handle = webEngine.GetBaseObject();
311 return static_cast< const Internal::Adaptor::WebEngine& >( handle );