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