Dali::Toolkit::TextEditor Class Reference

A control which provides a multi-line editable text editor. More...

Inheritance diagram for Dali::Toolkit::TextEditor:

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 TextEditor class. More...
struct	Scroll
	Enumerations for the type of scrolling. More...
Public Types
enum	PropertyRange
	Enumeration for the start and end property ranges for this control. More...
typedef Signal< void(TextEditor) >	TextChangedSignalType
	Text changed signal type.
typedef Signal< void(TextEditor, InputStyle::Mask) >	InputStyleChangedSignalType
	Input Style changed signal type.
typedef Signal< void(TextEditor, Scroll::Type) >	ScrollStateChangedSignalType
	Scroll state changed signal type.
Public Member Functions
	TextEditor ()
	Creates an empty handle.
	TextEditor (const TextEditor &handle)
	Copy constructor.
TextEditor &	operator= (const TextEditor &handle)
	Assignment operator.
	~TextEditor ()
	Destructor.
TextChangedSignalType &	TextChangedSignal ()
	This signal is emitted when the text changes.
InputStyleChangedSignalType &	InputStyleChangedSignal ()
	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.
ScrollStateChangedSignalType &	ScrollStateChangedSignal ()
	This signal is emitted when TextEditor scrolling is started or finished.
Static Public Member Functions
static TextEditor	New ()
	Creates the TextEditor control.
static TextEditor	DownCast (BaseHandle handle)
	Downcasts a handle to TextEditor.

---

Detailed Description

A control which provides a multi-line editable text editor.

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

Since:

3.0, DALi version 1.1.37 | | inputStyleChanged | InputStyleChangedSignal() |

Since:

3.0, DALi version 1.2.2 |

---

Member Typedef Documentation

typedef Signal<void ( TextEditor, InputStyle::Mask ) > Dali::Toolkit::TextEditor::InputStyleChangedSignalType

Input Style changed signal type.

Since:

3.0, DALi version 1.2.2

typedef Signal< void ( TextEditor, Scroll::Type ) > Dali::Toolkit::TextEditor::ScrollStateChangedSignalType

Scroll state changed signal type.

Since:

4.0, DALi version 1.2.60

typedef Signal<void ( TextEditor ) > Dali::Toolkit::TextEditor::TextChangedSignalType

Text changed signal type.

Since:

3.0, DALi version 1.1.37

---

Member Enumeration Documentation

enum Dali::Toolkit::TextEditor::PropertyRange

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

Since:

3.0, DALi version 1.1.37

Enumerator:

PROPERTY_END_INDEX

Reserve property indices.

Reimplemented from Dali::Toolkit::Control.

---

Constructor & Destructor Documentation

Dali::Toolkit::TextEditor::TextEditor

(

)

Creates an empty handle.

Since:

3.0, DALi version 1.1.37

Dali::Toolkit::TextEditor::TextEditor

(

const TextEditor &

handle

)

Copy constructor.

Since:

3.0, DALi version 1.1.37

Parameters:

[in]

handle

The handle to copy from

Dali::Toolkit::TextEditor::~TextEditor

(

)

Destructor.

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

Since:

3.0, DALi version 1.1.37

---

Member Function Documentation

static TextEditor Dali::Toolkit::TextEditor::DownCast

(

BaseHandle

handle

)

[static]

Downcasts a handle to TextEditor.

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

Since:

3.0, DALi version 1.1.37

Parameters:

[in]

handle

Handle to an object

Returns:

Handle to a TextEditor or an empty handle

Reimplemented from Dali::Toolkit::Control.

InputStyleChangedSignalType& Dali::Toolkit::TextEditor::InputStyleChangedSignal

(

)

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( TextEditor textEditor, TextEditor::InputStyle::Mask mask );

Since:

3.0, DALi version 1.2.2

Returns:

The signal to connect to

static TextEditor Dali::Toolkit::TextEditor::New

(

)

[static]

Creates the TextEditor control.

Since:

3.0, DALi version 1.1.37

Returns:

A handle to the TextEditor control

Reimplemented from Dali::Toolkit::Control.

TextEditor& Dali::Toolkit::TextEditor::operator=

(

const TextEditor &

handle

)

Assignment operator.

Since:

3.0, DALi version 1.1.37

Parameters:

[in]

handle

The handle to copy from

Returns:

A reference to this

ScrollStateChangedSignalType& Dali::Toolkit::TextEditor::ScrollStateChangedSignal

(

)

This signal is emitted when TextEditor scrolling is started or finished.

A callback of the following type may be connected:

   void YourCallbackName( Scroll::Type type );

type: Whether the scrolling is started or finished.

Since:

4.0, DALi version 1.2.60

Returns:

The signal to connect to

TextChangedSignalType& Dali::Toolkit::TextEditor::TextChangedSignal

(

)

This signal is emitted when the text changes.

A callback of the following type may be connected:

   void YourCallbackName( TextEditor textEditor );

Since:

3.0, DALi version 1.1.37

Returns:

The signal to connect to