LineEdit

Category: Core

Control that provides single-line string editing.

Properties

Methods

void	( String text )
void	( )
void	deselect ( )
	get_menu ( ) const
void	( int option )
void	( int from=0, to=-1 )
void	select_all ( )

	clear
Color	clear_button_color
	clear_button_color_pressed
Color	cursor_color
	focus
Font	font
	font_color
Color	font_color_selected
	minimum_spaces
StyleBox	normal
	read_only
Color	selection_color

Signals

text_changed ( new_text )

Emitted when the text changes.

text_entered ( String new_text )

Emitted when the user presses on the LineEdit.

Enumerations

enum Align:

ALIGN_LEFT = 0 — Aligns the text on the left hand side of the LineEdit.
ALIGN_CENTER = 1 — Centers the text in the middle of the LineEdit.
ALIGN_RIGHT = 2 — Aligns the text on the right hand side of the LineEdit.
ALIGN_FILL = 3 — Stretches whitespaces to fit the LineEdit’s width.

enum MenuItems:

MENU_CUT = 0 — Cuts (copies and clears) the selected text.
MENU_COPY = 1 — Copies the selected text.
MENU_CLEAR = 3 — Erases the whole LineEdit text.
MENU_SELECT_ALL = 4 — Selects the whole LineEdit text.
MENU_UNDO = 5 — Undoes the previous action.
MENU_REDO = 6 — Reverse the last undo action.
MENU_MAX = 7 — Represents the size of the enum.

LineEdit provides a single-line string editor, used for text fields. It features many built-in shortcuts which will always be available:

Ctrl + C: Copy
Ctrl + X: Cut
Ctrl + V or Ctrl + Y: Paste/”yank”
Ctrl + Z: Undo
Ctrl + Shift + Z: Redo
Ctrl + U: Delete text from the cursor position to the beginning of the line
Ctrl + K: Delete text from the cursor position to the end of the line
Ctrl + A: Select all text
Up/Down arrow: Move the cursor to the beginning/end of the line

Property Descriptions

Align align

Setter	set_align(value)
Getter	get_align()

Text alignment as defined in the ALIGN_* enum.

caret_blink

Setter	cursor_set_blink_enabled(value)
Getter	cursor_get_blink_enabled()

If true, the caret (visual cursor) blinks.

float caret_blink_speed

Setter	cursor_set_blink_speed(value)
Getter	cursor_get_blink_speed()

The cursor’s position inside the LineEdit. When set, the text may scroll to accommodate it.

clear_button_enabled

Setter	set_clear_button_enabled(value)
Getter	is_clear_button_enabled()

If true, the LineEdit will show a clear button if is not empty.

bool context_menu_enabled

Setter	set_context_menu_enabled(value)
Getter	is_context_menu_enabled()

If true, the context menu will appear when right clicked.

editable

Setter	set_editable(value)
Getter	is_editable()

If false, existing text cannot be modified and new text cannot be added.

bool expand_to_text_length

Setter	set_expand_to_text_length(value)
Getter	get_expand_to_text_length()

If true, the LineEdit width will increase to stay longer than the . It will not compress if the text is shortened.

focus_mode

Setter	set_focus_mode(value)
Getter	get_focus_mode()

Defines how the LineEdit can grab focus (Keyboard and mouse, only keyboard, or none). See enum FocusMode in Control for details.

max_length

Maximum amount of characters that can be entered inside the LineEdit. If 0, there is no limit.

float placeholder_alpha

Setter	set_placeholder_alpha(value)
Getter	get_placeholder_alpha()

Opacity of the . From 0 to 1.

String placeholder_text

Setter	set_placeholder(value)
Getter	get_placeholder()

Text shown when the LineEdit is empty. It is not the ’s default value (see ).

bool secret

Setter	set_secret(value)
Getter	is_secret()

secret_character

Setter	set_secret_character(value)
Getter	get_secret_character()

The character to use to mask secret input (defaults to “*”). Only a single character can be used as the secret character.

String text

Setter	set_text(value)
Getter	get_text()

String value of the LineEdit.

Method Descriptions

void append_at_cursor ( text )

Adds text after the cursor. If the resulting value is longer than max_length, nothing happens.

void clear ( )

Erases the LineEdit text.

void deselect ( )

Clears the current selection.

get_menu ( ) const

Returns the PopupMenu of this LineEdit. By default, this menu is displayed when right-clicking on the LineEdit.

void menu_option ( option )

Executes a given action as defined in the MENU_* enum.

void select ( int from=0, to=-1 )

Selects characters inside LineEdit between from and to. By default from is at the beginning and to at the end.

Selects the whole String.