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) 2020 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
  29 namespace Toolkit
  30 {
  31
  32 namespace DevelTextField
  33 {
  34
  35 namespace Property
  36 {
  37   enum
  38   {
  39       TEXT = Dali::Toolkit::TextField::Property::TEXT,
  40       PLACEHOLDER_TEXT = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT,
  41       PLACEHOLDER_TEXT_FOCUSED = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_FOCUSED,
  42       FONT_FAMILY = Dali::Toolkit::TextField::Property::FONT_FAMILY,
  43       FONT_STYLE = Dali::Toolkit::TextField::Property::FONT_STYLE,
  44       POINT_SIZE = Dali::Toolkit::TextField::Property::POINT_SIZE,
  45       MAX_LENGTH = Dali::Toolkit::TextField::Property::MAX_LENGTH,
  46       EXCEED_POLICY = Dali::Toolkit::TextField::Property::EXCEED_POLICY,
  47       HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextField::Property::HORIZONTAL_ALIGNMENT,
  48       VERTICAL_ALIGNMENT = Dali::Toolkit::TextField::Property::VERTICAL_ALIGNMENT,
  49       TEXT_COLOR = Dali::Toolkit::TextField::Property::TEXT_COLOR,
  50       PLACEHOLDER_TEXT_COLOR = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_COLOR,
  51       PRIMARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR,
  52       SECONDARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::SECONDARY_CURSOR_COLOR,
  53       ENABLE_CURSOR_BLINK = Dali::Toolkit::TextField::Property::ENABLE_CURSOR_BLINK,
  54       CURSOR_BLINK_INTERVAL = Dali::Toolkit::TextField::Property::CURSOR_BLINK_INTERVAL,
  55       CURSOR_BLINK_DURATION = Dali::Toolkit::TextField::Property::CURSOR_BLINK_DURATION,
  56       CURSOR_WIDTH = Dali::Toolkit::TextField::Property::CURSOR_WIDTH,
  57       GRAB_HANDLE_IMAGE = Dali::Toolkit::TextField::Property::GRAB_HANDLE_IMAGE,
  58       GRAB_HANDLE_PRESSED_IMAGE = Dali::Toolkit::TextField::Property::GRAB_HANDLE_PRESSED_IMAGE,
  59       SCROLL_THRESHOLD = Dali::Toolkit::TextField::Property::SCROLL_THRESHOLD,
  60       SCROLL_SPEED = Dali::Toolkit::TextField::Property::SCROLL_SPEED,
  61       SELECTION_HANDLE_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_LEFT,
  62       SELECTION_HANDLE_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_RIGHT,
  63       SELECTION_HANDLE_PRESSED_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
  64       SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
  65       SELECTION_HANDLE_MARKER_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT,
  66       SELECTION_HANDLE_MARKER_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
  67       SELECTION_HIGHLIGHT_COLOR = Dali::Toolkit::TextField::Property::SELECTION_HIGHLIGHT_COLOR,
  68       DECORATION_BOUNDING_BOX = Dali::Toolkit::TextField::Property::DECORATION_BOUNDING_BOX,
  69       INPUT_METHOD_SETTINGS = Dali::Toolkit::TextField::Property::INPUT_METHOD_SETTINGS,
  70       INPUT_COLOR = Dali::Toolkit::TextField::Property::INPUT_COLOR,
  71       ENABLE_MARKUP = Dali::Toolkit::TextField::Property::ENABLE_MARKUP,
  72       INPUT_FONT_FAMILY = Dali::Toolkit::TextField::Property::INPUT_FONT_FAMILY,
  73       INPUT_FONT_STYLE = Dali::Toolkit::TextField::Property::INPUT_FONT_STYLE,
  74       INPUT_POINT_SIZE = Dali::Toolkit::TextField::Property::INPUT_POINT_SIZE,
  75       UNDERLINE = Dali::Toolkit::TextField::Property::UNDERLINE,
  76       INPUT_UNDERLINE = Dali::Toolkit::TextField::Property::INPUT_UNDERLINE,
  77       SHADOW = Dali::Toolkit::TextField::Property::SHADOW,
  78       INPUT_SHADOW = Dali::Toolkit::TextField::Property::INPUT_SHADOW,
  79       EMBOSS = Dali::Toolkit::TextField::Property::EMBOSS,
  80       INPUT_EMBOSS = Dali::Toolkit::TextField::Property::INPUT_EMBOSS,
  81       OUTLINE = Dali::Toolkit::TextField::Property::OUTLINE,
  82       INPUT_OUTLINE = Dali::Toolkit::TextField::Property::INPUT_OUTLINE,
  83       HIDDEN_INPUT_SETTINGS = Dali::Toolkit::TextField::Property::HIDDEN_INPUT_SETTINGS,
  84       PIXEL_SIZE = Dali::Toolkit::TextField::Property::PIXEL_SIZE,
  85       ENABLE_SELECTION = Dali::Toolkit::TextField::Property::ENABLE_SELECTION,
  86       PLACEHOLDER = Dali::Toolkit::TextField::Property::PLACEHOLDER,
  87       ELLIPSIS = Dali::Toolkit::TextField::Property::ELLIPSIS,
  88
  89       /**
  90        * @brief Enables Text selection using Shift key.
  91        * @details Name "enableShiftSelection", type Property::BOOLEAN.
  92        */
  93       ENABLE_SHIFT_SELECTION = ELLIPSIS + 1,
  94
  95       /**
  96        * @brief Enables the grab handles for text selection.
  97        * @details Name "enableGrabHandle", type Property::BOOLEAN.
  98        * @note The default value is true, which means the grab handles are enabled by default.
  99        */
 100       ENABLE_GRAB_HANDLE = ELLIPSIS + 2,
 101
 102       /**
 103        * @brief Modifies the default text alignment to match the direction of the system language.
 104        * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write
 105        * @note The default value is false
 106        */
 107       MATCH_SYSTEM_LANGUAGE_DIRECTION = ELLIPSIS + 3,
 108
 109       /**
 110         * @brief Enables the grab handle popup for text selection.
 111         * @details Name "enableGrabHandlePopup", type Property::BOOLEAN.
 112         * @note The default value is true, which means the grab handle popup is enabled by default.
 113         */
 114       ENABLE_GRAB_HANDLE_POPUP = ELLIPSIS + 4,
 115
 116       /**
 117        * @brief The default text background parameters.
 118        * @details Name "textBackground", type Property::VECTOR4.
 119        * @note Use "textBackground" as property name to avoid conflict with Control's "background" property.
 120        * @note The default value is Color::TRANSPARENT.
 121        */
 122       BACKGROUND = ELLIPSIS + 5,
 123
 124
 125       /**
 126        * @brief The selected text in UTF-8 format.
 127        * @details Name "selectedText", type Property::STRING.
 128        * @note This property is read-only.
 129        */
 130       SELECTED_TEXT = ELLIPSIS + 6,
 131
 132       /**
 133        * @brief The type or rendering e.g. bitmap-based.
 134        * @details Name "renderingBackend", type Property::INTEGER.
 135        */
 136       RENDERING_BACKEND = ELLIPSIS + 7,
 137
 138   };
 139 } // namespace Property
 140
 141 /**
 142  * @brief Return the input method context of TextField.
 143  *
 144  * @param[in] textField The instance of TextField.
 145  * @return InputMethodContext instance.
 146  */
 147 DALI_TOOLKIT_API InputMethodContext GetInputMethodContext( TextField textField );
 148
 149 /**
 150  * @brief Select the whole text of TextField.
 151  *
 152  * @param[in] textField The instance of TextField.
 153  */
 154 DALI_TOOLKIT_API void SelectWholeText( TextField textField );
 155
 156 /**
 157  * @brief Unselect the whole text of TextField.
 158  *
 159  * @param[in] textField The instance of TextField.
 160  */
 161 DALI_TOOLKIT_API void SelectNone( TextField textField );
 162
 163 } // namespace DevelText
 164
 165 } // namespace Toolkit
 166
 167 } // namespace Dali
 168
 169 #endif // DALI_TOOLKIT_TEXT_FIELD_DEVEL_H