Attention: Here be dragons
This is the latest
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
Checking the stable version of the documentation...
LineEdit
Inherits: Control < CanvasItem < Node < Object
An input field for single-line text.
Description
LineEdit provides an input field for editing a single line of text.
When the LineEdit control is focused using the keyboard arrow keys, it will only gain focus and not enter edit mode.
To enter edit mode, click on the control with the mouse, see also keep_editing_on_text_submit.
To exit edit mode, press
ui_text_submitorui_cancel(by default Escape) actions.Check edit(), unedit(), is_editing(), and editing_toggled for more information.
While entering text, it is possible to insert special characters using Unicode, OEM or Windows alt codes:
To enter Unicode codepoints, hold Alt and type the codepoint on the numpad. For example, to enter the character
á(U+00E1), hold Alt and type +E1 on the numpad (the leading zeroes can be omitted).To enter OEM codepoints, hold Alt and type the code on the numpad. For example, to enter the character
á(OEM 160), hold Alt and type160on the numpad.To enter Windows codepoints, hold Alt and type the code on the numpad. For example, to enter the character
á(Windows 0225), hold Alt and type 0, 2, 2, 5 on the numpad. The leading zero here must not be omitted, as this is how Windows codepoints are distinguished from OEM codepoints.
Important:
Focusing the LineEdit with
ui_focus_next(by default Tab) orui_focus_prev(by default Shift + Tab) or Control.grab_focus() still enters edit mode (for compatibility).
LineEdit features many built-in shortcuts that are always 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:
Cmd + F: Same as Right Arrow, move the caret one character right
Cmd + B: Same as Left Arrow, move the caret one character left
Cmd + P: Same as Up Arrow, move the caret to the previous line
Cmd + N: Same as Down Arrow, move the caret to the next line
Cmd + D: Same as Delete, delete the character on the right side of caret
Cmd + H: Same as Backspace, delete the character on the left side of the caret
Cmd + A: Same as Home, move the caret to the beginning of the line
Cmd + 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
Note: Caret movement shortcuts listed above are not affected by shortcut_keys_enabled.
Properties
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
focus_mode |
|
|
|
||
|
||
|
||
|
||
mouse_default_cursor_shape |
|
|
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods
void |
|
void |
|
void |
clear() |
void |
|
void |
delete_text(from_column: int, to_column: int) |
void |
deselect() |
void |
edit() |
get_menu() const |
|
get_next_composite_character_column(column: int) const |
|
get_previous_composite_character_column(column: int) const |
|
get_scroll_offset() const |
|
get_selection_from_column() const |
|
get_selection_to_column() const |
|
has_ime_text() const |
|
has_redo() const |
|
has_selection() const |
|
has_undo() const |
|
void |
insert_text_at_caret(text: String) |
is_editing() const |
|
is_menu_visible() const |
|
void |
menu_option(option: int) |
void |
|
void |
|
void |
unedit() |
Theme Properties
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Signals
editing_toggled(toggled_on: bool) 🔗
Emitted when the LineEdit switches in or out of edit mode.
text_change_rejected(rejected_substring: String) 🔗
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(new_text: String) 🔗
Emitted when the text changes.
text_submitted(new_text: String) 🔗
Emitted when the user presses the ui_text_submit action (by default: Enter or Kp Enter) while the LineEdit has focus.
Enumerations
Cuts (copies and clears) the selected text.
Copies the selected text.
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().
Erases the whole LineEdit text.
Selects the whole LineEdit text.
Undoes the previous action.
Reverse the last undo action.
ID of "Text Writing Direction" submenu.
Sets text direction to inherited.
Sets text direction to automatic.
Sets text direction to left-to-right.
Sets text direction to right-to-left.
Toggles control character display.
ID of "Insert Control Character" submenu.
Inserts left-to-right mark (LRM) character.
Inserts right-to-left mark (RLM) character.
Inserts start of left-to-right embedding (LRE) character.
Inserts start of right-to-left embedding (RLE) character.
Inserts start of left-to-right override (LRO) character.
Inserts start of right-to-left override (RLO) character.
Inserts pop direction formatting (PDF) character.
Inserts Arabic letter mark (ALM) character.
Inserts left-to-right isolate (LRI) character.
Inserts right-to-left isolate (RLI) character.
Inserts first strong isolate (FSI) character.
Inserts pop direction isolate (PDI) character.
Inserts zero width joiner (ZWJ) character.
Inserts zero width non-joiner (ZWNJ) character.
Inserts word joiner (WJ) character.
Inserts soft hyphen (SHY) character.
Opens system emoji and symbol picker.
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(value: HorizontalAlignment)
HorizontalAlignment get_horizontal_alignment()
Text alignment as defined in the HorizontalAlignment enum.
bool backspace_deletes_composite_character_enabled = false 🔗
void set_backspace_deletes_composite_character_enabled(value: bool)
bool is_backspace_deletes_composite_character_enabled()
If true and caret_mid_grapheme is false, backspace deletes an entire composite character such as ❤️🩹, instead of deleting part of the composite character.
If true, makes the caret blink.
float caret_blink_interval = 0.65 🔗
The interval at which the caret blinks (in seconds).
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.
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.
If false, existing text cannot be modified and new text cannot be added.
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.
If true, the LineEdit doesn't display decoration.
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).
Language code used for line-breaking and text shaping algorithms. If left empty, current locale is used instead.
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:
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 🔗
If false, using middle mouse button to paste clipboard will be disabled.
Note: This method is only implemented on Linux.
String placeholder_text = "" 🔗
Text shown when the LineEdit is empty. It is not the LineEdit's default value (see text).
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.
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.
StructuredTextParser structured_text_bidi_override = 0 🔗
void set_structured_text_bidi_override(value: StructuredTextParser)
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(value: Array)
Array get_structured_text_bidi_override_options()
Set additional options for BiDi override.
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(value: TextDirection)
TextDirection get_text_direction()
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.
VirtualKeyboardType virtual_keyboard_type = 0 🔗
void set_virtual_keyboard_type(value: VirtualKeyboardType)
VirtualKeyboardType get_virtual_keyboard_type()
Specifies the type of virtual keyboard to show.
Method Descriptions
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(from_column: int, to_column: int) 🔗
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.
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(column: int) 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(column: int) 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.
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.
Returns true if the user has text in the Input Method Editor (IME).
Returns true if a "redo" action is available.
Returns true if the user has selected text.
Returns true if an "undo" action is available.
void insert_text_at_caret(text: String) 🔗
Inserts text at the caret. If the resulting value is longer than max_length, nothing happens.
Returns whether the LineEdit is being edited.
Returns whether the menu is visible. Use this instead of get_menu().visible to improve performance (so the creation of the menu is avoided).
Executes a given action as defined in the MenuItems enum.
void select(from: int = 0, to: int = -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.
Theme Property Descriptions
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.
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).
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 used for the text.
Font size of the LineEdit's text.
Texture for the clear button. See clear_button_enabled.
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.
Default background for the LineEdit.
Background used when LineEdit is in read-only mode (editable is set to false).