MenuItems

Types

• class Signal1

  Signal support.

• class Signal2

  Signal support.

• class Signal3

  Signal support.

• enum VirtualKeyboardType

Type members

• class var godotClassName: StringName

Instance members

• var alignment: HorizontalAlignment

  Text alignment as defined in the HorizontalAlignment enum.

• var caretBlink: Bool

  If true, makes the caret blink.

• var caretBlinkInterval: Double

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

• var caretColumn: Int32

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

• var caretForceDisplayed: Bool

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

• var caretMidGrapheme: Bool

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

• var clearButtonEnabled: Bool

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

• var contextMenuEnabled: Bool

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

• var deselectOnFocusLossEnabled: Bool

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

• var dragAndDropSelectionEnabled: Bool

  If true, allow drag and drop of selected text.

• var drawControlChars: Bool

  If true, control characters are displayed.

• var editable: Bool

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

• var expandToTextLength: Bool

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

• var flat: Bool

  If true, the LineEdit doesn’t display decoration.

• var language: String

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

• var maxLength: Int32

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

• var middleMousePasteEnabled: Bool

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

• var placeholderText: String

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

• var rightIcon: Texture2D?

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

• var secret: Bool

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

• var secretCharacter: String

  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.

• var selectAllOnFocus: Bool

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

• var selectingEnabled: Bool

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

• var shortcutKeysEnabled: Bool

  If false, using shortcuts will be disabled.

• var structuredTextBidiOverride: TextServer.StructuredTextParser

  Set BiDi algorithm override for the structured text.

• var structuredTextBidiOverrideOptions: GArray

  Set additional options for BiDi override.

• var text: String

  String value of the LineEdit.

• var textChangeRejected: Signal2

  Emitted when appending text that overflows the maxLength. The appended text is truncated to fit maxLength, and the part that couldn’t fit is passed as the rejectedSubstring argument.

• var textChanged: Signal1

  Emitted when the text changes.

• var textDirection: Control.TextDirection

  Base text writing direction.

• var textSubmitted: Signal3

  Emitted when the user presses enter on the LineEdit.

• var virtualKeyboardEnabled: Bool

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

• var virtualKeyboardType: LineEdit.VirtualKeyboardType

  Specifies the type of virtual keyboard to show.

• func clear()

  Erases the LineEdit’s text.

• func deleteCharAtCaret()

  Deletes one character at the caret’s current position (equivalent to pressing [kbd]Delete[/kbd]).

• func deleteText(fromColumn: Int32, toColumn: Int32)

  Deletes a section of the text going from position fromColumn to toColumn. Both parameters should be within the text’s length.

• func deselect()

  Clears the current selection.

• func getMenu() -> PopupMenu?

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

• func getScrollOffset() -> Double

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

• func getSelectedText() -> String

  Returns the text inside the selection.

• func getSelectionFromColumn() -> Int32

  Returns the selection begin column.

• func getSelectionToColumn() -> Int32

  Returns the selection end column.

• func hasSelection() -> Bool

  Returns true if the user has selected text.

• func insertTextAtCaret(text: String)

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

• func isMenuVisible() -> Bool

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

• func menuOption(Int32)

  Executes a given action as defined in the MenuItems enum.

• func select(from: Int32, to: Int32)

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

• func selectAll()

  Selects the whole String.