Tizen Native API  4.0
Dali::Toolkit::TextLabel::Property Struct Reference

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

Public Types

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

Detailed Description

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

Since:
3.0, DALi version 1.0.0

Member Enumeration Documentation

anonymous enum

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

Since:
3.0, DALi version 1.0.0
Enumerator:
RENDERING_BACKEND 

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

Deprecated:
Deprecated since 4.0, DALi version 1.2.53 No longer be supported and will be ignored.

Name "renderingBackend", type Property::INT.

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
FONT_FAMILY 

The requested font family to use.

Name "fontFamily", type Property::STRING.

Since:
3.0, DALi version 1.0.0
FONT_STYLE 

The requested font style to use.

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
MULTI_LINE 

The single-line or multi-line layout option.

Name "multiLine", type Property::BOOLEAN.

Since:
3.0, DALi version 1.0.0
Note:
Default is false.
HORIZONTAL_ALIGNMENT 

The line horizontal alignment.

Name "horizontalAlignment", type Property::STRING or type HorizontalAlignment::Type (Property::INTEGER) Values "BEGIN", "CENTER", "END", default BEGIN.

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 or type VerticalAlignment::Type (Property::INTEGER). Values "TOP", "CENTER", "BOTTOM"

Since:
3.0, DALi version 1.0.0, default TOP.
Note:
Return type is Property::STRING
Since:
3.0, DALi version 1.0.0
UNUSED_PROPERTY_TEXT_COLOR 

The color of the text.

Deprecated:
Deprecated since 4.0, DALi version 1.2.60 Use the new enum value of TEXT_COLOR instead.

Name "unusedPropertyTextColor", 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.

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

UNDERLINE_ENABLED 

The underline enabled flag.

Deprecated:
Deprecated since 3.0, DALi version 1.1.37 Use UNDERLINE instead

Name "underlineEnabled", type Property::BOOLEAN.

UNDERLINE_COLOR 

The color of the underline.

Deprecated:
Deprecated since 3.0, DALi version 1.1.37 Use UNDERLINE instead

Name "underlineColor", type Property::VECTOR4.

UNDERLINE_HEIGHT 

Overrides the underline height from font metrics.

Deprecated:
Deprecated since 3.0, DALi version 1.1.37 Use UNDERLINE instead

Name "underlineHeight", type Property::FLOAT.

ENABLE_MARKUP 

Whether the mark-up processing is enabled.

Name "enableMarkup", type Property::BOOLEAN.

Since:
3.0, DALi version 1.0.0
Note:
Default is false.
ENABLE_AUTO_SCROLL 

Starts or stops auto scrolling.

Name "enableAutoScroll", type Property::BOOLEAN.

Since:
3.0, DALi version 1.1.35
Note:
Default is false.
AUTO_SCROLL_SPEED 

Sets the speed of scrolling in pixels per second.

Name "autoScrollSpeed", type Property::INT.

Since:
3.0, DALi version 1.1.35
Note:
Default in style sheet.
AUTO_SCROLL_LOOP_COUNT 

Number of complete loops when scrolling enabled.

Name "autoScrollLoopCount", type Property::INT.

Since:
3.0, DALi version 1.1.35
Note:
Default in style sheet.
AUTO_SCROLL_GAP 

Gap before scrolling wraps.

Name "autoScrollGap", type Property::INT.

Since:
3.0, DALi version 1.1.35
Note:
Default in style sheet but can be overridden to prevent same text being shown at start and end.
Displayed gap size is not guaranteed if the text length plus gap exceeds the maximum texture size (i.e. GL_MAX_TEXTURE_SIZE).
LINE_SPACING 

The default extra space between lines in points.

Name "lineSpacing", type Property::FLOAT.

Since:
3.0, DALi version 1.1.37
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
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
EMBOSS 

The default emboss parameters.

Name "emboss", 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
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
ELLIPSIS 

Whether we should show the ellipsis if required.

Name "ellipsis", type Property::BOOLEAN.

Since:
4.0, DALi version 1.2.60
AUTO_SCROLL_LOOP_DELAY 

The amount of time to delay the starting time of auto scrolling and further loops.

Name "autoScrollLoopDelay", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
AUTO_SCROLL_STOP_MODE 

The auto scrolling stop behaviour.

Name "autoScrollStopMode", type AutoScrollStopMode::Type (Property::INTEGER) or Property::STRING.

Since:
4.0, DALi version 1.2.60
Note:
Default is AutoScrollStopMode::FINISH_LOOP.
See also:
AutoScrollStopMode::Type
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.
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
TEXT_COLOR 

The color of the text.

Name "textColor", type Property::VECTOR4.

Since:
4.0, DALi version 1.2.60
TEXT_COLOR_RED 

The red component of the text color.

Name "textColorRed", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
See also:
TEXT_COLOR
TEXT_COLOR_GREEN 

The green component of the text color.

Name "textColorGreen", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
See also:
TEXT_COLOR
TEXT_COLOR_BLUE 

The blue component of the text color.

Name "textColorBlue", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
See also:
TEXT_COLOR
TEXT_COLOR_ALPHA 

The alpha component of the text color.

Name "textColorAlpha", type Property::FLOAT.

Since:
4.0, DALi version 1.2.60
See also:
TEXT_COLOR