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

   1 #ifndef DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H
   2 #define DALI_TOOLKIT_TEXT_EDITOR_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-editor.h>
  25
  26 namespace Dali
  27 {
  28 namespace Toolkit
  29 {
  30 namespace DevelTextEditor
  31 {
  32 namespace Property
  33 {
  34 enum Type
  35 {
  36   TEXT                                 = Dali::Toolkit::TextEditor::Property::TEXT,
  37   TEXT_COLOR                           = Dali::Toolkit::TextEditor::Property::TEXT_COLOR,
  38   FONT_FAMILY                          = Dali::Toolkit::TextEditor::Property::FONT_FAMILY,
  39   FONT_STYLE                           = Dali::Toolkit::TextEditor::Property::FONT_STYLE,
  40   POINT_SIZE                           = Dali::Toolkit::TextEditor::Property::POINT_SIZE,
  41   HORIZONTAL_ALIGNMENT                 = Dali::Toolkit::TextEditor::Property::HORIZONTAL_ALIGNMENT,
  42   SCROLL_THRESHOLD                     = Dali::Toolkit::TextEditor::Property::SCROLL_THRESHOLD,
  43   SCROLL_SPEED                         = Dali::Toolkit::TextEditor::Property::SCROLL_SPEED,
  44   PRIMARY_CURSOR_COLOR                 = Dali::Toolkit::TextEditor::Property::PRIMARY_CURSOR_COLOR,
  45   SECONDARY_CURSOR_COLOR               = Dali::Toolkit::TextEditor::Property::SECONDARY_CURSOR_COLOR,
  46   ENABLE_CURSOR_BLINK                  = Dali::Toolkit::TextEditor::Property::ENABLE_CURSOR_BLINK,
  47   CURSOR_BLINK_INTERVAL                = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_INTERVAL,
  48   CURSOR_BLINK_DURATION                = Dali::Toolkit::TextEditor::Property::CURSOR_BLINK_DURATION,
  49   CURSOR_WIDTH                         = Dali::Toolkit::TextEditor::Property::CURSOR_WIDTH,
  50   GRAB_HANDLE_IMAGE                    = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_IMAGE,
  51   GRAB_HANDLE_PRESSED_IMAGE            = Dali::Toolkit::TextEditor::Property::GRAB_HANDLE_PRESSED_IMAGE,
  52   SELECTION_HANDLE_IMAGE_LEFT          = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_LEFT,
  53   SELECTION_HANDLE_IMAGE_RIGHT         = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_IMAGE_RIGHT,
  54   SELECTION_HANDLE_PRESSED_IMAGE_LEFT  = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
  55   SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
  56   SELECTION_HANDLE_MARKER_IMAGE_LEFT   = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT,
  57   SELECTION_HANDLE_MARKER_IMAGE_RIGHT  = Dali::Toolkit::TextEditor::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
  58   SELECTION_HIGHLIGHT_COLOR            = Dali::Toolkit::TextEditor::Property::SELECTION_HIGHLIGHT_COLOR,
  59   DECORATION_BOUNDING_BOX              = Dali::Toolkit::TextEditor::Property::DECORATION_BOUNDING_BOX,
  60   ENABLE_MARKUP                        = Dali::Toolkit::TextEditor::Property::ENABLE_MARKUP,
  61   INPUT_COLOR                          = Dali::Toolkit::TextEditor::Property::INPUT_COLOR,
  62   INPUT_FONT_FAMILY                    = Dali::Toolkit::TextEditor::Property::INPUT_FONT_FAMILY,
  63   INPUT_FONT_STYLE                     = Dali::Toolkit::TextEditor::Property::INPUT_FONT_STYLE,
  64   INPUT_POINT_SIZE                     = Dali::Toolkit::TextEditor::Property::INPUT_POINT_SIZE,
  65   LINE_SPACING                         = Dali::Toolkit::TextEditor::Property::LINE_SPACING,
  66   INPUT_LINE_SPACING                   = Dali::Toolkit::TextEditor::Property::INPUT_LINE_SPACING,
  67   UNDERLINE                            = Dali::Toolkit::TextEditor::Property::UNDERLINE,
  68   INPUT_UNDERLINE                      = Dali::Toolkit::TextEditor::Property::INPUT_UNDERLINE,
  69   SHADOW                               = Dali::Toolkit::TextEditor::Property::SHADOW,
  70   INPUT_SHADOW                         = Dali::Toolkit::TextEditor::Property::INPUT_SHADOW,
  71   EMBOSS                               = Dali::Toolkit::TextEditor::Property::EMBOSS,
  72   INPUT_EMBOSS                         = Dali::Toolkit::TextEditor::Property::INPUT_EMBOSS,
  73   OUTLINE                              = Dali::Toolkit::TextEditor::Property::OUTLINE,
  74   INPUT_OUTLINE                        = Dali::Toolkit::TextEditor::Property::INPUT_OUTLINE,
  75   SMOOTH_SCROLL                        = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL,
  76   SMOOTH_SCROLL_DURATION               = Dali::Toolkit::TextEditor::Property::SMOOTH_SCROLL_DURATION,
  77   ENABLE_SCROLL_BAR                    = Dali::Toolkit::TextEditor::Property::ENABLE_SCROLL_BAR,
  78   SCROLL_BAR_SHOW_DURATION             = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_SHOW_DURATION,
  79   SCROLL_BAR_FADE_DURATION             = Dali::Toolkit::TextEditor::Property::SCROLL_BAR_FADE_DURATION,
  80   PIXEL_SIZE                           = Dali::Toolkit::TextEditor::Property::PIXEL_SIZE,
  81   LINE_COUNT                           = Dali::Toolkit::TextEditor::Property::LINE_COUNT,
  82   ENABLE_SELECTION                     = Dali::Toolkit::TextEditor::Property::ENABLE_SELECTION,
  83   PLACEHOLDER                          = Dali::Toolkit::TextEditor::Property::PLACEHOLDER,
  84   LINE_WRAP_MODE                       = Dali::Toolkit::TextEditor::Property::LINE_WRAP_MODE,
  85
  86   /**
  87    * @brief The text to display when the TextEditor is empty and inactive.
  88    * @details Name "placeholderText", type Property::STRING.
  89    */
  90   PLACEHOLDER_TEXT,
  91
  92   /**
  93    * @brief The placeholder-text color.
  94    * @details Name "placeholderTextColor", type Property::VECTOR4.
  95    */
  96   PLACEHOLDER_TEXT_COLOR,
  97
  98   /**
  99    * @brief Enables Text selection using Shift key.
 100    * @details Name "enableShiftSelection", type Property::BOOLEAN.
 101    */
 102   ENABLE_SHIFT_SELECTION,
 103
 104   /**
 105    * @brief Enables the grab handles for text selection.
 106    * @details Name "enableGrabHandle", type Property::BOOLEAN.
 107    * @note The default value is true, which means the grab handles are enabled by default.
 108    */
 109   ENABLE_GRAB_HANDLE,
 110
 111   /**
 112    * @brief Modifies the default text alignment to match the direction of the system language.
 113    * @details Name "matchSystemLanguageDirection", type (Property::BOOLEAN), Read/Write
 114    * @note The default value is false
 115    */
 116   MATCH_SYSTEM_LANGUAGE_DIRECTION,
 117
 118   /**
 119    * @brief The type or rendering e.g. bitmap-based.
 120    * @details Name "renderingBackend", type Property::INTEGER.
 121    */
 122   RENDERING_BACKEND,
 123
 124   /**
 125    * @brief The maximum number of characters that can be inserted.
 126    * @details Name "maxLength", type Property::INTEGER.
 127    */
 128   MAX_LENGTH,
 129
 130   /**
 131    * @brief The selected text start position.
 132    * @details Name "selectedTextStart", type Property::INTEGER.
 133    */
 134   SELECTED_TEXT_START,
 135
 136   /**
 137    * @brief The selected text range end position.
 138    * @details Name "selectedTextEnd", type Property::INTEGER.
 139    */
 140   SELECTED_TEXT_END,
 141
 142   /**
 143    * @brief The horizontal scroll position in pixels.
 144    * @details Name "horizontalScrollPosition", type Property::FLOAT.
 145    */
 146   HORIZONTAL_SCROLL_POSITION,
 147
 148   /**
 149    * @brief The vertical scroll position in pixels.
 150    * @details Name "verticalScrollPosition", type Property::FLOAT.
 151    */
 152   VERTICAL_SCROLL_POSITION,
 153
 154   /**
 155    * @brief The Editable state of control.
 156    * @details Name "enableEditing", type Property::BOOLEAN.
 157    */
 158   ENABLE_EDITING,
 159
 160   /**
 161    * @brief The selected text in UTF-8 format.
 162    * @details Name "selectedText", type Property::STRING.
 163    * @note This property is read-only.
 164    */
 165   SELECTED_TEXT,
 166
 167   /**
 168    * @brief The font size scale.
 169    * @details name "fontSizeScale", type Property::FLOAT.
 170    * @note The default value is 1.0 which does nothing.
 171    * The given font size scale value is used for multiplying the specified font size before querying fonts.
 172    *
 173    * e.g. The rendering results of both cases are same.
 174    *  - fontSize: 15pt, fontSizeScale: 1.0
 175    *  - fontSize: 10pt, fontSizeScale: 1.5
 176    */
 177   FONT_SIZE_SCALE,
 178 };
 179
 180 } // namespace Property
 181
 182 /**
 183  * @brief Return the input method context of TextEditor.
 184  *
 185  * @param[in] textEditor The instance of TextEditor.
 186  * @return InputMethodContext instance.
 187  */
 188 DALI_TOOLKIT_API InputMethodContext GetInputMethodContext(TextEditor textEditor);
 189
 190 /**
 191  * @brief Max Characters Exceed signal type.
 192   */
 193 using MaxLengthReachedSignalType = Signal<void(TextEditor)>;
 194
 195 /**
 196  * @brief This signal is emitted when inserted text exceeds the maximum character limit.
 197  *
 198  * A callback of the following type may be connected:
 199  * @code
 200  *   void YourCallbackName( TextEditor textEditor );
 201  * @endcode
 202  * @param[in] textEditor The instance of TextEditor.
 203  * @return The signal to connect to
 204  */
 205 DALI_TOOLKIT_API MaxLengthReachedSignalType& MaxLengthReachedSignal(TextEditor textEditor);
 206
 207 /**
 208  * @brief Select the whole text of TextEditor.
 209  *
 210  * @param[in] textEditor The instance of TextEditor.
 211  */
 212 DALI_TOOLKIT_API void SelectWholeText(TextEditor textEditor);
 213
 214 /**
 215  * @brief Unselect the whole text of TextEditor.
 216  *
 217  * @param[in] textEditor The instance of TextEditor.
 218  */
 219 DALI_TOOLKIT_API void SelectNone(TextEditor textEditor);
 220
 221 /**
 222  * @brief Scroll the TextEditor by specific amount.
 223  *
 224  * @param[in] textEditor The instance of TextEditor.
 225  * @param[in] scroll amount (in pixels) of scrolling in horizontal & vectical directions.
 226  */
 227 DALI_TOOLKIT_API void ScrollBy(TextEditor textEditor, Vector2 scroll);
 228
 229 } // namespace DevelTextEditor
 230
 231 } // namespace Toolkit
 232
 233 } // namespace Dali
 234
 235 #endif // DALI_TOOLKIT_TEXT_EDITOR_DEVEL_H