Tizen Native API  6.0
Public Types
Dali::Toolkit::TextEditor::Property Struct Reference

Enumeration for the instance of properties belonging to the TextEditor class. More...

Public Types

enum  
 Enumeration for the instance of properties belonging to the TextEditor class. More...

Detailed Description

Enumeration for the instance of properties belonging to the TextEditor class.

Since:
3.0, DALi version 1.1.37

Member Enumeration Documentation

anonymous enum

Enumeration for the instance of properties belonging to the TextEditor class.

Since:
3.0, DALi version 1.1.37
Enumerator:
RENDERING_BACKEND 

The type or rendering e.g. bitmap-based.

Name "renderingBackend", type Property::INTEGER.

Since:
3.0, DALi version 1.1.37
TEXT 

The text to display in UTF-8 format.

Name "text", type Property::STRING.

Since:
3.0, DALi version 1.1.37
TEXT_COLOR 

The text color.

Name "textColor", type Property::VECTOR4.

Since:
3.0, DALi version 1.1.37
FONT_FAMILY 

The requested font family.

Name "fontFamily", type Property::STRING.

Since:
3.0, DALi version 1.1.37
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.1.37
HORIZONTAL_ALIGNMENT 

The text 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.1.37
SCROLL_THRESHOLD 

Vertical scrolling will occur if the cursor is this close to the control border.

Name "scrollThreshold", type Property::FLOAT.

Since:
3.0, DALi version 1.1.37
SCROLL_SPEED 

The scroll speed in pixels per second.

Name "scrollSpeed", type Property::FLOAT.

Since:
3.0, DALi version 1.1.37
PRIMARY_CURSOR_COLOR 

The color to apply to the primary cursor.

Name "primaryCursorColor", type Property::VECTOR4.

Since:
3.0, DALi version 1.1.37
SECONDARY_CURSOR_COLOR 

The color to apply to the secondary cursor.

Name "secondaryCursorColor", type Property::VECTOR4.

Since:
3.0, DALi version 1.1.37
ENABLE_CURSOR_BLINK 

Whether the cursor should blink or not.

Name "enableCursorBlink", type Property::BOOLEAN.

Since:
3.0, DALi version 1.1.37
CURSOR_BLINK_INTERVAL 

The time interval in seconds between cursor on/off states.

Name "cursorBlinkInterval", type Property::FLOAT.

Since:
3.0, DALi version 1.1.37
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.1.37
CURSOR_WIDTH 

The cursor width.

Name "cursorWidth", type Property::INTEGER.

Since:
3.0, DALi version 1.1.37
GRAB_HANDLE_IMAGE 

The image to display for the grab handle.

Name "grabHandleImage", type Property::STRING.

Since:
3.0, DALi version 1.1.37
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.1.37
SELECTION_HANDLE_IMAGE_LEFT 

The image to display for the left selection handle.

Name "selectionHandleImageLeft", type Property::MAP.

Since:
3.0, DALi version 1.1.37
SELECTION_HANDLE_IMAGE_RIGHT 

The image to display for the right selection handle.

Name "selectionHandleImageRight", type Property::MAP.

Since:
3.0, DALi version 1.1.37
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.1.37
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.1.37
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.1.37
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.1.37
SELECTION_HIGHLIGHT_COLOR 

The color of the selection highlight.

Name "selectionHighlightColor", type Property::VECTOR4.

Since:
3.0, DALi version 1.1.37
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.1.37
ENABLE_MARKUP 

Whether the mark-up processing is enabled.

Name "enableMarkup", type Property::BOOLEAN.

Since:
3.0, DALi version 1.1.37
INPUT_COLOR 

The color of the new input text.

Name "inputColor", type Property::VECTOR4.

Since:
3.0, DALi version 1.1.37
INPUT_FONT_FAMILY 

The font's family of the new input text.

Name "inputFontFamily", type Property::STRING.

Since:
3.0, DALi version 1.1.37
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.1.37
LINE_SPACING 

The default extra space between lines in points.

Name "lineSpacing", type Property::FLOAT.

Since:
3.0, DALi version 1.1.37
INPUT_LINE_SPACING 

The extra space between lines in points.

Name "inputLineSpacing", type Property::FLOAT.

Since:
3.0, DALi version 1.1.37
Note:
This affects the whole paragraph where the new input text is inserted.
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
SMOOTH_SCROLL 

Enable or disable the smooth scroll animation.

Name "smoothScroll", type Property::BOOLEAN.

Since:
4.0, DALi version 1.2.60
SMOOTH_SCROLL_DURATION 

Sets the duration of smooth scroll animation.

Name "smoothScrollDuration", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
ENABLE_SCROLL_BAR 

Enable or disable the scroll bar.

Name "enableScrollBar", type Property::BOOLEAN.

Since:
4.0, DALi version 1.2.60
SCROLL_BAR_SHOW_DURATION 

Sets the duration of scroll bar to show.

Name "scrollBarShowDuration", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
SCROLL_BAR_FADE_DURATION 

Sets the duration of scroll bar to fade out.

Name "scrollBarFadeDuration", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
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
LINE_COUNT 

The line count of text.

Name "lineCount", type Property::INTEGER.

Since:
4.0, DALi version 1.2.60
Note:
This property is read-only.
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: 

   Property::Map propertyMap;
   propertyMap["placeholderText"] = "Setting Placeholder Text";
   propertyMap["placeholderTextFocused"] = "Setting Placeholder Text Focused";
   propertyMap["placeholderColor"] = Color::RED;
   propertyMap["placeholderFontFamily"] = "Arial";
   propertyMap["placeholderPointSize"] = 12.0f;

   Property::Map fontStyleMap;
   fontStyleMap.Insert( "weight", "bold" );
   fontStyleMap.Insert( "width", "condensed" );
   fontStyleMap.Insert( "slant", "italic" );
   propertyMap["placeholderFontStyle"] = fontStyleMap;

   editor.SetProperty( TextEditor::Property::PLACEHOLDER, propertyMap );
Since:
4.0, DALi version 1.2.60
LINE_WRAP_MODE 

Line wrap mode when text lines are greater than the layout width.

Name "lineWrapMode", type Text::LineWrap::Mode (Text::Property::INTEGER) or Property::STRING.

Since:
4.0, DALi version 1.2.60
Note:
Default is Text::LineWrap::WORD.
Return type is Text::LineWrap::Mode (Text::Property::INTEGER).
See also:
Text::LineWrap