Tizen Native API
4.0
|
Enumeration for the instance of properties belonging to the TextField class. More...
Public Types | |
enum | |
Enumeration for the instance of properties belonging to the TextField class. More... |
Detailed Description
Enumeration for the instance of properties belonging to the TextField class.
- Since:
- 3.0, DALi version 1.0.0
Member Enumeration Documentation
anonymous enum |
Enumeration for the instance of properties belonging to the TextField class.
- Since:
- 3.0, DALi version 1.0.0
- Enumerator:
RENDERING_BACKEND The type or rendering e.g. bitmap-based.
Name "renderingBackend", type Property::INTEGER.
- Since:
- 3.0, DALi version 1.0.0
TEXT The text to display in UTF-8 format.
Name "text", type Property::STRING.
- Since:
- 3.0, DALi version 1.0.0
PLACEHOLDER_TEXT The text to display when the TextField is empty and inactive.
Name "placeholderText", type Property::STRING.
- Since:
- 3.0, DALi version 1.0.0
PLACEHOLDER_TEXT_FOCUSED The text to display when the TextField is empty with key-input focus.
Name "placeholderTextFocused", type Property::STRING.
- Since:
- 3.0, DALi version 1.0.0
FONT_FAMILY The requested font family.
Name "fontFamily", type Property::STRING.
- Since:
- 3.0, DALi version 1.0.0
FONT_STYLE The requested font style.
Name "fontStyle", type Property::STRING or Property::MAP.
- Since:
- 4.0, DALi version 1.2.13
POINT_SIZE The size of font in points.
Name "pointSize", type Property::FLOAT. (Conversion from Pixel size to Point size : Point size = Pixel size * 72 / DPI).
- Since:
- 3.0, DALi version 1.0.0
MAX_LENGTH The maximum number of characters that can be inserted.
Name "maxLength", type Property::INTEGER.
- Since:
- 3.0, DALi version 1.0.0
EXCEED_POLICY Specifies how the text is truncated when it does not fit.
Name "exceedPolicy", type Property::INTEGER.
- Since:
- 3.0, DALi version 1.0.0
HORIZONTAL_ALIGNMENT The line horizontal alignment.
Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER) Values "BEGIN", "CENTER", "END".
- Note:
- Return type is Property::STRING
- Since:
- 3.0, DALi version 1.0.0
VERTICAL_ALIGNMENT The line vertical alignment.
Name "verticalAlignment", type Property::STRING type VerticalAlignment::Type (Property::INTEGER) Values "TOP", "CENTER", "BOTTOM".
- Note:
- Return type is Property::STRING
- Since:
- 3.0, DALi version 1.0.0
TEXT_COLOR The text color.
Name "textColor", type Property::VECTOR4.
- Since:
- 3.0, DALi version 1.0.0
PLACEHOLDER_TEXT_COLOR The placeholder-text color.
Name "placeholderTextColor", type Property::VECTOR4.
- Since:
- 3.0, DALi version 1.0.0
SHADOW_OFFSET The drop shadow offset 0 indicates no shadow.
- Deprecated:
- Deprecated since 3.0, DALi version 1.1.37 Use SHADOW instead.
Name "shadowOffset", type Property::VECTOR2.
- Since:
- 3.0, DALi version 1.0.0
SHADOW_COLOR The color of a drop shadow.
- Deprecated:
- Deprecated since 3.0, DALi version 1.1.37 Use SHADOW instead.
Name "shadowColor", type Property::VECTOR4.
- Since:
- 3.0, DALi version 1.0.0
PRIMARY_CURSOR_COLOR The color to apply to the primary cursor.
Name "primaryCursorColor", type Property::VECTOR4.
- Since:
- 3.0, DALi version 1.0.0
SECONDARY_CURSOR_COLOR The color to apply to the secondary cursor.
Name "secondaryCursorColor", type Property::VECTOR4.
- Since:
- 3.0, DALi version 1.0.0
ENABLE_CURSOR_BLINK Whether the cursor should blink or not.
Name "enableCursorBlink", type Property::BOOLEAN.
- Since:
- 3.0, DALi version 1.0.0
CURSOR_BLINK_INTERVAL The time interval in seconds between cursor on/off states.
Name "cursorBlinkInterval", type Property::FLOAT.
- Since:
- 3.0, DALi version 1.0.0
CURSOR_BLINK_DURATION The cursor will stop blinking after this number of seconds (if non-zero)
Name "cursorBlinkDuration", type Property::FLOAT.
- Since:
- 3.0, DALi version 1.0.0
CURSOR_WIDTH The cursor width.
Name "cursorWidth", type Property::INTEGER.
- Since:
- 3.0, DALi version 1.0.0
GRAB_HANDLE_IMAGE The image to display for the grab handle.
Name "grabHandleImage", type Property::STRING.
- Since:
- 3.0, DALi version 1.0.0
GRAB_HANDLE_PRESSED_IMAGE The image to display when the grab handle is pressed.
Name "grabHandlePressedImage", type Property::STRING.
- Since:
- 3.0, DALi version 1.0.0
SCROLL_THRESHOLD Horizontal scrolling will occur if the cursor is this close to the control border.
Name "scrollThreshold", type Property::FLOAT.
- Since:
- 3.0, DALi version 1.0.0
SCROLL_SPEED The scroll speed in pixels per second.
Name "scrollSpeed", type Property::FLOAT.
- Since:
- 3.0, DALi version 1.0.0
SELECTION_HANDLE_IMAGE_LEFT The image to display for the left selection handle.
Name "selectionHandleImageLeft", type Property::MAP.
- Since:
- 3.0, DALi version 1.0.0
SELECTION_HANDLE_IMAGE_RIGHT The image to display for the right selection handle.
Name "selectionHandleImageRight", type Property::MAP.
- Since:
- 3.0, DALi version 1.0.0
SELECTION_HANDLE_PRESSED_IMAGE_LEFT The image to display when the left selection handle is pressed.
Name "selectionHandlePressedImageLeft", type Property::MAP.
- Since:
- 3.0, DALi version 1.0.0
SELECTION_HANDLE_PRESSED_IMAGE_RIGHT The image to display when the right selection handle is pressed.
Name "selectionHandlePressedImageRight", type Property::MAP.
- Since:
- 3.0, DALi version 1.0.0
SELECTION_HANDLE_MARKER_IMAGE_LEFT The image to display for the left selection handle marker.
Name "selectionHandleMarkerImageLeft", type Property::MAP.
- Since:
- 3.0, DALi version 1.0.0
SELECTION_HANDLE_MARKER_IMAGE_RIGHT The image to display for the right selection handle marker.
Name "selectionHandleMarkerImageRight", type Property::MAP.
- Since:
- 3.0, DALi version 1.0.0
SELECTION_HIGHLIGHT_COLOR The color of the selection highlight.
Name "selectionHighlightColor", type Property::VECTOR4.
- Since:
- 3.0, DALi version 1.0.0
DECORATION_BOUNDING_BOX The decorations (handles etc) will positioned within this area on-screen.
Name "decorationBoundingBox", type Property::RECTANGLE.
- Since:
- 3.0, DALi version 1.0.0
INPUT_METHOD_SETTINGS The settings to relating to the System's Input Method, Key and Value.
Name "inputMethodSettings", type Property::MAP.
- Since:
- 3.0, DALi version 1.0.0
INPUT_COLOR The color of the new input text.
Name "inputColor", type Property::VECTOR4.
- Since:
- 3.0, DALi version 1.0.0
ENABLE_MARKUP Whether the mark-up processing is enabled.
Name "enableMarkup", type Property::BOOLEAN.
- Since:
- 3.0, DALi version 1.0.0
INPUT_FONT_FAMILY The font's family of the new input text.
Name "inputFontFamily", type Property::STRING.
- Since:
- 3.0, DALi version 1.0.0
INPUT_FONT_STYLE The font's style of the new input text.
Name "inputFontStyle", type Property::MAP.
- Since:
- 4.0, DALi version 1.2.13
INPUT_POINT_SIZE The font's size of the new input text in points.
Name "inputPointSize", type Property::FLOAT.
- Since:
- 3.0, DALi version 1.0.0
UNDERLINE The default underline parameters.
Name "underline", type Property::MAP.
The underline map contains the following keys:
| Property Name | Type | Required | Description | |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------| | enable | BOOLEAN | No | True to enable the underline or false to disable (the default value is false) | | color | VECTOR4 | No | The color of the underline (the default value is Color::BLACK) | | height | FLOAT | No | The height of the underline (the default value is 0) |
- Since:
- 4.0, DALi version 1.2.13
INPUT_UNDERLINE The underline parameters of the new input text.
Name "inputUnderline", type Property::MAP.
- Since:
- 4.0, DALi version 1.2.13
SHADOW The default shadow parameters.
Name "shadow", type Property::MAP.
The shadow map contains the following keys:
| Property Name | Type | Required | Description | |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------| | color | VECTOR4 | No | The color of the shadow (the default value is Color::BLACK) | | offset | VECTOR2 | No | The offset from the text to draw the shadow in the X and Y axes (the default value is 0 which means no shadow) | | blurRadius | FLOAT | No | The radius of blur to be applied to the shadow (the default value is 0 which means no blur) |
- Since:
- 4.0, DALi version 1.2.13
INPUT_SHADOW The shadow parameters of the new input text.
Name "inputShadow", type Property::MAP.
- Since:
- 4.0, DALi version 1.2.13
EMBOSS The default emboss parameters.
Name "emboss", type Property::MAP.
- Since:
- 4.0, DALi version 1.2.13
INPUT_EMBOSS The emboss parameters of the new input text.
Name "inputEmboss", type Property::MAP.
- Since:
- 4.0, DALi version 1.2.13
OUTLINE The default outline parameters.
Name "outline", type Property::MAP.
The outline map contains the following keys:
| Property Name | Type | Required | Description | |----------------------|----------|----------|--------------------------------------------------------------------------------------------------------------------| | color | VECTOR4 | No | The color of the outline (the default value is Color::WHITE) | | width | INTEGER | No | The width of the outline (the default value is 0 which means no outline) |
- Since:
- 4.0, DALi version 1.2.13
INPUT_OUTLINE The outline parameters of the new input text.
Name "inputOutline", type Property::MAP.
- Since:
- 4.0, DALi version 1.2.13
HIDDEN_INPUT_SETTINGS Hides the input characters and instead shows a default character for password or pin entry.
Name "hiddenInputSettings", type Property::MAP.
- Since:
- 4.0, DALi version 1.2.60
- Note:
- Optional.
- See also:
- HiddenInput::Property
PIXEL_SIZE The size of font in pixels.
Name "pixelSize", type Property::FLOAT. Conversion from Point size to Pixel size: Pixel size = Point size * DPI / 72
- Since:
- 4.0, DALi version 1.2.60
ENABLE_SELECTION Enables Text selection, such as the cursor, handle, clipboard, and highlight color.
Name "enableSelection", type Property::BOOLEAN.
- Since:
- 4.0, DALi version 1.2.60
PLACEHOLDER Sets the placeholder : text, color, font family, font style, point size, and pixel size.
Name "placeholder", type Property::MAP. Example Usage:
Property::Map propertyMap; propertyMap[ Text::PlaceHolder::Property::TEXT ] = "Setting Placeholder Text"; propertyMap[ Text::PlaceHolder::Property::TEXT_FOCUSED] = "Setting Placeholder Text Focused"; propertyMap[ Text::PlaceHolder::Property::COLOR] = Color::RED; propertyMap[ Text::PlaceHolder::Property::FONT_FAMILY ] = "Arial"; propertyMap[ Text::PlaceHolder::Property::POINT_SIZE ] = 12.0f; propertyMap[ Text::PlaceHolder::Property::ELLIPSIS ] = true; Property::Map fontStyleMap; fontStyleMap.Insert( "weight", "bold" ); fontStyleMap.Insert( "width", "condensed" ); fontStyleMap.Insert( "slant", "italic" ); propertyMap[ Text::PlaceHolder::Property::FONT_STYLE] = fontStyleMap; field.SetProperty( TextField::Property::PLACEHOLDER, propertyMap );
- Since:
- 4.0, DALi version 1.2.60
ELLIPSIS Whether we should show the ellipsis if it is required.
Name "ellipsis", type Property::BOOLEAN.
- Since:
- 4.0, DALi version 1.2.60
- Note:
- PLACEHOLDER map is used to add ellipsis to placeholder text.