class_lineedit

LineEdit

Inherits: Control\n\n

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
• bool ** select ** ( ) const

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).