LineEdit¶

Inherits: Control < CanvasItem < Node < Object

Control that provides single-line string editing.

Description¶

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

It features many built-in shortcuts which will always be available (Ctrl here maps to Cmd on macOS):

Ctrl + C: Copy
Ctrl + X: Cut
Ctrl + V or Ctrl + Y: Paste/"yank"
Ctrl + Z: Undo
Ctrl + ~: Swap input direction.
Ctrl + Shift + Z: Redo
Ctrl + U: Delete text from the caret position to the beginning of the line
Ctrl + K: Delete text from the caret position to the end of the line
Ctrl + A: Select all text
Up Arrow/Down Arrow: Move the caret to the beginning/end of the line

On macOS, some extra keyboard shortcuts are available:

Ctrl + F: Same as Right Arrow, move the caret one character right
Ctrl + B: Same as Left Arrow, move the caret one character left
Ctrl + P: Same as Up Arrow, move the caret to the previous line
Ctrl + N: Same as Down Arrow, move the caret to the next line
Ctrl + D: Same as Delete, delete the character on the right side of caret
Ctrl + H: Same as Backspace, delete the character on the left side of the caret
Ctrl + A: Same as Home, move the caret to the beginning of the line
Ctrl + E: Same as End, move the caret to the end of the line
Cmd + Left Arrow: Same as Home, move the caret to the beginning of the line
Cmd + Right Arrow: Same as End, move the caret to the end of the line

Properties¶

HorizontalAlignment	alignment	`0`
bool	caret_blink	`false`
float	caret_blink_interval	`0.65`
int	caret_column	`0`
bool	caret_force_displayed	`false`
bool	caret_mid_grapheme	`true`
bool	clear_button_enabled	`false`
bool	context_menu_enabled	`true`
bool	deselect_on_focus_loss_enabled	`true`
bool	draw_control_chars	`false`
bool	editable	`true`
bool	expand_to_text_length	`false`
bool	flat	`false`
FocusMode	focus_mode	`2` (overrides Control)
String	language	`""`
int	max_length	`0`
bool	middle_mouse_paste_enabled	`true`
CursorShape	mouse_default_cursor_shape	`1` (overrides Control)
String	placeholder_text	`""`
Texture2D	right_icon
bool	secret	`false`
String	secret_character	`"•"`
bool	select_all_on_focus	`false`
bool	selecting_enabled	`true`
bool	shortcut_keys_enabled	`true`
StructuredTextParser	structured_text_bidi_override	`0`
Array	structured_text_bidi_override_options	`[]`
String	text	`""`
TextDirection	text_direction	`0`
bool	virtual_keyboard_enabled	`true`
VirtualKeyboardType	virtual_keyboard_type	`0`

Methods¶

void	clear ( )
void	delete_char_at_caret ( )
void	delete_text ( int from_column, int to_column )
void	deselect ( )
PopupMenu	get_menu ( ) const
float	get_scroll_offset ( ) const
int	get_selection_from_column ( ) const
int	get_selection_to_column ( ) const
bool	has_selection ( ) const
void	insert_text_at_caret ( String text )
bool	is_menu_visible ( ) const
void	menu_option ( int option )
void	select ( int from=0, int to=-1 )
void	select_all ( )

Theme Properties¶

Color	caret_color	`Color(0.95, 0.95, 0.95, 1)`
Color	clear_button_color	`Color(0.875, 0.875, 0.875, 1)`
Color	clear_button_color_pressed	`Color(1, 1, 1, 1)`
Color	font_color	`Color(0.875, 0.875, 0.875, 1)`
Color	font_outline_color	`Color(1, 1, 1, 1)`
Color	font_placeholder_color	`Color(0.875, 0.875, 0.875, 0.6)`
Color	font_selected_color	`Color(1, 1, 1, 1)`
Color	font_uneditable_color	`Color(0.875, 0.875, 0.875, 0.5)`
Color	selection_color	`Color(0.5, 0.5, 0.5, 1)`
int	caret_width	`1`
int	minimum_character_width	`4`
int	outline_size	`0`
Font	font
int	font_size
Texture2D	clear
StyleBox	focus
StyleBox	normal
StyleBox	read_only

Signals¶

text_change_rejected ( String rejected_substring )

Emitted when appending text that overflows the max_length. The appended text is truncated to fit max_length, and the part that couldn't fit is passed as the rejected_substring argument.

text_changed ( String new_text )

Emitted when the text changes.

text_submitted ( String new_text )

Emitted when the user presses @GlobalScope.KEY_ENTER on the LineEdit.

Enumerations¶

enum MenuItems:

MenuItems MENU_CUT = 0

Cuts (copies and clears) the selected text.

MenuItems MENU_COPY = 1

Copies the selected text.

MenuItems MENU_PASTE = 2

Pastes the clipboard text over the selected text (or at the caret's position).

Non-printable escape characters are automatically stripped from the OS clipboard via String.strip_escapes.

MenuItems MENU_CLEAR = 3

Erases the whole LineEdit text.

MenuItems MENU_SELECT_ALL = 4

Selects the whole LineEdit text.

MenuItems MENU_UNDO = 5

Undoes the previous action.

MenuItems MENU_REDO = 6

Reverse the last undo action.

MenuItems MENU_SUBMENU_TEXT_DIR = 7

ID of "Text Writing Direction" submenu.

MenuItems MENU_DIR_INHERITED = 8

Sets text direction to inherited.

MenuItems MENU_DIR_AUTO = 9

Sets text direction to automatic.

MenuItems MENU_DIR_LTR = 10

Sets text direction to left-to-right.

MenuItems MENU_DIR_RTL = 11

Sets text direction to right-to-left.

MenuItems MENU_DISPLAY_UCC = 12

Toggles control character display.

MenuItems MENU_SUBMENU_INSERT_UCC = 13

ID of "Insert Control Character" submenu.

MenuItems MENU_INSERT_LRM = 14

Inserts left-to-right mark (LRM) character.

MenuItems MENU_INSERT_RLM = 15

Inserts right-to-left mark (RLM) character.

MenuItems MENU_INSERT_LRE = 16

Inserts start of left-to-right embedding (LRE) character.

MenuItems MENU_INSERT_RLE = 17

Inserts start of right-to-left embedding (RLE) character.

MenuItems MENU_INSERT_LRO = 18

Inserts start of left-to-right override (LRO) character.

MenuItems MENU_INSERT_RLO = 19

Inserts start of right-to-left override (RLO) character.

MenuItems MENU_INSERT_PDF = 20

Inserts pop direction formatting (PDF) character.

MenuItems MENU_INSERT_ALM = 21

Inserts Arabic letter mark (ALM) character.

MenuItems MENU_INSERT_LRI = 22

Inserts left-to-right isolate (LRI) character.

MenuItems MENU_INSERT_RLI = 23

Inserts right-to-left isolate (RLI) character.

MenuItems MENU_INSERT_FSI = 24

Inserts first strong isolate (FSI) character.

MenuItems MENU_INSERT_PDI = 25

Inserts pop direction isolate (PDI) character.

MenuItems MENU_INSERT_ZWJ = 26

Inserts zero width joiner (ZWJ) character.

MenuItems MENU_INSERT_ZWNJ = 27

Inserts zero width non-joiner (ZWNJ) character.

MenuItems MENU_INSERT_WJ = 28

Inserts word joiner (WJ) character.

MenuItems MENU_INSERT_SHY = 29

Inserts soft hyphen (SHY) character.

MenuItems MENU_MAX = 30

Represents the size of the MenuItems enum.

enum VirtualKeyboardType:

VirtualKeyboardType KEYBOARD_TYPE_DEFAULT = 0

Default text virtual keyboard.

VirtualKeyboardType KEYBOARD_TYPE_MULTILINE = 1

Multiline virtual keyboard.

VirtualKeyboardType KEYBOARD_TYPE_NUMBER = 2

Virtual number keypad, useful for PIN entry.

VirtualKeyboardType KEYBOARD_TYPE_NUMBER_DECIMAL = 3

Virtual number keypad, useful for entering fractional numbers.

VirtualKeyboardType KEYBOARD_TYPE_PHONE = 4

Virtual phone number keypad.

VirtualKeyboardType KEYBOARD_TYPE_EMAIL_ADDRESS = 5

Virtual keyboard with additional keys to assist with typing email addresses.

VirtualKeyboardType KEYBOARD_TYPE_PASSWORD = 6

Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization.

Note: This is not supported on Web. Instead, this behaves identically to KEYBOARD_TYPE_DEFAULT.

VirtualKeyboardType KEYBOARD_TYPE_URL = 7

Virtual keyboard with additional keys to assist with typing URLs.

Property Descriptions¶

HorizontalAlignment alignment = 0

void set_horizontal_alignment ( HorizontalAlignment value )
HorizontalAlignment get_horizontal_alignment ( )

Text alignment as defined in the HorizontalAlignment enum.

bool caret_blink = false

void set_caret_blink_enabled ( bool value )
bool is_caret_blink_enabled ( )

If true, the caret (text cursor) blinks.

float caret_blink_interval = 0.65

void set_caret_blink_interval ( float value )
float get_caret_blink_interval ( )

Duration (in seconds) of a caret's blinking cycle.

int caret_column = 0

void set_caret_column ( int value )
int get_caret_column ( )

The caret's column position inside the LineEdit. When set, the text may scroll to accommodate it.

bool caret_force_displayed = false

void set_caret_force_displayed ( bool value )
bool is_caret_force_displayed ( )

If true, the LineEdit will always show the caret, even if focus is lost.

bool caret_mid_grapheme = true

void set_caret_mid_grapheme_enabled ( bool value )
bool is_caret_mid_grapheme_enabled ( )

Allow moving caret, selecting and removing the individual composite character components.

Note: Backspace is always removing individual composite character components.

bool clear_button_enabled = false

void set_clear_button_enabled ( bool value )
bool is_clear_button_enabled ( )

If true, the LineEdit will show a clear button if text is not empty, which can be used to clear the text quickly.

bool context_menu_enabled = true

void set_context_menu_enabled ( bool value )
bool is_context_menu_enabled ( )

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

bool deselect_on_focus_loss_enabled = true

void set_deselect_on_focus_loss_enabled ( bool value )
bool is_deselect_on_focus_loss_enabled ( )

If true, the selected text will be deselected when focus is lost.

bool draw_control_chars = false

void set_draw_control_chars ( bool value )
bool get_draw_control_chars ( )

If true, control characters are displayed.

bool editable = true

void set_editable ( bool value )
bool is_editable ( )

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

bool expand_to_text_length = false

void set_expand_to_text_length_enabled ( bool value )
bool is_expand_to_text_length_enabled ( )

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

bool flat = false

void set_flat ( bool value )
bool is_flat ( )

If true, the LineEdit don't display decoration.

String language = ""

void set_language ( String value )
String get_language ( )

Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.

int max_length = 0

void set_max_length ( int value )
int get_max_length ( )

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

When a limit is defined, characters that would exceed max_length are truncated. This happens both for existing text contents when setting the max length, or for new text inserted in the LineEdit, including pasting. If any input text is truncated, the text_change_rejected signal is emitted with the truncated substring as parameter.

Example:

text = "Hello world"
max_length = 5
# `text` becomes "Hello".
max_length = 10
text += " goodbye"
# `text` becomes "Hello good".
# `text_change_rejected` is emitted with "bye" as parameter.

Text = "Hello world";
MaxLength = 5;
// `Text` becomes "Hello".
MaxLength = 10;
Text += " goodbye";
// `Text` becomes "Hello good".
// `text_change_rejected` is emitted with "bye" as parameter.

bool middle_mouse_paste_enabled = true

void set_middle_mouse_paste_enabled ( bool value )
bool is_middle_mouse_paste_enabled ( )

If false, using middle mouse button to paste clipboard will be disabled.

Note: This method is only implemented on Linux.

String placeholder_text = ""

void set_placeholder ( String value )
String get_placeholder ( )

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

Texture2D right_icon

void set_right_icon ( Texture2D value )
Texture2D get_right_icon ( )

Sets the icon that will appear in the right end of the LineEdit if there's no text, or always, if clear_button_enabled is set to false.

bool secret = false

void set_secret ( bool value )
bool is_secret ( )

If true, every character is replaced with the secret character (see secret_character).

String secret_character = "•"

void set_secret_character ( String value )
String get_secret_character ( )

The character to use to mask secret input (defaults to "•"). Only a single character can be used as the secret character.

bool select_all_on_focus = false

void set_select_all_on_focus ( bool value )
bool is_select_all_on_focus ( )

If true, the LineEdit will select the whole text when it gains focus.

bool selecting_enabled = true

void set_selecting_enabled ( bool value )
bool is_selecting_enabled ( )

If false, it's impossible to select the text using mouse nor keyboard.

bool shortcut_keys_enabled = true

void set_shortcut_keys_enabled ( bool value )
bool is_shortcut_keys_enabled ( )

If false, using shortcuts will be disabled.

StructuredTextParser structured_text_bidi_override = 0

void set_structured_text_bidi_override ( StructuredTextParser value )
StructuredTextParser get_structured_text_bidi_override ( )

Set BiDi algorithm override for the structured text.

Array structured_text_bidi_override_options = []

void set_structured_text_bidi_override_options ( Array value )
Array get_structured_text_bidi_override_options ( )

Set additional options for BiDi override.

String text = ""

void set_text ( String value )
String get_text ( )

String value of the LineEdit.

Note: Changing text using this property won't emit the text_changed signal.

TextDirection text_direction = 0

void set_text_direction ( TextDirection value )
TextDirection get_text_direction ( )

Base text writing direction.

bool virtual_keyboard_enabled = true

void set_virtual_keyboard_enabled ( bool value )
bool is_virtual_keyboard_enabled ( )

If true, the native virtual keyboard is shown when focused on platforms that support it.

VirtualKeyboardType virtual_keyboard_type = 0

void set_virtual_keyboard_type ( VirtualKeyboardType value )
VirtualKeyboardType get_virtual_keyboard_type ( )

Specifies the type of virtual keyboard to show.

Method Descriptions¶

void clear ( )

Erases the LineEdit's text.

void delete_char_at_caret ( )

Deletes one character at the caret's current position (equivalent to pressing Delete).

void delete_text ( int from_column, int to_column )

Deletes a section of the text going from position from_column to to_column. Both parameters should be within the text's length.

void deselect ( )

Clears the current selection.

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

You can add custom menu items or remove standard ones. Make sure your IDs don't conflict with the standard ones (see MenuItems). For example:

func _ready():
    var menu = get_menu()
    # Remove all items after "Redo".
    menu.item_count = menu.get_item_index(MENU_REDO) + 1
    # Add custom items.
    menu.add_separator()
    menu.add_item("Insert Date", MENU_MAX + 1)
    # Connect callback.
    menu.id_pressed.connect(_on_item_pressed)

func _on_item_pressed(id):
    if id == MENU_MAX + 1:
        insert_text_at_caret(Time.get_date_string_from_system())

public override void _Ready()
{
    var menu = GetMenu();
    // Remove all items after "Redo".
    menu.ItemCount = menu.GetItemIndex(LineEdit.MenuItems.Redo) + 1;
    // Add custom items.
    menu.AddSeparator();
    menu.AddItem("Insert Date", LineEdit.MenuItems.Max + 1);
    // Add event handler.
    menu.IdPressed += OnItemPressed;
}

public void OnItemPressed(int id)
{
    if (id == LineEdit.MenuItems.Max + 1)
    {
        InsertTextAtCaret(