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

   1 #ifndef __DALI_WEBENGINELITE_H__
   2 #define __DALI_WEBENGINELITE_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/object/base-handle.h>
  23
  24 //INTERNAL INCLUDES
  25 #include "web-engine-lite-plugin.h"
  26
  27 namespace Dali
  28 {
  29
  30 namespace Internal
  31 {
  32
  33 namespace Adaptor
  34 {
  35   class WebEngineLite;
  36 } // namespace Adaptor
  37
  38 } // namespace Internal
  39
  40 /**
  41  * @brief WebEngineLite class is used for Web.
  42  */
  43 class DALI_IMPORT_API WebEngineLite: public BaseHandle
  44 {
  45 public:
  46
  47   /**
  48    * @brief Constructor.
  49    */
  50   WebEngineLite();
  51
  52   /**
  53    * @brief Destructor.
  54    */
  55   ~WebEngineLite();
  56
  57   /**
  58    * @brief Creates a new instance of a WebEngineLite.
  59    */
  60   static WebEngineLite New();
  61
  62  /**
  63    * @brief Copy constructor.
  64    *
  65    * @param[in] webEngineLite WebEngineLite to copy. The copied webEngineLite will point at the same implementation
  66    */
  67   WebEngineLite( const WebEngineLite& webEngineLite );
  68
  69  /**
  70    * @brief Assignment operator.
  71    *
  72    * @param[in] webEngineLite The WebEngineLite to assign from.
  73    * @return The updated WebEngineLite.
  74    */
  75   WebEngineLite& operator=( const WebEngineLite& webEngineLite );
  76
  77   /**
  78    * @brief Downcast a handle to WebEngineLite handle.
  79    *
  80    * If handle points to a WebEngineLite the downcast produces valid
  81    * handle. If not the returned handle is left uninitialized.
  82    *
  83    * @param[in] handle Handle to an object
  84    * @return Handle to a WebEngineLite or an uninitialized handle
  85    */
  86   static WebEngineLite DownCast( BaseHandle handle );
  87
  88   /**
  89    * @brief Creates WebEngineLite instance.
  90    *
  91    * @param [in] width The width of Web
  92    * @param [in] height The height of Web
  93    * @param [in] windowX The x position of window
  94    * @param [in] windowY The y position of window
  95    * @param [in] locale The locale of Web
  96    * @param [in] timezoneID The timezoneID of Web
  97    */
  98   void CreateInstance(int width, int height, int windowX, int windowY, const std::string& locale, const std::string& timezoneID);
  99
 100   /**
 101    * @brief Destroys WebEngineLite instance.
 102    */
 103   void DestroyInstance();
 104
 105   /**
 106    * @brief Loads a html.
 107    *
 108    * @param [in] path The path of Web
 109    */
 110   void LoadHtml(const std::string& path);
 111
 112   /**
 113    * @brief Connect to this signal to be notified when a web view has finished.
 114    *
 115    * @return A signal object to connect with.
 116    */
 117   Dali::WebEngineLitePlugin::WebEngineLiteSignalType& FinishedSignal();
 118
 119 private: // Not intended for application developers
 120
 121   /**
 122    * @brief Internal constructor
 123    */
 124   explicit DALI_INTERNAL WebEngineLite( Internal::Adaptor::WebEngineLite* internal );
 125 };
 126
 127 } // namespace Dali;
 128
 129 #endif
 130