Control that provides single-line string editing.
LineEdit provides a single-line string editor, used for text fields. It features many built-in shortcuts which will always be available ([code]Ctrl[/code] here maps to [code]Command[/code] on macOS): - [kbd]Ctrl + C[/kbd]: Copy - [kbd]Ctrl + X[/kbd]: Cut - [kbd]Ctrl + V or Ctrl + Y[/kbd]: Paste/"yank" - [kbd]Ctrl + Z[/kbd]: Undo - [kbd]Ctrl + Shift + Z[/kbd]: Redo - [kbd]Ctrl + U[/kbd]: Delete text from the cursor position to the beginning of the line - [kbd]Ctrl + K[/kbd]: Delete text from the cursor position to the end of the line - [kbd]Ctrl + A[/kbd]: Select all text - [kbd]Up Arrow[/kbd]/[kbd]Down arrow[/kbd]: Move the cursor to the beginning/end of the line On macOS, some extra keyboard shortcuts are available: - [kbd]Ctrl + F[/kbd]: Same as [kbd]Right Arrow[/kbd], move the cursor one character right - [kbd]Ctrl + B[/kbd]: Same as [kbd]Left Arrow[/kbd], move the cursor one character left - [kbd]Ctrl + P[/kbd]: Same as [kbd]Up Arrow[/kbd], move the cursor to the previous line - [kbd]Ctrl + N[/kbd]: Same as [kbd]Down Arrow[/kbd], move the cursor to the next line - [kbd]Ctrl + D[/kbd]: Same as [kbd]Delete[/kbd], delete the character on the right side of cursor - [kbd]Ctrl + H[/kbd]: Same as [kbd]Backspace[/kbd], delete the character on the left side of the cursor - [kbd]Cmd + Left arrow[/kbd]: Same as [kbd]Home[/kbd], move the cursor to the beginning of the line - [kbd]Cmd + Right arrow[/kbd]: Same as [kbd]End[/kbd], move the cursor to the end of the line
Adds [code]text[/code] after the cursor. If the resulting value is longer than [member max_length], nothing happens.
Erases the [LineEdit]'s [member text].
Deletes one character at the cursor's current position (equivalent to pressing the [code]Delete[/code] key).
Deletes a section of the [member text] going from position [code]from_column[/code] to [code]to_column[/code]. Both parameters should be within the text's length.
Clears the current selection.
Returns the [PopupMenu] of this [LineEdit]. By default, this menu is displayed when right-clicking on the [LineEdit]. [b]Warning:[/b] 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 [member CanvasItem.visible] property.
Returns the scroll offset due to [member caret_position], as a number of characters.
Returns the selection begin column.
Returns the selection end column.
Returns [code]true[/code] if the user has selected text.
Executes a given action as defined in the [enum MenuItems] enum.
Selects characters inside [LineEdit] between [code]from[/code] and [code]to[/code]. By default, [code]from[/code] is at the beginning and [code]to[/code] at the end. [codeblock] text = "Welcome" select() # Will select "Welcome". select(4) # Will select "ome". select(2, 5) # Will select "lco". [/codeblock]
Selects the whole [String].
- Text alignment as defined in the [enum Align] enum.
- If [code]true[/code], the caret (visual cursor) blinks.
- Duration (in seconds) of a caret's blinking cycle.
- The cursor's position inside the [LineEdit]. When set, the text may scroll to accommodate it.
- If [code]true[/code], the [LineEdit] will show a clear button if [code]text[/code] is not empty, which can be used to clear the text quickly.
- If [code]true[/code], the context menu will appear when right-clicked.
- If [code]true[/code], the selected text will be deselected when focus is lost.
- If [code]false[/code], existing text cannot be modified and new text cannot be added.
- If [code]true[/code], the [LineEdit] width will increase to stay longer than the [member text]. It will [b]not[/b] compress if the [member text] is shortened.
- Maximum amount of characters that can be entered inside the [LineEdit]. If [code]0[/code], there is no limit. When a limit is defined, characters that would exceed [member max_length] are truncated. This happens both for existing [member text] contents when setting the max length, or for new text inserted in the [LineEdit], including pasting. If any input text is truncated, the [signal text_change_rejected] signal is emitted with the truncated substring as parameter. [b]Example:[/b] [codeblock] 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. [/codeblock]
- Opacity of the [member placeholder_text]. From [code]0[/code] to [code]1[/code].
- Text shown when the [LineEdit] is empty. It is [b]not[/b] the [LineEdit]'s default value (see [member text]).
- Sets the icon that will appear in the right end of the [LineEdit] if there's no [member text], or always, if [member clear_button_enabled] is set to [code]false[/code].
- If [code]true[/code], every character is replaced with the secret character (see [member secret_character]).
- The character to use to mask secret input (defaults to "*"). Only a single character can be used as the secret character.
- If [code]false[/code], it's impossible to select the text using mouse nor keyboard.
- If [code]false[/code], using shortcuts will be disabled.
- String value of the [LineEdit]. [b]Note:[/b] Changing text using this property won't emit the [signal text_changed] signal.
- If [code]true[/code], the native virtual keyboard is shown when focused on platforms that support it.
- Specifies the type of virtual keyboard to show.
Emitted when appending text that overflows the [member max_length]. The appended text is truncated to fit [member max_length], and the part that couldn't fit is passed as the [code]rejected_substring[/code] argument.
Emitted when the text changes.
Emitted when the user presses [constant KEY_ENTER] on the [LineEdit].
Aligns the text on the left-hand side of the [LineEdit].
Centers the text in the middle of the [LineEdit].
Aligns the text on the right-hand side of the [LineEdit].
Stretches whitespaces to fit the [LineEdit]'s width.
Cuts (copies and clears) the selected text.
Copies the selected text.
Pastes the clipboard text over the selected text (or at the cursor's position). Non-printable escape characters are automatically stripped from the OS clipboard via [method String.strip_escapes].
Erases the whole [LineEdit] text.
Selects the whole [LineEdit] text.
Undoes the previous action.
Reverse the last undo action.
Represents the size of the [enum MenuItems] enum.
Default text virtual keyboard.
Multiline virtual keyboard.
Virtual number keypad, useful for PIN entry.
Virtual number keypad, useful for entering fractional numbers.
Virtual phone number keypad.
Virtual keyboard with additional keys to assist with typing email addresses.
Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization. [b]Note:[/b] This is not supported on HTML5 or below iOS version 11.0. Instead, this will behave identically to [constant KEYBOARD_TYPE_DEFAULT].
Virtual keyboard with additional keys to assist with typing URLs.
Color used as default tint for the clear button.
Color used for the clear button when it's pressed.
Color of the [LineEdit]'s visual cursor (caret).
Default font color.
Font color for selected text (inside the selection rectangle).
Font color when editing is disabled.
Color of the selection rectangle.
Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of space characters (i.e. this amount of space characters can be displayed without scrolling).
Font used for the text.
Texture for the clear button. See [member clear_button_enabled].
Background used when [LineEdit] has GUI focus.
Default background for the [LineEdit].
Background used when [LineEdit] is in read-only mode ([member editable] is set to [code]false[/code]).