Tizen Native API  5.0
Classes | Public Types | Public Member Functions | Static Public Member Functions
Dali::Toolkit::TextLabel Class Reference
Text Controls

A control which renders a short text string. More...

Inheritance diagram for Dali::Toolkit::TextLabel:
Dali::Toolkit::Control Dali::CustomActor Dali::Actor Dali::Handle Dali::BaseHandle

Classes

struct  AutoScrollStopMode
 The enumerations used for auto scroll stop mode. More...
struct  Property
 Enumeration for the instance of properties belonging to the TextLabel class. More...

Public Types

enum  PropertyRange
 Enumeration for the start and end property ranges for this control. More...

Public Member Functions

 TextLabel ()
 Creates an empty handle.
 TextLabel (const TextLabel &handle)
 Copy constructor.
TextLabel & operator= (const TextLabel &handle)
 Assignment operator.
 ~TextLabel ()
 Destructor.

Static Public Member Functions

static TextLabel New ()
 Creates the TextLabel control.
static TextLabel New (const std::string &text)
 Creates the TextLabel control.
static TextLabel DownCast (BaseHandle handle)
 Downcasts a handle to TextLabel.

Detailed Description

A control which renders a short text string.

Text labels are lightweight, non-editable and do not respond to user input.

Properties

|Property enum |String name |Type |Writable|Animatable| |----------------------------------|---------------------|----------------|--------|----------| | Property::RENDERING_BACKEND | renderingBackend | INTEGER | O | X | | Property::TEXT | text | STRING | O | X | | Property::FONT_FAMILY | fontFamily | STRING | O | X | | Property::FONT_STYLE | fontStyle | STRING or MAP | O | X | | Property::POINT_SIZE | pointSize | FLOAT | O | X | | Property::MULTI_LINE | multiLine | BOOLEAN | O | X | | Property::HORIZONTAL_ALIGNMENT | horizontalAlignment | STRING | O | X | | Property::VERTICAL_ALIGNMENT | verticalAlignment | STRING | O | X | | Property::TEXT_COLOR | textColor | VECTOR4 | O | X | | Property::ENABLE_MARKUP | enableMarkup | BOOLEAN | O | X | | Property::ENABLE_AUTO_SCROLL | enableAutoScroll | BOOLEAN | O | X | | Property::AUTO_SCROLL_SPEED | autoScrollSpeed | INTEGER | O | X | | Property::AUTO_SCROLL_LOOP_COUNT | autoScrollLoopCount | INTEGER | O | X | | Property::AUTO_SCROLL_GAP | autoScrollGap | INTEGER | O | X | | Property::SHADOW | shadow | STRING or MAP | O | X | | Property::UNDERLINE | underline | STRING or MAP | O | X |

Since:
3.0, DALi version 1.0.0

Member Enumeration Documentation

enum Dali::Toolkit::TextLabel::PropertyRange

Enumeration for the start and end property ranges for this control.

Since:
3.0, DALi version 1.0.0
Enumerator:
PROPERTY_START_INDEX 
Since:
3.0, DALi version 1.0.0
PROPERTY_END_INDEX 

Reserve property indices.

Since:
3.0, DALi version 1.0.0
ANIMATABLE_PROPERTY_START_INDEX 
Since:
4.0, DALi version 1.2.60
ANIMATABLE_PROPERTY_END_INDEX 

Reserve animatable property indices.

Since:
4.0, DALi version 1.2.60

Reimplemented from Dali::Toolkit::Control.

Constructor & Destructor Documentation

Dali::Toolkit::TextLabel::TextLabel ( )

Creates an empty handle.

Since:
3.0, DALi version 1.0.0
Dali::Toolkit::TextLabel::TextLabel ( const TextLabel &  handle)

Copy constructor.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleThe handle to copy from
Dali::Toolkit::TextLabel::~TextLabel ( )

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since:
3.0, DALi version 1.0.0

Member Function Documentation

static TextLabel Dali::Toolkit::TextLabel::DownCast ( BaseHandle  handle) [static]

Downcasts a handle to TextLabel.

If the BaseHandle points is a TextLabel, the downcast returns a valid handle. If not, the returned handle is left empty.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleHandle to an object
Returns:
Handle to a TextLabel or an empty handle

Reimplemented from Dali::Toolkit::Control.

static TextLabel Dali::Toolkit::TextLabel::New ( ) [static]

Creates the TextLabel control.

Since:
3.0, DALi version 1.0.0
Returns:
A handle to the TextLabel control

Reimplemented from Dali::Toolkit::Control.

static TextLabel Dali::Toolkit::TextLabel::New ( const std::string &  text) [static]

Creates the TextLabel control.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]textThe text to display
Returns:
A handle to the TextLabel control
TextLabel& Dali::Toolkit::TextLabel::operator= ( const TextLabel &  handle)

Assignment operator.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]handleThe handle to copy from
Returns:
A reference to this