Tizen Native API  6.5
Dali::Toolkit::TextField Class Reference

A control which provides a single-line editable text field. More...

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

Classes

struct  InputStyle
 Mask used by the signal InputStyleChangedSignal(). Notifies which parameters of the input style have changed. More...
struct  Property
 Enumeration for the instance of properties belonging to the TextField class. More...

Public Types

enum  PropertyRange
 The start and end property ranges for this control. More...
enum  ExceedPolicy
 Enumeration for specifying how the text is truncated when it does not fit. More...
typedef Signal< void(TextField) > TextChangedSignalType
 Text changed signal type.
typedef Signal< void(TextField) > MaxLengthReachedSignalType
 Max Characters Exceed signal type.
typedef Signal< void(TextField,
InputStyle::Mask) > 
InputStyleChangedSignalType
 Input Style changed signal type.

Public Member Functions

 TextField ()
 Creates an empty handle.
 TextField (const TextField &handle)
 Copy constructor.
TextFieldoperator= (const TextField &handle)
 Assignment operator.
 ~TextField ()
 Destructor.
TextChangedSignalTypeTextChangedSignal ()
 This signal is emitted when the text changes.
MaxLengthReachedSignalTypeMaxLengthReachedSignal ()
 This signal is emitted when inserted text exceeds the maximum character limit.
InputStyleChangedSignalTypeInputStyleChangedSignal ()
 This signal is emitted when the input style is updated as a consequence of a change in the cursor position. i.e. The signal is not emitted when the input style is updated through the property system.
 TextField (Internal::TextField &implementation)
 Creates a handle using the Toolkit::Internal implementation.
 TextField (Dali::Internal::CustomActor *internal)
 Allows the creation of this Control from an Internal::CustomActor pointer.

Static Public Member Functions

static TextField New ()
 Creates the TextField control.
static TextField DownCast (BaseHandle handle)
 Downcasts a handle to TextField.

Detailed Description

A control which provides a single-line editable text field.

Signals | Signal Name | Method | | |----------------------|--------------------------------|--------------------| | textChanged | TextChangedSignal() |

Since:
3.0, DALi version 1.0.0 | | maxLengthReached | MaxLengthReachedSignal() |
Since:
3.0, DALi version 1.0.0 | | inputStyleChanged | InputStyleChangedSignal() |
Since:
3.0, DALi version 1.2.2 |

Member Typedef Documentation

Input Style changed signal type.

Since:
3.0, DALi version 1.2.2

Max Characters Exceed signal type.

Since:
3.0, DALi version 1.0.0

Text changed signal type.

Since:
3.0, DALi version 1.0.0

Member Enumeration Documentation

Enumeration for specifying how the text is truncated when it does not fit.

The default value is EXCEED_POLICY_CLIP.

Since:
3.0, DALi version 1.0.0
Enumerator:
EXCEED_POLICY_ORIGINAL 

The text will be display at original size, and may exceed the TextField boundary.

Since:
3.0, DALi version 1.0.0
EXCEED_POLICY_CLIP 

The end of text will be clipped to fit within the TextField.

Since:
3.0, DALi version 1.0.0

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

Reimplemented from Dali::Toolkit::Control.


Constructor & Destructor Documentation

Creates an empty handle.

Since:
3.0, DALi version 1.0.0

Copy constructor.

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

Destructor.

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

Since:
3.0, DALi version 1.0.0
Dali::Toolkit::TextField::TextField ( Internal::TextField &  implementation)

Creates a handle using the Toolkit::Internal implementation.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]implementationThe Control implementation
Dali::Toolkit::TextField::TextField ( Dali::Internal::CustomActor *  internal) [explicit]

Allows the creation of this Control from an Internal::CustomActor pointer.

Since:
3.0, DALi version 1.0.0
Parameters:
[in]internalA pointer to the internal CustomActor

Member Function Documentation

Downcasts a handle to TextField.

If the BaseHandle points is a TextField, 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 TextField or an empty handle

Reimplemented from Dali::Toolkit::Control.

This signal is emitted when the input style is updated as a consequence of a change in the cursor position. i.e. The signal is not emitted when the input style is updated through the property system.

A callback of the following type may be connected. The mask parameter notifies which parts of the style have changed.

   void YourCallbackName( TextField textField, TextField::InputStyle::Mask mask );
Since:
3.0, DALi version 1.2.2
Returns:
The signal to connect to

This signal is emitted when inserted text exceeds the maximum character limit.

A callback of the following type may be connected:

   void YourCallbackName( TextField textField );
Since:
3.0, DALi version 1.0.0
Returns:
The signal to connect to

Creates the TextField control.

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

Reimplemented from Dali::Toolkit::Control.

TextField& Dali::Toolkit::TextField::operator= ( const TextField handle)

Assignment operator.

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

This signal is emitted when the text changes.

A callback of the following type may be connected:

   void YourCallbackName( TextField textField );
Since:
3.0, DALi version 1.0.0
Returns:
The signal to connect to.