Tizen Native API  6.0
Dali::Toolkit::Text::PlaceHolder::Property Namespace Reference

Placeholder text Properties used by Text controls to show placeholder. More...

Enumerations

enum  Setting
 The configurable settings for the Placeholder text. More...

Detailed Description

Placeholder text Properties used by Text controls to show placeholder.

Since:
4.0, DALi version 1.2.62

Enumeration Type Documentation

The configurable settings for the Placeholder text.

Since:
4.0, DALi version 1.2.62
Enumerator:
TEXT 

The text to display as a placeholder.

Name "text", type Property::STRING.

Note:
Optional. If not provided then no placeholder text will be shown whilst control not focused.
Since:
4.0, DALi version 1.2.62
TEXT_FOCUSED 

The text to display as placeholder when focused.

Name "textFocused", type Property::STRING.

Note:
Optional. If not provided then no placeholder text will be shown when focused.
Since:
4.0, DALi version 1.2.62
COLOR 

The colour of the placeholder text.

Name "color", type Property::VECTOR4.

Note:
If color not provided then 80% white will be used.
Since:
4.0, DALi version 1.2.62
FONT_FAMILY 

The font family to be used for placeholder text.

Name "fontFamily", type Property::STRING.

Note:
Optional. Default font family used if not provided.
Since:
4.0, DALi version 1.2.62
FONT_STYLE 

The font style to be used for placeholder text.

Name "fontStyle", type Property::MAP.

Example usage:

   Property::Map fontStylePropertyMap;
   fontStylePropertyMap.Insert( "weight", "bold" );
   fontStylePropertyMap.Insert( "width", "condensed" );
   fontStylePropertyMap.Insert( "slant", "italic" );
   ...
   placeholderPropertyMap[ Text::PlaceHolder::Property::FONT_STYLE] = fontStylePropertyMap;
Note:
Optional. Default font style used if not provided.
Since:
4.0, DALi version 1.2.62
POINT_SIZE 

The font point size to be used.

Name "pointSize", type Property::FLOAT.

Note:
Optional. Not required if PIXEL_SIZE provided. If neither provided then the text control point size is used.
Since:
4.0, DALi version 1.2.62
PIXEL_SIZE 

The font size in pixels to be used.

Name "pixelSize", type Property::FLOAT.

Note:
Optional. Not required if POINT_SIZE provided. If neither provided then the text control point size is used.
Since:
4.0, DALi version 1.2.62
ELLIPSIS 

If ellipsis should be used when placeholder is too long.

Name "ellipsis", type Property::BOOLEAN

Note:
Optional. Default is false.
Since:
4.0, DALi version 1.2.62