LineEdit

package
v0.0.0-...-fa94a0d Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2025 License: MIT Imports: 30 Imported by: 0

Documentation

Overview

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 KeepEditingOnTextSubmit.

- To exit edit mode, press ui_text_submit or ui_cancel (by default Escape) actions.

- Check Edit, Unedit, IsEditing, and OnEditingToggled 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 type 160 on 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) or ui_focus_prev (by default Shift + Tab) or Control.GrabFocus 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 ShortcutKeysEnabled.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any 

type Any interface {
	gd.IsClass
	AsLineEdit() Instance
}

type Expanded 

type Expanded = MoreArgs

type Extension 

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsCanvasItem 

func (self *Extension[T]) AsCanvasItem() CanvasItem.Instance

func (*Extension[T]) AsControl 

func (self *Extension[T]) AsControl() Control.Instance

func (*Extension[T]) AsLineEdit 

func (self *Extension[T]) AsLineEdit() Instance

func (*Extension[T]) AsNode 

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject 

func (self *Extension[T]) AsObject() [1]gd.Object

type ID 

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance 

func (id ID) Instance() (Instance, bool)

type Instance 

type Instance [1]gdclass.LineEdit

Instance of the class with convieniently typed arguments and results. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) Alignment 

func (self Instance) Alignment() GUI.HorizontalAlignment

func (Instance) ApplyIme 

func (self Instance) ApplyIme()

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

func (Instance) AsCanvasItem 

func (self Instance) AsCanvasItem() CanvasItem.Instance

func (Instance) AsControl 

func (self Instance) AsControl() Control.Instance

func (Instance) AsLineEdit 

func (self Instance) AsLineEdit() Instance

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) BackspaceDeletesCompositeCharacterEnabled 

func (self Instance) BackspaceDeletesCompositeCharacterEnabled() bool

func (Instance) CancelIme 

func (self Instance) CancelIme()

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

func (self Instance) CaretBlink() bool

func (Instance) CaretBlinkInterval 

func (self Instance) CaretBlinkInterval() Float.X

func (Instance) CaretColumn 

func (self Instance) CaretColumn() int

func (Instance) CaretForceDisplayed 

func (self Instance) CaretForceDisplayed() bool

func (Instance) CaretMidGrapheme 

func (self Instance) CaretMidGrapheme() bool

func (Instance) Clear 

func (self Instance) Clear()

Erases the LineEdit's Text.

func (Instance) ClearButtonEnabled 

func (self Instance) ClearButtonEnabled() bool

func (Instance) ContextMenuEnabled 

func (self Instance) ContextMenuEnabled() bool

func (Instance) DeleteCharAtCaret 

func (self Instance) DeleteCharAtCaret()

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

func (Instance) DeleteText 

func (self Instance) DeleteText(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.

func (Instance) Deselect 

func (self Instance) Deselect()

Clears the current selection.

func (Instance) DeselectOnFocusLossEnabled 

func (self Instance) DeselectOnFocusLossEnabled() bool

func (Instance) DragAndDropSelectionEnabled 

func (self Instance) DragAndDropSelectionEnabled() bool

func (Instance) DrawControlChars 

func (self Instance) DrawControlChars() bool

func (Instance) Edit 

func (self Instance) Edit()

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

See also KeepEditingOnTextSubmit.

func (Instance) Editable 

func (self Instance) Editable() bool

func (Instance) EmojiMenuEnabled 

func (self Instance) EmojiMenuEnabled() bool

func (Instance) ExpandToTextLength 

func (self Instance) ExpandToTextLength() bool

func (Instance) Flat 

func (self Instance) Flat() bool

func (Instance) GetMenu 

func (self Instance) GetMenu() PopupMenu.Instance

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: 

Ready := func() {
	var menu = line_edit.GetMenu()
	// Remove all items after "Redo".
	menu.SetItemCount(menu.GetItemIndex(int(LineEdit.MenuRedo)) + 1)
	// Add custom items.
	menu.AddSeparator()
	menu.MoreArgs().AddItem("Insert Date", int(LineEdit.MenuMax)+1, 0)
	// Connect callback.
	menu.OnIdPressed(func(id int) {
		if id == int(LineEdit.MenuMax)+1 {
			line_edit.InsertTextAtCaret(Time.GetDateStringFromSystem(false))
		}
	})
}

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.

func (Instance) GetNextCompositeCharacterColumn 

func (self Instance) GetNextCompositeCharacterColumn(column int) int

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

func (Instance) GetPreviousCompositeCharacterColumn 

func (self Instance) GetPreviousCompositeCharacterColumn(column int) int

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

func (Instance) GetScrollOffset 

func (self Instance) GetScrollOffset() Float.X

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

func (Instance) GetSelectedText 

func (self Instance) GetSelectedText() string

Returns the text inside the selection.

func (Instance) GetSelectionFromColumn 

func (self Instance) GetSelectionFromColumn() int

Returns the selection begin column.

func (Instance) GetSelectionToColumn 

func (self Instance) GetSelectionToColumn() int

Returns the selection end column.

func (Instance) HasImeText 

func (self Instance) HasImeText() bool

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

func (Instance) HasRedo 

func (self Instance) HasRedo() bool

Returns true if a "redo" action is available.

func (Instance) HasSelection 

func (self Instance) HasSelection() bool

Returns true if the user has selected text.

func (Instance) HasUndo 

func (self Instance) HasUndo() bool

Returns true if an "undo" action is available.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) InsertTextAtCaret 

func (self Instance) InsertTextAtCaret(text string)

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

func (Instance) IsEditing 

func (self Instance) IsEditing() bool

Returns whether the LineEdit is being edited.

func (Instance) IsMenuVisible 

func (self Instance) 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 (Instance) KeepEditingOnTextSubmit 

func (self Instance) KeepEditingOnTextSubmit() bool

func (Instance) Language 

func (self Instance) Language() string

func (Instance) MaxLength 

func (self Instance) MaxLength() int

func (Instance) MenuOption 

func (self Instance) MenuOption(option int)

Executes a given action as defined in the MenuItems enum.

func (Instance) MiddleMousePasteEnabled 

func (self Instance) MiddleMousePasteEnabled() bool

func (Instance) MoreArgs 

func (self Instance) MoreArgs() MoreArgs

MoreArgs enables certain functions to be called with additional 'optional' arguments.

func (Instance) OnEditingToggled 

func (self Instance) OnEditingToggled(cb func(toggled_on bool), flags ...Signal.Flags)

func (Instance) OnTextChangeRejected 

func (self Instance) OnTextChangeRejected(cb func(rejected_substring string), flags ...Signal.Flags)

func (Instance) OnTextChanged 

func (self Instance) OnTextChanged(cb func(new_text string), flags ...Signal.Flags)

func (Instance) OnTextSubmitted 

func (self Instance) OnTextSubmitted(cb func(new_text string), flags ...Signal.Flags)

func (Instance) PlaceholderText 

func (self Instance) PlaceholderText() string

func (Instance) RightIcon 

func (self Instance) RightIcon() Texture2D.Instance

func (Instance) Secret 

func (self Instance) Secret() bool

func (Instance) SecretCharacter 

func (self Instance) SecretCharacter() string

func (Instance) Select 

func (self Instance) Select()

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

line_edit.SetText("Welcome")
line_edit.Select()                 // Will select "Welcome".
line_edit.MoreArgs().Select(4, -1) // Will select "ome".
line_edit.MoreArgs().Select(2, 5)  // Will select "lco".

func (Instance) SelectAll 

func (self Instance) SelectAll()

Selects the whole string.

func (Instance) SelectAllOnFocus 

func (self Instance) SelectAllOnFocus() bool

func (Instance) SelectingEnabled 

func (self Instance) SelectingEnabled() bool

func (Instance) SetAlignment 

func (self Instance) SetAlignment(value GUI.HorizontalAlignment)

func (Instance) SetBackspaceDeletesCompositeCharacterEnabled 

func (self Instance) SetBackspaceDeletesCompositeCharacterEnabled(value bool)
func (self Instance) SetCaretBlink(value bool)

func (Instance) SetCaretBlinkInterval 

func (self Instance) SetCaretBlinkInterval(value Float.X)

func (Instance) SetCaretColumn 

func (self Instance) SetCaretColumn(value int)

func (Instance) SetCaretForceDisplayed 

func (self Instance) SetCaretForceDisplayed(value bool)

func (Instance) SetCaretMidGrapheme 

func (self Instance) SetCaretMidGrapheme(value bool)

func (Instance) SetClearButtonEnabled 

func (self Instance) SetClearButtonEnabled(value bool)

func (Instance) SetContextMenuEnabled 

func (self Instance) SetContextMenuEnabled(value bool)

func (Instance) SetDeselectOnFocusLossEnabled 

func (self Instance) SetDeselectOnFocusLossEnabled(value bool)

func (Instance) SetDragAndDropSelectionEnabled 

func (self Instance) SetDragAndDropSelectionEnabled(value bool)

func (Instance) SetDrawControlChars 

func (self Instance) SetDrawControlChars(value bool)

func (Instance) SetEditable 

func (self Instance) SetEditable(value bool)

func (Instance) SetEmojiMenuEnabled 

func (self Instance) SetEmojiMenuEnabled(value bool)

func (Instance) SetExpandToTextLength 

func (self Instance) SetExpandToTextLength(value bool)

func (Instance) SetFlat 

func (self Instance) SetFlat(value bool)

func (Instance) SetKeepEditingOnTextSubmit 

func (self Instance) SetKeepEditingOnTextSubmit(value bool)

func (Instance) SetLanguage 

func (self Instance) SetLanguage(value string)

func (Instance) SetMaxLength 

func (self Instance) SetMaxLength(value int)

func (Instance) SetMiddleMousePasteEnabled 

func (self Instance) SetMiddleMousePasteEnabled(value bool)

func (*Instance) SetObject 

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPlaceholderText 

func (self Instance) SetPlaceholderText(value string)

func (Instance) SetRightIcon 

func (self Instance) SetRightIcon(value Texture2D.Instance)

func (Instance) SetSecret 

func (self Instance) SetSecret(value bool)

func (Instance) SetSecretCharacter 

func (self Instance) SetSecretCharacter(value string)

func (Instance) SetSelectAllOnFocus 

func (self Instance) SetSelectAllOnFocus(value bool)

func (Instance) SetSelectingEnabled 

func (self Instance) SetSelectingEnabled(value bool)

func (Instance) SetShortcutKeysEnabled 

func (self Instance) SetShortcutKeysEnabled(value bool)

func (Instance) SetStructuredTextBidiOverride 

func (self Instance) SetStructuredTextBidiOverride(value TextServer.StructuredTextParser)

func (Instance) SetStructuredTextBidiOverrideOptions 

func (self Instance) SetStructuredTextBidiOverrideOptions(value []any)

func (Instance) SetText 

func (self Instance) SetText(value string)

func (Instance) SetTextDirection 

func (self Instance) SetTextDirection(value Control.TextDirection)

func (Instance) SetVirtualKeyboardEnabled 

func (self Instance) SetVirtualKeyboardEnabled(value bool)

func (Instance) SetVirtualKeyboardShowOnFocus 

func (self Instance) SetVirtualKeyboardShowOnFocus(value bool)

func (Instance) SetVirtualKeyboardType 

func (self Instance) SetVirtualKeyboardType(value VirtualKeyboardType)

func (Instance) ShortcutKeysEnabled 

func (self Instance) ShortcutKeysEnabled() bool

func (Instance) StructuredTextBidiOverride 

func (self Instance) StructuredTextBidiOverride() TextServer.StructuredTextParser

func (Instance) StructuredTextBidiOverrideOptions 

func (self Instance) StructuredTextBidiOverrideOptions() []any

func (Instance) Text 

func (self Instance) Text() string

func (Instance) TextDirection 

func (self Instance) TextDirection() Control.TextDirection

func (Instance) Unedit 

func (self Instance) Unedit()

Allows exiting edit mode while preserving focus.

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

func (Instance) VirtualKeyboardEnabled 

func (self Instance) VirtualKeyboardEnabled() bool

func (Instance) VirtualKeyboardShowOnFocus 

func (self Instance) VirtualKeyboardShowOnFocus() bool

func (Instance) VirtualKeyboardType 

func (self Instance) VirtualKeyboardType() VirtualKeyboardType
type MenuItems int //gd:LineEdit.MenuItems

const (
	// Cuts (copies and clears) the selected text.
	MenuCut MenuItems = 0
	// Copies the selected text.
	MenuCopy MenuItems = 1
	// 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.StripEscapes].
	//
	// [String.StripEscapes]: https://pkg.go.dev/graphics.gd/classdb/String#Instance.StripEscapes
	MenuPaste MenuItems = 2
	// Erases the whole [LineEdit] text.
	//
	// [LineEdit]: https://pkg.go.dev/graphics.gd/classdb/LineEdit
	MenuClear MenuItems = 3
	// Selects the whole [LineEdit] text.
	//
	// [LineEdit]: https://pkg.go.dev/graphics.gd/classdb/LineEdit
	MenuSelectAll MenuItems = 4
	// Undoes the previous action.
	MenuUndo MenuItems = 5
	// Reverse the last undo action.
	MenuRedo MenuItems = 6
	// ID of "Text Writing Direction" submenu.
	MenuSubmenuTextDir MenuItems = 7
	// Sets text direction to inherited.
	MenuDirInherited MenuItems = 8
	// Sets text direction to automatic.
	MenuDirAuto MenuItems = 9
	// Sets text direction to left-to-right.
	MenuDirLtr MenuItems = 10
	// Sets text direction to right-to-left.
	MenuDirRtl MenuItems = 11
	// Toggles control character display.
	MenuDisplayUcc MenuItems = 12
	// ID of "Insert Control Character" submenu.
	MenuSubmenuInsertUcc MenuItems = 13
	// Inserts left-to-right mark (LRM) character.
	MenuInsertLrm MenuItems = 14
	// Inserts right-to-left mark (RLM) character.
	MenuInsertRlm MenuItems = 15
	// Inserts start of left-to-right embedding (LRE) character.
	MenuInsertLre MenuItems = 16
	// Inserts start of right-to-left embedding (RLE) character.
	MenuInsertRle MenuItems = 17
	// Inserts start of left-to-right override (LRO) character.
	MenuInsertLro MenuItems = 18
	// Inserts start of right-to-left override (RLO) character.
	MenuInsertRlo MenuItems = 19
	// Inserts pop direction formatting (PDF) character.
	MenuInsertPdf MenuItems = 20
	// Inserts Arabic letter mark (ALM) character.
	MenuInsertAlm MenuItems = 21
	// Inserts left-to-right isolate (LRI) character.
	MenuInsertLri MenuItems = 22
	// Inserts right-to-left isolate (RLI) character.
	MenuInsertRli MenuItems = 23
	// Inserts first strong isolate (FSI) character.
	MenuInsertFsi MenuItems = 24
	// Inserts pop direction isolate (PDI) character.
	MenuInsertPdi MenuItems = 25
	// Inserts zero width joiner (ZWJ) character.
	MenuInsertZwj MenuItems = 26
	// Inserts zero width non-joiner (ZWNJ) character.
	MenuInsertZwnj MenuItems = 27
	// Inserts word joiner (WJ) character.
	MenuInsertWj MenuItems = 28
	// Inserts soft hyphen (SHY) character.
	MenuInsertShy MenuItems = 29
	// Opens system emoji and symbol picker.
	MenuEmojiAndSymbol MenuItems = 30
	// Represents the size of the [MenuItems] enum.
	MenuMax MenuItems = 31
)

type MoreArgs 

type MoreArgs [1]gdclass.LineEdit

MoreArgs is a container for Instance functions with additional 'optional' arguments.

func (MoreArgs) Select 

func (self MoreArgs) Select(from int, to int)

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

line_edit.SetText("Welcome")
line_edit.Select()                 // Will select "Welcome".
line_edit.MoreArgs().Select(4, -1) // Will select "ome".
line_edit.MoreArgs().Select(2, 5)  // Will select "lco".

type VirtualKeyboardType 

type VirtualKeyboardType int //gd:LineEdit.VirtualKeyboardType

const (
	// Default text virtual keyboard.
	KeyboardTypeDefault VirtualKeyboardType = 0
	// Multiline virtual keyboard.
	KeyboardTypeMultiline VirtualKeyboardType = 1
	// Virtual number keypad, useful for PIN entry.
	KeyboardTypeNumber VirtualKeyboardType = 2
	// Virtual number keypad, useful for entering fractional numbers.
	KeyboardTypeNumberDecimal VirtualKeyboardType = 3
	// Virtual phone number keypad.
	KeyboardTypePhone VirtualKeyboardType = 4
	// Virtual keyboard with additional keys to assist with typing email addresses.
	KeyboardTypeEmailAddress VirtualKeyboardType = 5
	// 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 [KeyboardTypeDefault].
	KeyboardTypePassword VirtualKeyboardType = 6
	// Virtual keyboard with additional keys to assist with typing URLs.
	KeyboardTypeUrl VirtualKeyboardType = 7
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.