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) 2017 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/text-controls/text-field.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Toolkit
  28 {
  29
  30 namespace DevelTextField
  31 {
  32
  33 namespace Property
  34 {
  35   enum Type
  36   {
  37       RENDERING_BACKEND = Dali::Toolkit::TextField::Property::RENDERING_BACKEND,
  38       TEXT = Dali::Toolkit::TextField::Property::TEXT,
  39       PLACEHOLDER_TEXT = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT,
  40       PLACEHOLDER_TEXT_FOCUSED = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_FOCUSED,
  41       FONT_FAMILY = Dali::Toolkit::TextField::Property::FONT_FAMILY,
  42       FONT_STYLE = Dali::Toolkit::TextField::Property::FONT_STYLE,
  43       POINT_SIZE = Dali::Toolkit::TextField::Property::POINT_SIZE,
  44       MAX_LENGTH = Dali::Toolkit::TextField::Property::MAX_LENGTH,
  45       EXCEED_POLICY = Dali::Toolkit::TextField::Property::EXCEED_POLICY,
  46       HORIZONTAL_ALIGNMENT = Dali::Toolkit::TextField::Property::HORIZONTAL_ALIGNMENT,
  47       VERTICAL_ALIGNMENT = Dali::Toolkit::TextField::Property::VERTICAL_ALIGNMENT,
  48       TEXT_COLOR = Dali::Toolkit::TextField::Property::TEXT_COLOR,
  49       PLACEHOLDER_TEXT_COLOR = Dali::Toolkit::TextField::Property::PLACEHOLDER_TEXT_COLOR,
  50       SHADOW_OFFSET = Dali::Toolkit::TextField::Property::SHADOW_OFFSET,
  51       SHADOW_COLOR = Dali::Toolkit::TextField::Property::SHADOW_COLOR,
  52       PRIMARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::PRIMARY_CURSOR_COLOR,
  53       SECONDARY_CURSOR_COLOR = Dali::Toolkit::TextField::Property::SECONDARY_CURSOR_COLOR,
  54       ENABLE_CURSOR_BLINK = Dali::Toolkit::TextField::Property::ENABLE_CURSOR_BLINK,
  55       CURSOR_BLINK_INTERVAL = Dali::Toolkit::TextField::Property::CURSOR_BLINK_INTERVAL,
  56       CURSOR_BLINK_DURATION = Dali::Toolkit::TextField::Property::CURSOR_BLINK_DURATION,
  57       CURSOR_WIDTH = Dali::Toolkit::TextField::Property::CURSOR_WIDTH,
  58       GRAB_HANDLE_IMAGE = Dali::Toolkit::TextField::Property::GRAB_HANDLE_IMAGE,
  59       GRAB_HANDLE_PRESSED_IMAGE = Dali::Toolkit::TextField::Property::GRAB_HANDLE_PRESSED_IMAGE,
  60       SCROLL_THRESHOLD = Dali::Toolkit::TextField::Property::SCROLL_THRESHOLD,
  61       SCROLL_SPEED = Dali::Toolkit::TextField::Property::SCROLL_SPEED,
  62       SELECTION_HANDLE_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_LEFT,
  63       SELECTION_HANDLE_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_IMAGE_RIGHT,
  64       SELECTION_HANDLE_PRESSED_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_LEFT,
  65       SELECTION_HANDLE_PRESSED_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_PRESSED_IMAGE_RIGHT,
  66       SELECTION_HANDLE_MARKER_IMAGE_LEFT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_LEFT,
  67       SELECTION_HANDLE_MARKER_IMAGE_RIGHT = Dali::Toolkit::TextField::Property::SELECTION_HANDLE_MARKER_IMAGE_RIGHT,
  68       SELECTION_HIGHLIGHT_COLOR = Dali::Toolkit::TextField::Property::SELECTION_HIGHLIGHT_COLOR,
  69       DECORATION_BOUNDING_BOX = Dali::Toolkit::TextField::Property::DECORATION_BOUNDING_BOX,
  70       INPUT_METHOD_SETTINGS = Dali::Toolkit::TextField::Property::INPUT_METHOD_SETTINGS,
  71       INPUT_COLOR = Dali::Toolkit::TextField::Property::INPUT_COLOR,
  72       ENABLE_MARKUP = Dali::Toolkit::TextField::Property::ENABLE_MARKUP,
  73       INPUT_FONT_FAMILY = Dali::Toolkit::TextField::Property::INPUT_FONT_FAMILY,
  74       INPUT_FONT_STYLE = Dali::Toolkit::TextField::Property::INPUT_FONT_STYLE,
  75       INPUT_POINT_SIZE = Dali::Toolkit::TextField::Property::INPUT_POINT_SIZE,
  76       UNDERLINE = Dali::Toolkit::TextField::Property::UNDERLINE,
  77       INPUT_UNDERLINE = Dali::Toolkit::TextField::Property::INPUT_UNDERLINE,
  78       SHADOW = Dali::Toolkit::TextField::Property::SHADOW,
  79       INPUT_SHADOW = Dali::Toolkit::TextField::Property::INPUT_SHADOW,
  80       EMBOSS = Dali::Toolkit::TextField::Property::EMBOSS,
  81       INPUT_EMBOSS = Dali::Toolkit::TextField::Property::INPUT_EMBOSS,
  82       OUTLINE = Dali::Toolkit::TextField::Property::OUTLINE,
  83       INPUT_OUTLINE = Dali::Toolkit::TextField::Property::INPUT_OUTLINE,
  84
  85       /**
  86        * @brief Hides the input characters and instead shows a default character for password or pin entry.
  87        * @details name "hiddenInputSettings", type map.
  88        * @note Optional.
  89        * @see HiddenInput
  90        */
  91       HIDDEN_INPUT_SETTINGS = INPUT_OUTLINE + 1,
  92
  93       /**
  94        * @brief The size of font in pixels.
  95        *
  96        * Conversion from Point size to Pixel size :
  97        *  Pixel size = Point size * DPI / 72
  98        * @details name "pixelSize", type float
  99        */
 100       PIXEL_SIZE = INPUT_OUTLINE + 2,
 101
 102       /**
 103        * @brief Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
 104        * @details name "enableSelection", type bool
 105        */
 106       ENABLE_SELECTION = INPUT_OUTLINE + 3,
 107
 108       /**
 109        * @brief Sets the placeholder : text, color, font family, font style, point size, and pixel size.
 110        *
 111        * @code
 112        *   Property::Map propertyMap;
 113        *   propertyMap["placeholderText"] = "Setting Placeholder Text";
 114        *   propertyMap["placeholderTextFocused"] = "Setting Placeholder Text Focused";
 115        *   propertyMap["placeholderColor"] = Color::RED;
 116        *   propertyMap["placeholderFontFamily"] = "Arial";
 117        *   propertyMap["placeholderPointSize"] = 12.0f;
 118        *
 119        *   Property::Map fontStyleMap;
 120        *   fontStyleMap.Insert( "weight", "bold" );
 121        *   fontStyleMap.Insert( "width", "condensed" );
 122        *   fontStyleMap.Insert( "slant", "italic" );
 123        *   propertyMap["placeholderFontStyle"] = fontStyleMap;
 124        *
 125        *   field.SetProperty( DevelTextField::Property::PLACEHOLDER, propertyMap );
 126        * @endcode
 127        *
 128        * @details name "placeholder", type MAP
 129        */
 130       PLACEHOLDER = INPUT_OUTLINE + 4
 131   };
 132 } // namespace Property
 133
 134 } // namespace DevelText
 135
 136 } // namespace Toolkit
 137
 138 } // namespace Dali
 139
 140 #endif // DALI_TOOLKIT_TEXT_FIELD_DEVEL_H