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

   1 #ifndef DALI_TOOLKIT_TEXT_FIELD_DEVEL_H
   2 #define DALI_TOOLKIT_TEXT_FIELD_DEVEL_H
   3
   4 /*
   5  * Copyright (c) 2021 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 // EXTERNAL INCLUDES
  21 #include <dali/devel-api/adaptor-framework/input-method-context.h>
  22
  23 // INTERNAL INCLUDES
  24 #include <dali-toolkit/public-api/controls/text-controls/text-field.h>
  25
  26 namespace Dali
  27 {
  28 namespace Toolkit
  29 {
  30 namespace DevelTextField
  31 {
  32 namespace Property
  33 {
  34 enum
  35 {
  36   TEXT                                 = Dali::Toolkit::TextField::Property::TEXT,
  37   PLACEHOLDER_TEXT                     = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT,
  38   PLACEHOLDER_TEXT_FOCUSED             = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_FOCUSED,
  39   FONT_FAMILY                          = Dali::Toolkit::TextField::Property::FONT_FAMILY,
  40   FONT_STYLE                           = Dali::Toolkit::TextField::Property::FONT_STYLE,
  41   POINT_SIZE                           = Dali::Toolkit::TextField::Property::POINT_SIZE,
  42   MAX_LENGTH                           = Dali::Toolkit::TextField::Property::MAX_LENGTH,
  43   EXCEED_POLICY                        = Dali::Toolkit::TextField::Property::EXCEED_POLICY,
  44   HORIZONTAL_ALIGNMENT                 = Dali::Toolkit::TextField::Property::HORIZONTAL_ALIGNMENT,
  45   VERTICAL_ALIGNMENT                   = Dali::Toolkit::TextField::Property::VERTICAL_ALIGNMENT,
  46   TEXT_COLOR                           = Dali::Toolkit::TextField::Property::TEXT_COLOR,
  47   PLACEHOLDER_TEXT_COLOR               = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_COLOR,
  48   PRIMARY_CURSOR_COLOR                 = Dali::Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR,
  49   SECONDARY_CURSOR_COLOR               = Dali::Toolkit::TextField::Property::SECONDARY_CURSOR_COLOR,
  50   ENABLE_CURSOR_BLINK                  = Dali::Toolkit::TextField::Property::ENABLE_CURSOR_BLINK,
  51   CURSOR_BLINK_INTERVAL                = Dali::Toolkit::TextField::Property::CURSOR_BLINK_INTERVAL,
  52   CURSOR_BLINK_DURATION                = Dali::Toolkit::TextField::Property::CURSOR_BLINK_DURATION,
  53   CURSOR_WIDTH                         = Dali::Toolkit::TextField::Property::CURSOR_WIDTH,
  54   GRAB_HANDLE_IMAGE                    = Dali::Toolkit::TextField::Property::GRAB_HANDLE_IMAGE,
  55   GRAB_HANDLE_PRESSED_IMAGE            = Dali::Toolkit::TextField::Property::GRAB_HANDLE_PRESSED_IMAGE,
  56   SCROLL_THRESHOLD                     = Dali::Toolkit::TextField::Property::SCROLL_THRESHOLD,
  57   SCROLL_SPEED                         = Dali::Toolkit::TextField::Property::SCROLL_SPEED,
  58   SELECTION_HANDLE_IMAGE_LEFT          = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_LEFT,
  59   SELECTION_HANDLE_IMAGE_RIGHT         = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_RIGHT,
  60   SELECTION_HANDLE_PRESSED_IMAGE_LEFT  = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
  61   SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
  62   SELECTION_HANDLE_MARKER_IMAGE_LEFT   = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT,
  63   SELECTION_HANDLE_MARKER_IMAGE_RIGHT  = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
  64   SELECTION_HIGHLIGHT_COLOR            = Dali::Toolkit::TextField::Property::SELECTION_HIGHLIGHT_COLOR,
  65   DECORATION_BOUNDING_BOX              = Dali::Toolkit::TextField::Property::DECORATION_BOUNDING_BOX,
  66   INPUT_METHOD_SETTINGS                = Dali::Toolkit::TextField::Property::INPUT_METHOD_SETTINGS,
  67   INPUT_COLOR                          = Dali::Toolkit::TextField::Property::INPUT_COLOR,
  68   ENABLE_MARKUP                        = Dali::Toolkit::TextField::Property::ENABLE_MARKUP,
  69   INPUT_FONT_FAMILY                    = Dali::Toolkit::TextField::Property::INPUT_FONT_FAMILY,
  70   INPUT_FONT_STYLE                     = Dali::Toolkit::TextField::Property::INPUT_FONT_STYLE,
  71   INPUT_POINT_SIZE                     = Dali::Toolkit::TextField::Property::INPUT_POINT_SIZE,
  72   UNDERLINE                            = Dali::Toolkit::TextField::Property::UNDERLINE,
  73   INPUT_UNDERLINE                      = Dali::Toolkit::TextField::Property::INPUT_UNDERLINE,
  74   SHADOW                               = Dali::Toolkit::TextField::Property::SHADOW,
  75   INPUT_SHADOW                         = Dali::Toolkit::TextField::Property::INPUT_SHADOW,
  76   EMBOSS                               = Dali::Toolkit::TextField::Property::EMBOSS,
  77   INPUT_EMBOSS                         = Dali::Toolkit::TextField::Property::INPUT_EMBOSS,
  78   OUTLINE                              = Dali::Toolkit::TextField::Property::OUTLINE,
  79   INPUT_OUTLINE                        = Dali::Toolkit::TextField::Property::INPUT_OUTLINE,
  80   HIDDEN_INPUT_SETTINGS                = Dali::Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS,
  81   PIXEL_SIZE                           = Dali::Toolkit::TextField::Property::PIXEL_SIZE,
  82   ENABLE_SELECTION                     = Dali::Toolkit::TextField::Property::ENABLE_SELECTION,
  83   PLACEHOLDER                          = Dali::Toolkit::TextField::Property::PLACEHOLDER,
  84   ELLIPSIS                             = Dali::Toolkit::TextField::Property::ELLIPSIS,
  85
  86   /**
  87    * @brief Enables Text selection using Shift key.
  88    * @details Name "enableShiftSelection", type Property::BOOLEAN.
  89    */
  90   ENABLE_SHIFT_SELECTION = ELLIPSIS + 1,
  91
  92   /**
  93    * @brief Enables the grab handles for text selection.
  94    * @details Name "enableGrabHandle", type Property::BOOLEAN.
  95    * @note The default value is true, which means the grab handles are enabled by default.
  96    */
  97   ENABLE_GRAB_HANDLE = ELLIPSIS + 2,
  98
  99   /**
 100    * @brief Modifies the default text alignment to match the direction of the system language.
 101    * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write
 102    * @note The default value is false
 103    */
 104   MATCH_SYSTEM_LANGUAGE_DIRECTION = ELLIPSIS + 3,
 105
 106   /**
 107    * @brief Enables the grab handle popup for text selection.
 108    * @details Name "enableGrabHandlePopup", type Property::BOOLEAN.
 109    * @note The default value is true, which means the grab handle popup is enabled by default.
 110    */
 111   ENABLE_GRAB_HANDLE_POPUP = ELLIPSIS + 4,
 112
 113   /**
 114    * @brief The default text background parameters.
 115    * @details Name "textBackground", type Property::VECTOR4.
 116    * @note Use "textBackground" as property name to avoid conflict with Control's "background" property.
 117    * @note The default value is Color::TRANSPARENT.
 118    */
 119   BACKGROUND = ELLIPSIS + 5,
 120
 121   /**
 122    * @brief The selected text in UTF-8 format.
 123    * @details Name "selectedText", type Property::STRING.
 124    * @note This property is read-only.
 125    */
 126   SELECTED_TEXT = ELLIPSIS + 6,
 127
 128   /**
 129    * @brief The type or rendering e.g. bitmap-based.
 130    * @details Name "renderingBackend", type Property::INTEGER.
 131    */
 132   RENDERING_BACKEND = ELLIPSIS + 7,
 133
 134   /**
 135    * @brief The selected text start position.
 136    * @details Name "selectedTextStart", type Property::INTEGER.
 137    */
 138   SELECTED_TEXT_START,
 139
 140   /**
 141    * @brief The selected text range end position.
 142    * @details Name "selectedTextEnd", type Property::INTEGER.
 143    */
 144   SELECTED_TEXT_END,
 145
 146   /**
 147    * @brief The Editable state of control.
 148    * @details Name "enableEditing", type Property::BOOLEAN.
 149    */
 150   ENABLE_EDITING,
 151
 152   /**
 153    * @brief The font size scale.
 154    * @details name "fontSizeScale", type Property::FLOAT.
 155    * @note The default value is 1.0 which does nothing.
 156    * The given font size scale value is used for multiplying the specified font size before querying fonts.
 157    *
 158    * e.g. The rendering results of both cases are same.
 159    *  - fontSize: 15pt, fontSizeScale: 1.0
 160    *  - fontSize: 10pt, fontSizeScale: 1.5
 161    */
 162   FONT_SIZE_SCALE,
 163
 164   /**
 165    * @brief The position for primary cursor.
 166    * @details Name "primaryCursorPosition", type Property::INTEGER.
 167    */
 168   PRIMARY_CURSOR_POSITION,
 169
 170   /**
 171    * @brief The color of the grab color.
 172    * @details Name "grabHandleColor", type Property::VECTOR4.
 173    */
 174   GRAB_HANDLE_COLOR,
 175 };
 176
 177 } // namespace Property
 178
 179 /**
 180  * @brief Return the input method context of TextField.
 181  *
 182  * @param[in] textField The instance of TextField.
 183  * @return InputMethodContext instance.
 184  */
 185 DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextField textField);
 186
 187 /**
 188  * @brief Select the whole text of TextField.
 189  *
 190  * @param[in] textField The instance of TextField.
 191  */
 192 DALI_TOOLKIT_API void SelectWholeText(TextField textField);
 193
 194 /**
 195  * @brief Unselect the whole text of TextField.
 196  *
 197  * @param[in] textField The instance of TextField.
 198  */
 199 DALI_TOOLKIT_API void SelectNone(TextField textField);
 200
 201 } // namespace DevelTextField
 202
 203 } // namespace Toolkit
 204
 205 } // namespace Dali
 206
 207 #endif // DALI_TOOLKIT_TEXT_FIELD_DEVEL_H