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

   1 #ifndef __DALI_WEBENGINELITE_PLUGIN_H__
   2 #define __DALI_WEBENGINELITE_PLUGIN_H__
   3
   4 /*
   5  * Copyright (c) 2017 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/signals/dali-signal.h>
  23
  24 namespace Dali
  25 {
  26
  27 /**
  28  * @brief WebEngineLitePlugin is an abstract interface, used by dali-adaptor to access WebEngineLite plugin.
  29  * A concrete implementation must be created for each platform and provided as dynamic library.
  30  */
  31 class WebEngineLitePlugin
  32 {
  33 public:
  34
  35   typedef Signal< void () > WebEngineLiteSignalType;
  36
  37   /**
  38    * @brief Constructor.
  39    */
  40   WebEngineLitePlugin(){}
  41
  42   /**
  43    * @brief Destructor.
  44    */
  45   virtual ~WebEngineLitePlugin(){}
  46
  47   /**
  48    * @brief Creates WebEngineLite instance.
  49    *
  50    * @param [in] width The width of Web
  51    * @param [in] height The height of Web
  52    * @param [in] windowX The x position of window
  53    * @param [in] windowY The y position of window
  54    * @param [in] locale The locale of Web
  55    * @param [in] timezoneID The timezoneID of Web
  56    */
  57   virtual void CreateInstance(int width, int height, int windowX, int windowY, const std::string& locale, const std::string& timezoneID) = 0;
  58
  59   /**
  60    * @brief Destroys WebEngineLite instance.
  61    */
  62   virtual void DestroyInstance() = 0;
  63
  64   /**
  65    * @brief Loads a html.
  66    *
  67    * @param [in] path The path of Web
  68    */
  69   virtual void LoadHtml(const std::string& path) = 0;
  70
  71   /**
  72    * @brief Connect to this signal to be notified when a web view has finished.
  73    *
  74    * @return A signal object to connect with.
  75    */
  76   virtual WebEngineLiteSignalType& FinishedSignal() = 0;
  77
  78 };
  79
  80 } // namespace Dali;
  81
  82 #endif