adaptors/devel-api/adaptor-framework/widget.h

   1 #ifndef DALI_WIDGET_H
   2 #define DALI_WIDGET_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 namespace Dali
  25 {
  26
  27   /**
  28  * @addtogroup dali_adaptor_framework
  29  * @{
  30  */
  31
  32 namespace Internal
  33 {
  34
  35 namespace Adaptor
  36 {
  37 class Widget;
  38 }
  39
  40 }
  41
  42 class Window;
  43
  44 /**
  45  * @brief Widget class is the base class for custom widget.
  46  *
  47  * To make own Widget, user should inherit this class and its impl class.
  48  *
  49  */
  50 class DALI_IMPORT_API Widget : public BaseHandle
  51 {
  52 public:
  53
  54   /**
  55    * @brief Struct for termination type of widget instance.
  56    */
  57   struct Termination
  58   {
  59     /**
  60      * @brief Enumeration for termination type of widget instance.
  61      */
  62     enum Type
  63     {
  64       PERMANENT, //< User deleted this widget from the viewer
  65       TEMPORARY, //< Widget is deleted because of other reasons (e.g. widget process is terminated temporarily by the system)
  66     };
  67   };
  68
  69 public:
  70
  71   /**
  72    * @brief This is the constructor for Widget.
  73    * @return A handle to the Widget
  74    */
  75   static Widget New();
  76
  77   /**
  78    * @brief The default constructor.
  79    *
  80    */
  81   Widget();
  82
  83   /**
  84    * @brief Copy Constructor.
  85    * @param[in] Widget Handle to an object
  86    */
  87   Widget( const Widget& widget );
  88
  89   /**
  90    * @brief Assignment operator.
  91    * @param[in] Widget Handle to an object
  92    * @return A reference to this
  93    */
  94   Widget& operator=( const Widget& widget );
  95
  96   /**
  97    * @brief Destructor
  98    */
  99   ~Widget();
 100
 101 public: // Not intended for application developers
 102   explicit Widget(Internal::Adaptor::Widget* widget);
 103 };
 104
 105 /**
 106  * @}
 107  */
 108 } // namespace Dali
 109
 110 #endif // DALI_WIDGET_H