dali-toolkit/public-api/controls/text-controls/text-field.h

   1 #ifndef __DALI_TOOLKIT_TEXT_FIELD_H__
   2 #define __DALI_TOOLKIT_TEXT_FIELD_H__
   3
   4 /*
   5  * Copyright (c) 2015 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 // INTERNAL INCLUDES
  22 #include <dali-toolkit/public-api/controls/control.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace Internal DALI_INTERNAL
  31 {
  32 class TextField;
  33 }
  34
  35 /**
  36  * @brief A control which provides a single-line editable text field.
  37  */
  38 class DALI_IMPORT_API TextField : public Control
  39 {
  40 public:
  41
  42   // Property indices
  43   static const Dali::Property::Index PROPERTY_RENDERING_BACKEND;       ///< name "rendering-backend",       type INT
  44   static const Dali::Property::Index PROPERTY_PLACEHOLDER_TEXT;        ///< name "placeholder-text",        type STRING
  45   static const Dali::Property::Index PROPERTY_TEXT;                    ///< name "text",                    type STRING
  46   static const Dali::Property::Index PROPERTY_CURSOR_IMAGE;            ///< name "cursor-image",            type STRING
  47   static const Dali::Property::Index PROPERTY_PRIMARY_CURSOR_COLOR;    ///< name "primary-cursor-color",    type VECTOR4
  48   static const Dali::Property::Index PROPERTY_SECONDARY_CURSOR_COLOR;  ///< name "secondary-cursor-color",  type VECTOR4
  49   static const Dali::Property::Index PROPERTY_ENABLE_CURSOR_BLINK;     ///< name "enable-cursor-blink",     type BOOLEAN
  50   static const Dali::Property::Index PROPERTY_CURSOR_BLINK_INTERVAL;   ///< name "cursor-blink-interval",   type FLOAT
  51   static const Dali::Property::Index PROPERTY_CURSOR_BLINK_DURATION;   ///< name "cursor-blink-duration",   type FLOAT
  52   static const Dali::Property::Index PROPERTY_GRAB_HANDLE_IMAGE;       ///< name "grab-handle-image",       type STRING
  53   static const Dali::Property::Index PROPERTY_DECORATION_BOUNDING_BOX; ///< name "decoration-bounding-box", type RECTANGLE
  54
  55   // Property names
  56   static const std::string RENDERING_BACKEND_PROPERTY_NAME;      ///< Property, name "rendering-backend",       type INT
  57   static const std::string PLACEHOLDER_TEXT_PROPERTY_NAME;       ///< Property, name "placeholder-text",        type STRING
  58   static const std::string TEXT_PROPERTY_NAME;                   ///< Property, name "text",                    type STRING
  59   static const std::string CURSOR_IMAGE_PROPERTY_NAME;           ///< Property, name "cursor-image",            type STRING
  60   static const std::string PRIMARY_CURSOR_COLOR_PROPERTY_NAME;   ///< Property, name "primary-cursor-color",    type VECTOR4
  61   static const std::string SECONDARY_CURSOR_COLOR_PROPERTY_NAME; ///< Property, name "secondary-cursor-color",  type VECTOR4
  62   static const std::string ENABLE_CURSOR_BLINK_PROPERTY_NAME;    ///< Property, name "enable-cursor-blink",     type BOOLEAN
  63   static const std::string CURSOR_BLINK_INTERVAL_PROPERTY_NAME;  ///< Property, name "cursor-blink-interval",   type FLOAT
  64   static const std::string CURSOR_BLINK_DURATION_PROPERTY_NAME;  ///< Property, name "cursor-blink-duration",   type FLOAT
  65   static const std::string GRAB_HANDLE_IMAGE_PROPERTY_NAME;      ///< Property, name "grab-handle-image",       type STRING
  66   static const std::string DECORATION_BOUNDING_BOX;              ///< Property, name "decoration-bounding-box", type RECTANGLE
  67
  68   /**
  69    * Create the TextField control.
  70    * @return A handle to the TextField control.
  71    */
  72   static TextField New();
  73
  74   /**
  75    * @brief Creates an empty handle.
  76    */
  77   TextField();
  78
  79   /**
  80    * @brief Copy constructor.
  81    *
  82    * @param[in] handle The handle to copy from.
  83    */
  84   TextField( const TextField& handle );
  85
  86   /**
  87    * @brief Assignment operator.
  88    *
  89    * @param[in] handle The handle to copy from.
  90    * @return A reference to this.
  91    */
  92   TextField& operator=( const TextField& handle );
  93
  94   /**
  95    * @brief Destructor
  96    *
  97    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  98    */
  99   ~TextField();
 100
 101   /**
 102    * @brief Downcast a handle to TextField.
 103    *
 104    * If the BaseHandle points is a TextField the downcast returns a valid handle.
 105    * If not the returned handle is left empty.
 106    *
 107    * @param[in] handle Handle to an object
 108    * @return handle to a TextField or an empty handle
 109    */
 110   static TextField DownCast( BaseHandle handle );
 111
 112 public: // Not intended for application developers
 113
 114   /**
 115    * @brief Creates a handle using the Toolkit::Internal implementation.
 116    *
 117    * @param[in] implementation The Control implementation.
 118    */
 119   DALI_INTERNAL TextField( Internal::TextField& implementation );
 120
 121   /**
 122    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 123    *
 124    * @param[in]  internal  A pointer to the internal CustomActor.
 125    */
 126   explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
 127 };
 128
 129 } // namespace Toolkit
 130
 131 } // namespace Dali
 132
 133 #endif // __DALI_TOOLKIT_TEXT_FIELD_H__