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

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  Property
 An enumeration of properties belonging to the TextLabel class. More...

Public Types

enum  PropertyRange
 The start and end property ranges for this control. More...
enum  ExceedPolicy
 Specifies 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.

Public Member Functions

 TextField ()
 Creates an empty handle.
 TextField (const TextField &handle)
 Copy constructor.
TextField & operator= (const TextField &handle)
 Assignment operator.
 ~TextField ()
 Destructor.
TextChangedSignalType & TextChangedSignal ()
 This signal is emitted when the text changes.
MaxLengthReachedSignalType & MaxLengthReachedSignal ()
 This signal is emitted when inserted text exceeds the maximum character limit.
 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 ()
 Create the TextField control.
static TextField DownCast (BaseHandle handle)
 Downcast a handle to TextField handle.

Detailed Description

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

Since :
2.4

Member Typedef Documentation

typedef Signal<void ( TextField ) > Dali::Toolkit::TextField::MaxLengthReachedSignalType

Max characters exceed signal type.

Since :
2.4
typedef Signal<void ( TextField ) > Dali::Toolkit::TextField::TextChangedSignalType

Text changed signal type.

Since :
2.4

Member Enumeration Documentation

enum Dali::Toolkit::TextField::ExceedPolicy

Specifies how the text is truncated when it does not fit.

The default value is EXCEED_POLICY_CLIP.

Since :
2.4
Enumerator:
EXCEED_POLICY_ORIGINAL 

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

Since :
2.4
EXCEED_POLICY_CLIP 

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

Since :
2.4
enum Dali::Toolkit::TextField::PropertyRange

The start and end property ranges for this control.

Since :
2.4
Enumerator:
PROPERTY_END_INDEX 

Reserve property indices.

Since :
2.4

Reimplemented from Dali::Toolkit::Control.

Constructor & Destructor Documentation

Dali::Toolkit::TextField::TextField ( )

Creates an empty handle.

Since :
2.4
Dali::Toolkit::TextField::TextField ( const TextField &  handle)

Copy constructor.

Since :
2.4
Parameters:
[in]handleThe handle to copy from.
Dali::Toolkit::TextField::~TextField ( )

Destructor.

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

Since :
2.4
Dali::Toolkit::TextField::TextField ( Internal::TextField &  implementation)

Creates a handle using the Toolkit::Internal implementation.

Since :
2.4
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 :
2.4
Parameters:
[in]internalA pointer to the internal CustomActor.

Member Function Documentation

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

Downcast a handle to TextField handle.

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

Since :
2.4
Parameters:
[in]handleHandle to an object
Returns:
handle to a TextField or an empty handle

Reimplemented from Dali::Toolkit::Control.

MaxLengthReachedSignalType& Dali::Toolkit::TextField::MaxLengthReachedSignal ( )

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 :
2.4
Returns:
The signal to connect to.
static TextField Dali::Toolkit::TextField::New ( ) [static]

Create the TextField control.

Since :
2.4
Returns:
A handle to the TextField control.

Reimplemented from Dali::Toolkit::Control.

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

Assignment operator.

Since :
2.4
Parameters:
[in]handleThe handle to copy from.
Returns:
A reference to this.
TextChangedSignalType& Dali::Toolkit::TextField::TextChangedSignal ( )

This signal is emitted when the text changes.

A callback of the following type may be connected: 

   void YourCallbackName( TextField textField );
Since :
2.4
Returns:
The signal to connect to.