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   /**
  43    * @brief The start and end property ranges for this control.
  44    */
  45   enum PropertyRange
  46   {
  47     PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1,
  48     PROPERTY_END_INDEX =   PROPERTY_START_INDEX + 1000              ///< Reserve property indices
  49   };
  50
  51   /**
  52    * @brief An enumeration of properties belonging to the TextLabel class.
  53    */
  54   struct Property
  55   {
  56     enum
  57     {
  58       RENDERING_BACKEND = PROPERTY_START_INDEX, ///< name "rendering-backend",       The type or rendering e.g. bitmap-based,                                  type INT
  59       PLACEHOLDER_TEXT,                         ///< name "placeholder-text",        The text to display when the TextField is empty,                          type STRING
  60       TEXT,                                     ///< name "text",                    The text to display in UTF-8 format,                                      type STRING
  61       FONT_FAMILY,                              ///< name "font-family",             The requested font family,                                                type STRING
  62       FONT_STYLE,                               ///< name "font-style",              The requested font style e.g. Regular/Italic,                             type STRING
  63       POINT_SIZE,                               ///< name "point-size",              The size of font in points,                                               type FLOAT
  64       EXCEED_POLICY,                            ///< name "exceed-policy"            Specifies how the text is truncated when it does not fit,                 type INT
  65       CURSOR_IMAGE,                             ///< name "cursor-image",            The image to display for cursors,                                         type STRING
  66       PRIMARY_CURSOR_COLOR,                     ///< name "primary-cursor-color",    The color to apply to the primary cursor,                                 type VECTOR4
  67       SECONDARY_CURSOR_COLOR,                   ///< name "secondary-cursor-color",  The color to apply to the secondary cursor,                               type VECTOR4
  68       ENABLE_CURSOR_BLINK,                      ///< name "enable-cursor-blink",     Whether the cursor should blink or not,                                   type BOOLEAN
  69       CURSOR_BLINK_INTERVAL,                    ///< name "cursor-blink-interval",   The time interval between cursor on/off states,                           type FLOAT
  70       CURSOR_BLINK_DURATION,                    ///< name "cursor-blink-duration",   The cursor will stop blinking after this duration (if non-zero),          type FLOAT
  71       GRAB_HANDLE_IMAGE,                        ///< name "grab-handle-image",       The image to display for grab handle,                                     type STRING
  72       DECORATION_BOUNDING_BOX                   ///< name "decoration-bounding-box", The decorations (handles etc) will positioned within this area on-screen, type RECTANGLE
  73     };
  74   };
  75
  76   /**
  77    * @brief Specifies how the text is truncated when it does not fit
  78    *
  79    * The default value is \e EXCEED_POLICY_CLIP.
  80    */
  81   enum ExceedPolicy
  82   {
  83     EXCEED_POLICY_ORIGINAL,        ///< The text will be display at original size, and may exceed the TextField boundary.
  84     EXCEED_POLICY_CLIP             ///< The end of text will be clipped to fit within the TextField.
  85   };
  86
  87   /**
  88    * Create the TextField control.
  89    * @return A handle to the TextField control.
  90    */
  91   static TextField New();
  92
  93   /**
  94    * @brief Creates an empty handle.
  95    */
  96   TextField();
  97
  98   /**
  99    * @brief Copy constructor.
 100    *
 101    * @param[in] handle The handle to copy from.
 102    */
 103   TextField( const TextField& handle );
 104
 105   /**
 106    * @brief Assignment operator.
 107    *
 108    * @param[in] handle The handle to copy from.
 109    * @return A reference to this.
 110    */
 111   TextField& operator=( const TextField& handle );
 112
 113   /**
 114    * @brief Destructor
 115    *
 116    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 117    */
 118   ~TextField();
 119
 120   /**
 121    * @brief Downcast a handle to TextField.
 122    *
 123    * If the BaseHandle points is a TextField the downcast returns a valid handle.
 124    * If not the returned handle is left empty.
 125    *
 126    * @param[in] handle Handle to an object
 127    * @return handle to a TextField or an empty handle
 128    */
 129   static TextField DownCast( BaseHandle handle );
 130
 131 public: // Not intended for application developers
 132
 133   /**
 134    * @brief Creates a handle using the Toolkit::Internal implementation.
 135    *
 136    * @param[in] implementation The Control implementation.
 137    */
 138   DALI_INTERNAL TextField( Internal::TextField& implementation );
 139
 140   /**
 141    * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
 142    *
 143    * @param[in]  internal  A pointer to the internal CustomActor.
 144    */
 145   explicit DALI_INTERNAL TextField( Dali::Internal::CustomActor* internal );
 146 };
 147
 148 } // namespace Toolkit
 149
 150 } // namespace Dali
 151
 152 #endif // __DALI_TOOLKIT_TEXT_FIELD_H__