LineEdit

int alignment = 0

Text alignment as defined in the HorizontalAlignment enum.

bool backspace_deletes_composite_character_enabled = false

If true and caret_mid_grapheme is false, backspace deletes an entire composite character such as ❤️‍🩹, instead of deleting part of the composite character.

bool caret_blink = false

If true, makes the caret blink.

float caret_blink_interval = 0.65

The interval at which the caret blinks (in seconds).

int caret_column = 0

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

bool caret_force_displayed = false

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

bool caret_mid_grapheme = false

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

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

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

bool deselect_on_focus_loss_enabled = true

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

bool drag_and_drop_selection_enabled = true

If true, allow drag and drop of selected text.

bool draw_control_chars = false

If true, control characters are displayed.

bool editable = true

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

bool emoji_menu_enabled = true

If true, "Emoji and Symbols" menu is enabled.

bool expand_to_text_length = false

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

If true, the LineEdit doesn't display decoration.

int focus_mode = 2

bool keep_editing_on_text_submit = false

If true, the LineEdit will not exit edit mode when text is submitted by pressing ui_text_submit action (by default: Enter or Kp Enter).

String language = ""

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

int max_length = 0

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 a parameter:

			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 a 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 a parameter.
			

bool middle_mouse_paste_enabled = true

If false, using middle mouse button to paste clipboard will be disabled. Note: This method is only implemented on Linux.

int mouse_default_cursor_shape = 1

String placeholder_text = ""

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

Texture2D 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

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

String secret_character = "•"

The character to use to mask secret input. Only a single character can be used as the secret character. If it is longer than one character, only the first one will be used. If it is empty, a space will be used instead.

bool select_all_on_focus = false

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

bool selecting_enabled = true

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

bool shortcut_keys_enabled = true

If true, shortcut keys for context menu items are enabled, even if the context menu is disabled.

int structured_text_bidi_override = 0

Set BiDi algorithm override for the structured text.

Array structured_text_bidi_override_options = []

Set additional options for BiDi override.

String text = ""

String value of the LineEdit. Note: Changing text using this property won't emit the text_changed signal.

int text_direction = 0

Base text writing direction.

bool virtual_keyboard_enabled = true

If true, the native virtual keyboard is enabled on platforms that support it.

bool virtual_keyboard_show_on_focus = true

If true, the native virtual keyboard is shown on focus events on platforms that support it.

int virtual_keyboard_type = 0

Specifies the type of virtual keyboard to show.

void apply_ime()

Applies text from the Input Method Editor (IME) and closes the IME if it is open.

void cancel_ime()

Closes the Input Method Editor (IME) if it is open. Any text in the IME will be lost.

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.

void edit()

Allows entering edit mode whether the LineEdit is focused or not. See also keep_editing_on_text_submit.

PopupMenu get_menu() const

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(Time.GetDateStringFromSystem());
					}
				}
				

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their Window.visible property.

int get_next_composite_character_column(int column) const

Returns the correct column at the end of a composite character like ❤️‍🩹 (mending heart; Unicode: U+2764 U+FE0F U+200D U+1FA79) which is comprised of more than one Unicode code point, if the caret is at the start of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters. Note: To check at caret location use get_next_composite_character_column(get_caret_column())

int get_previous_composite_character_column(int column) const

Returns the correct column at the start of a composite character like ❤️‍🩹 (mending heart; Unicode: U+2764 U+FE0F U+200D U+1FA79) which is comprised of more than one Unicode code point, if the caret is at the end of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters. Note: To check at caret location use get_previous_composite_character_column(get_caret_column())

float get_scroll_offset() const

Returns the scroll offset due to caret_column, as a number of characters.

String get_selected_text()

Returns the text inside the selection.

int get_selection_from_column() const

Returns the selection begin column.

int get_selection_to_column() const

Returns the selection end column.

bool has_ime_text() const

Returns true if the user has text in the Input Method Editor (IME).

bool has_redo() const

Returns true if a "redo" action is available.

bool has_selection() const

Returns true if the user has selected text.

bool has_undo() const

Returns true if an "undo" action is available.

void insert_text_at_caret(String text)

Inserts text at the caret. If the resulting value is longer than max_length, nothing happens.

bool is_editing() const

Returns whether the LineEdit is being edited.

bool is_menu_visible() const

Returns whether the menu is visible. Use this instead of get_menu().visible to improve performance (so the creation of the menu is avoided).

void menu_option(int option)

Executes a given action as defined in the MenuItems enum.

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

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

				text = "Welcome"
				select() # Will select "Welcome".
				select(4) # Will select "ome".
				select(2, 5) # Will select "lco".
				

				Text = "Welcome";
				Select(); // Will select "Welcome".
				Select(4); // Will select "ome".
				Select(2, 5); // Will select "lco".
				

void select_all()

Selects the whole String.

void unedit()

Allows exiting edit mode while preserving focus.

editing_toggled(bool toggled_on)

Emitted when the LineEdit switches in or out of edit mode.

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 the ui_text_submit action (by default: Enter or Kp Enter) while the LineEdit has focus.

MENU_CUT = 0

Enum: MenuItems

Cuts (copies and clears) the selected text.

MENU_COPY = 1

Enum: MenuItems

Copies the selected text.

MENU_PASTE = 2

Enum: MenuItems

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

MENU_CLEAR = 3

Enum: MenuItems

Erases the whole LineEdit text.

MENU_SELECT_ALL = 4

Enum: MenuItems

Selects the whole LineEdit text.

MENU_UNDO = 5

Enum: MenuItems

Undoes the previous action.

MENU_REDO = 6

Enum: MenuItems

Reverse the last undo action.

MENU_SUBMENU_TEXT_DIR = 7

Enum: MenuItems

ID of "Text Writing Direction" submenu.

MENU_DIR_INHERITED = 8

Enum: MenuItems

Sets text direction to inherited.

MENU_DIR_AUTO = 9

Enum: MenuItems

Sets text direction to automatic.

MENU_DIR_LTR = 10

Enum: MenuItems

Sets text direction to left-to-right.

MENU_DIR_RTL = 11

Enum: MenuItems

Sets text direction to right-to-left.

MENU_DISPLAY_UCC = 12

Enum: MenuItems

Toggles control character display.

MENU_SUBMENU_INSERT_UCC = 13

Enum: MenuItems

ID of "Insert Control Character" submenu.

MENU_INSERT_LRM = 14

Enum: MenuItems

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

MENU_INSERT_RLM = 15

Enum: MenuItems

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

MENU_INSERT_LRE = 16

Enum: MenuItems

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

MENU_INSERT_RLE = 17

Enum: MenuItems

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

MENU_INSERT_LRO = 18

Enum: MenuItems

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

MENU_INSERT_RLO = 19

Enum: MenuItems

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

MENU_INSERT_PDF = 20

Enum: MenuItems

Inserts pop direction formatting (PDF) character.

MENU_INSERT_ALM = 21

Enum: MenuItems

Inserts Arabic letter mark (ALM) character.

MENU_INSERT_LRI = 22

Enum: MenuItems

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

MENU_INSERT_RLI = 23

Enum: MenuItems

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

MENU_INSERT_FSI = 24

Enum: MenuItems

Inserts first strong isolate (FSI) character.

MENU_INSERT_PDI = 25

Enum: MenuItems

Inserts pop direction isolate (PDI) character.

MENU_INSERT_ZWJ = 26

Enum: MenuItems

Inserts zero width joiner (ZWJ) character.

MENU_INSERT_ZWNJ = 27

Enum: MenuItems

Inserts zero width non-joiner (ZWNJ) character.

MENU_INSERT_WJ = 28

Enum: MenuItems

Inserts word joiner (WJ) character.

MENU_INSERT_SHY = 29

Enum: MenuItems

Inserts soft hyphen (SHY) character.

MENU_EMOJI_AND_SYMBOL = 30

Enum: MenuItems

Opens system emoji and symbol picker.

MENU_MAX = 31

Enum: MenuItems

Represents the size of the MenuItems enum.

KEYBOARD_TYPE_DEFAULT = 0

Enum: VirtualKeyboardType

Default text virtual keyboard.

KEYBOARD_TYPE_MULTILINE = 1

Enum: VirtualKeyboardType

Multiline virtual keyboard.

KEYBOARD_TYPE_NUMBER = 2

Enum: VirtualKeyboardType

Virtual number keypad, useful for PIN entry.

KEYBOARD_TYPE_NUMBER_DECIMAL = 3

Enum: VirtualKeyboardType

Virtual number keypad, useful for entering fractional numbers.

KEYBOARD_TYPE_PHONE = 4

Enum: VirtualKeyboardType

Virtual phone number keypad.

KEYBOARD_TYPE_EMAIL_ADDRESS = 5

Enum: VirtualKeyboardType

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

KEYBOARD_TYPE_PASSWORD = 6

Enum: VirtualKeyboardType

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.

KEYBOARD_TYPE_URL = 7

Enum: VirtualKeyboardType

Virtual keyboard with additional keys to assist with typing URLs.

Color caret_color = Color(0.95, 0.95, 0.95, 1)

Color of the LineEdit's caret (text cursor). This can be set to a fully transparent color to hide the caret entirely.

Color clear_button_color = Color(0.875, 0.875, 0.875, 1)

Color used as default tint for the clear button.

Color clear_button_color_pressed = Color(1, 1, 1, 1)

Color used for the clear button when it's pressed.

Color font_color = Color(0.875, 0.875, 0.875, 1)

Default font color.

Color font_outline_color = Color(0, 0, 0, 1)

The tint of text outline of the LineEdit.

Color font_placeholder_color = Color(0.875, 0.875, 0.875, 0.6)

Font color for placeholder_text.

Color font_selected_color = Color(1, 1, 1, 1)

Font color for selected text (inside the selection rectangle).

Color font_uneditable_color = Color(0.875, 0.875, 0.875, 0.5)

Font color when editing is disabled.

Color selection_color = Color(0.5, 0.5, 0.5, 1)

Color of the selection rectangle.

int caret_width = 1

The caret's width in pixels. Greater values can be used to improve accessibility by ensuring the caret is easily visible, or to ensure consistency with a large font size.

int minimum_character_width = 4

Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of 'M' characters (i.e. this number of 'M' characters can be displayed without scrolling).

int outline_size = 0

The size of the text outline. Note: If using a font with FontFile.multichannel_signed_distance_field enabled, its FontFile.msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.

Font font

Font used for the text.

int font_size

Font size of the LineEdit's text.

Texture2D clear

Texture for the clear button. See clear_button_enabled.

StyleBox focus

Background used when LineEdit has GUI focus. The focus StyleBox is displayed over the base StyleBox, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.

StyleBox normal

Default background for the LineEdit.

StyleBox read_only

Background used when LineEdit is in read-only mode (editable is set to false).