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