class_lineedit

Important: This wiki is soon going to be taken down, as the official documentation of the Godot project is now on http://docs.godotengine.org.

LineEdit

####Inherits: Control ####Category: Core

Brief Description

Control that provides single line string editing.

Member Functions

• void clear ( )
• void select_all ( )
• void set_text ( String text )
• String get_text ( ) const
• void set_cursor_pos ( int pos )
• int get_cursor_pos ( ) const
• void set_max_length ( int chars )
• int get_max_length ( ) const
• void append_at_cursor ( String text )
• void set_editable ( bool enabled )
• bool is_editable ( ) const
• void set_secret ( bool enabled )
• bool is_secret ( ) const
• void select ( int from=0, int to=-1 )

Signals

• text_entered ( String text )
• text_changed ( String text )

Description

LineEdit provides a single line string editor, used for text fields.

Member Function Description

clear

• void clear ( )

Clear the LineEdit text.

select_all

• void select_all ( )

Select the whole string.

set_text

• void set_text ( String text )

Set the text in the LineEdit, clearing the existing one and the selection.

get_text

• String get_text ( ) const

Return the text in the LineEdit.

set_cursor_pos

• void set_cursor_pos ( int pos )

Set the cursor position inside the LineEdit, causing it to scroll if needed.

get_cursor_pos

• int get_cursor_pos ( ) const

Return the cursor position inside the LineEdit.

set_max_length

• void set_max_length ( int chars )

Set the maximum amount of characters the LineEdit can edit, and cropping existing text in case it exceeds that limit. Setting 0 removes the limit.

get_max_length

• int get_max_length ( ) const

Return the maximum amount of characters the LineEdit can edit. If 0 is returned, no limit exists.

append_at_cursor

• void append_at_cursor ( String text )

Append text at cursor, scrolling the LineEdit when needed.

set_editable

• void set_editable ( bool enabled )

Set the editable status of the LineEdit. When disabled, existing text can"apos;t be modified and new text can"apos;t be added.

is_editable

• bool is_editable ( ) const

Return the editable status of the LineEdit (see set_editable).

set_secret

• void set_secret ( bool enabled )

Set the secret status of the LineEdit. When enabled, every character is displayed as "*".

is_secret

• bool is_secret ( ) const

Return the secret status of the LineEdit (see set_secret).