Unigine::WidgetEditLine Class

WidgetEditLine Class

Members

---

static WidgetEditLinePtr create ( const Ptr<Gui> & gui, const char * str = 0 )

Constructor. Creates a text field.

Arguments

• const Ptr<Gui> & gui - GUI, to which the text field will belong.
• const char * str - Initial value. This is an optional parameter.

Ptr<WidgetEditLine> cast( const Ptr<Widget> & widget )

Casts a WidgetEditLine out of the Widget instance.

Arguments

• const Ptr<Widget> & widget - Pointer to Widget.

Return value

Pointer to WidgetEditLine.

void setBackground( int background )

Sets a value indicating if a background texture should be rendered for the text field. The default is 1.

Arguments

• int background - Positive number to render a background texture, 0 not to render.

int getBackground( )

Returns a value indicating if a background texture is rendered for the text field.

Return value

Positive number if a background texture is rendered; otherwise, 0. The default is 1.

void setCapacity( int capacity )

Sets a maximum length of a string entered into the text field. The default is 1024.

Arguments

• int capacity - Maximum number of characters.

int getCapacity( )

Returns the maximum length of a string entered into the text field.

Return value

Maximum number of characters. The default is 1024.

void setCursor( int cursor )

Sets a cursor position in the text field.

Arguments

• int cursor - Cursor position. The provided value will be saturated in the range from 0 to text field capacity.

int getCursor( )

Returns the current cursor position in the text field.

Return value

Cursor position.

void setEditable( int editable )

Sets a value indicating if the contents of the text field can be edited. The default is 1.

Arguments

• int editable - Positive number to make the text field editable, 0 to make it read-only.

int isEditable( )

Returns a value indicating if the contents of the text field can be edited. The default is 1.

Return value

Positive number if the text field contents can be edited; otherwise, 0.

void setPassword( int password )

Turns the widget into a generic text field or into a password field. The default is 0.

Arguments

• int password - Positive number to make the widget a password field, 0 to make it a generic text field.

int isPassword( )

Returns a value indicating if the text field is a password field (all entered characters show up as dots).

Return value

Positive number if the widget is a password field; otherwise, 0. The default is 0.

void setSelection( int selection )

Sets a position, from which a new selection will start.

Arguments

• int selection - Position, from which the selection will start.

int getSelection( )

Returns a position, from which the selection starts.

Return value

Position, from which the selection starts.

String getSelectionText( )

Returns currently selected text.

Return value

Currently selected text.

void setText( const char * text )

Sets a text for the text field.

Arguments

• const char * text - Text string.

const char * getText( )

Returns the current contents of the text field.

Return value

Text string.

void setValidator( int validator )

Sets a validator for the text filed contents.

Arguments

• int validator - One of the Gui:: Enumeration with VALIDATOR_* prefixes.

int getValidator( )

Returns the validator associated with the text field. The default is VALIDATOR_ANY.

Return value

One of the Gui:: Enumeration with VALIDATOR_* prefixes.

void clearSelectionText( )

Deletes currently selected text.

int type( )

WidgetEditLine type.

Return value

WidgetEditLine type identifier.