A multiline text editor.
A multiline text editor. It also has limited facilities for editing code, such as syntax highlighting support. For more advanced facilities for editing code, see [CodeEdit]. [b]Note:[/b] Most viewport, caret and edit methods contain a [code]caret_index[/code] argument for [member caret_multiple] support. The argument should be one of the following: [code]-1[/code] for all carets, [code]0[/code] for the main caret, or greater than [code]0[/code] for secondary carets. [b]Note:[/b] When holding down [kbd]Alt[/kbd], the vertical scroll wheel will scroll 5 times as fast as it would normally do. This also works in the Godot script editor.
Override this method to define what happens when the user presses the backspace key.
Override this method to define what happens when the user performs a copy operation.
Override this method to define what happens when the user performs a cut operation.
Override this method to define what happens when the user types in the provided key [param unicode_char].
Override this method to define what happens when the user performs a paste operation.
Override this method to define what happens when the user performs a paste operation with middle mouse button. [b]Note:[/b] This method is only implemented on Linux.
Adds a new caret at the given location. Returns the index of the new caret, or [code]-1[/code] if the location is invalid.
Adds an additional caret above or below every caret. If [param below] is true the new caret will be added below and above otherwise.
Register a new gutter to this [TextEdit]. Use [param at] to have a specific gutter order. A value of [code]-1[/code] appends the gutter to the right.
Adds a selection and a caret for the next occurrence of the current selection. If there is no active selection, selects word under caret.
Reposition the carets affected by the edit. This assumes edits are applied in edit order, see [method get_caret_index_edit_order].
Adjust the viewport so the caret is visible.
Called when the user presses the backspace key. Can be overridden with [method _backspace].
Starts a multipart edit. All edits will be treated as one action until [method end_complex_operation] is called.
Centers the viewport on the line the editing caret is at. This also resets the [member scroll_horizontal] value to [code]0[/code].
Performs a full reset of [TextEdit], including undo history.
Clears the undo history.
Copies the current text selection. Can be overridden with [method _copy].
Cut's the current selection. Can be overridden with [method _cut].
Deletes the selected text.
Deselects the current selection.
Marks the end of steps in the current action started with [method start_action].
Ends a multipart edit, started with [method begin_complex_operation]. If called outside a complex operation, the current operation is pushed onto the undo/redo stack.
Returns the column the editing caret is at.
Returns the number of carets in this [TextEdit].
Returns the caret pixel draw position.
Returns a list of caret indexes in their edit order, this done from bottom to top. Edit order refers to the way actions such as [method insert_text_at_caret] are applied.
Returns the line the editing caret is on.
Returns the wrap index the editing caret is on.
Returns the first column containing a non-whitespace character.
Returns the first visible line.
Returns the number of gutters registered.
Returns the name of the gutter at the given index.
Returns the type of the gutter at the given index.
Returns the width of the gutter at the given index.
Returns the [HScrollBar] used by [TextEdit].
Returns the number of spaces and [code]tab * tab_size[/code] before the first char.
Returns the last visible line. Use [method get_last_full_visible_line_wrap_index] for the wrap index.
Returns the last visible wrap index of the last visible line.
Returns the last unhidden line in the entire [TextEdit].
Returns the text of a specific line.
Returns the current background color of the line. [code]Color(0, 0, 0, 0)[/code] is returned if no color is set.
Returns the line and column at the given position. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. If [param allow_out_of_bounds] is [code]false[/code] and the position is not over the text, both vector values will be set to [code]-1[/code].
Returns the number of lines in the text.
Returns the icon currently in [param gutter] at [param line].
Returns the color currently in [param gutter] at [param line].
Returns the metadata currently in [param gutter] at [param line].
Returns the text currently in [param gutter] at [param line].
Returns the maximum value of the line height among all lines. [b]Note:[/b] The return value is influenced by [theme_item line_spacing] and [theme_item font_size]. And it will not be less than [code]1[/code].
Returns the width in pixels of the [param wrap_index] on [param line].
Returns the number of times the given line is wrapped.
Returns the wrap index of the given line column.
Returns an array of [String]s representing each wrapped index.
Returns the local mouse position adjusted for the text direction.
Returns the [PopupMenu] of this [TextEdit]. By default, this menu is displayed when right-clicking on the [TextEdit]. You can add custom menu items or remove standard ones. Make sure your IDs don't conflict with the standard ones (see [enum MenuItems]). For example: [codeblocks] [gdscript] 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()) [/gdscript] [csharp] public override void _Ready() { var menu = GetMenu(); // Remove all items after "Redo". menu.ItemCount = menu.GetItemIndex(TextEdit.MenuItems.Redo) + 1; // Add custom items. menu.AddSeparator(); menu.AddItem("Insert Date", TextEdit.MenuItems.Max + 1); // Add event handler. menu.IdPressed += OnItemPressed; }

public void OnItemPressed(int id) { if (id == TextEdit.MenuItems.Max + 1) { InsertTextAtCaret(Time.GetDateStringFromSystem()); } } [/csharp] [/codeblocks] [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 Window.visible] property.
Returns the equivalent minimap line at [param position].
Returns the number of lines that may be drawn on the minimap.
Similar to [method get_next_visible_line_offset_from], but takes into account the line wrap indexes. In the returned vector, [code]x[/code] is the line, [code]y[/code] is the wrap index.
Returns the count to the next visible line from [param line] to [code]line + visible_amount[/code]. Can also count backwards. For example if a [TextEdit] has 5 lines with lines 2 and 3 hidden, calling this with [code]line = 1, visible_amount = 1[/code] would return 3.
Returns the local position for the given [param line] and [param column]. If [code]x[/code] or [code]y[/code] of the returned vector equal [code]-1[/code], the position is outside of the viewable area of the control. [b]Note:[/b] The Y position corresponds to the bottom side of the line. Use [method get_rect_at_line_column] to get the top side position.
Returns the local position and size for the grapheme at the given [param line] and [param column]. If [code]x[/code] or [code]y[/code] position of the returned rect equal [code]-1[/code], the position is outside of the viewable area of the control. [b]Note:[/b] The Y position of the returned rect corresponds to the top side of the line, unlike [method get_pos_at_line_column] which returns the bottom side.
Returns the last tagged saved version from [method tag_saved_version].
Returns the scroll position for [param wrap_index] of [param line].
Returns the text inside the selection of a caret, or all the carets if [param caret_index] is its default value [code]-1[/code].
Returns the original start column of the selection.
Returns the selection begin column.
Returns the selection begin line.
Returns the original start line of the selection.
Returns the current selection mode.
Returns the selection end column.
Returns the selection end line.
Returns the [TextEdit]'s' tab size.
Returns the total width of all gutters and internal padding.
Returns the number of lines that may be drawn.
Returns the [VScrollBar] of the [TextEdit].
Returns the current version of the [TextEdit]. The version is a count of recorded operations by the undo/redo history.
Returns the number of visible lines, including wrapped text.
Returns the total number of visible + wrapped lines between the two lines.
Returns the word at [param position].
Returns a [String] text with the word under the caret's location.
Returns if the user has IME text.
Returns [code]true[/code] if a "redo" action is available.
Returns [code]true[/code] if the user has selected text.
Returns [code]true[/code] if an "undo" action is available.
Inserts a new line with [param text] at [param line].
Insert the specified text at the caret position.
Returns [code]true[/code] if the caret is visible on the screen.
Returns [code]true[/code] if the user is dragging their mouse for scrolling or selecting.
Returns whether the gutter is clickable.
Returns whether the gutter is currently drawn.
Returns whether the gutter is overwritable.
Returns whether the gutter on the given line is clickable.
Returns if the given line is wrapped.
Returns whether the menu is visible. Use this instead of [code]get_menu().visible[/code] to improve performance (so the creation of the menu is avoided).
Returns whether the mouse is over selection. If [param edges] is [code]true[/code], the edges are considered part of the selection.
Returns whether the user is in overtype mode.
Executes a given action as defined in the [enum MenuItems] enum.
Merge the gutters from [param from_line] into [param to_line]. Only overwritable gutters will be copied.
Merges any overlapping carets. Will favor the newest caret, or the caret with a selection. [b]Note:[/b] This is not called when a caret changes position but after certain actions, so it is possible to get into a state where carets overlap.
Paste at the current location. Can be overridden with [method _paste].
Pastes the primary clipboard.
Perform redo operation.
Removes the given caret index. [b]Note:[/b] This can result in adjustment of all other caret indices.
Removes the gutter from this [TextEdit].
Removes all additional carets.
Removes text between the given positions. [b]Note:[/b] This does not adjust the caret or selection, which as a result it can end up in an invalid position.
Perform a search inside the text. Search flags can be specified in the [enum SearchFlags] enum. In the returned vector, [code]x[/code] is the column, [code]y[/code] is the line. If no results are found, both are equal to [code]-1[/code]. [codeblocks] [gdscript] var result = search("print", SEARCH_WHOLE_WORDS, 0, 0) if result.x != -1: # Result found. var line_number = result.y var column_number = result.x [/gdscript] [csharp] Vector2I result = Search("print", (uint)TextEdit.SearchFlags.WholeWords, 0, 0); if (result.X != -1) { // Result found. int lineNumber = result.Y; int columnNumber = result.X; } [/csharp] [/codeblocks]
Perform selection, from line/column to line/column. If [member selecting_enabled] is [code]false[/code], no selection will occur.
Select all the text. If [member selecting_enabled] is [code]false[/code], no selection will occur.
Selects the word under the caret.
Moves the caret to the specified [param column] index. If [param adjust_viewport] is [code]true[/code], the viewport will center at the caret position after the move occurs. [b]Note:[/b] If supporting multiple carets this will not check for any overlap. See [method merge_overlapping_carets].
Moves the caret to the specified [param line] index. If [param adjust_viewport] is [code]true[/code], the viewport will center at the caret position after the move occurs. If [param can_be_hidden] is [code]true[/code], the specified [param line] can be hidden. [b]Note:[/b] If supporting multiple carets this will not check for any overlap. See [method merge_overlapping_carets].
Sets the gutter as clickable. This will change the mouse cursor to a pointing hand when hovering over the gutter.
Set a custom draw method for the gutter. The callback method must take the following args: [code]line: int, gutter: int, Area: Rect2[/code].
Sets whether the gutter should be drawn.
Sets the name of the gutter.
Sets the gutter to overwritable. See [method merge_gutters].
Sets the type of gutter.
Set the width of the gutter.
Sets the text for a specific line.
Positions the [param wrap_index] of [param line] at the center of the viewport.
Positions the [param wrap_index] of [param line] at the top of the viewport.
Positions the [param wrap_index] of [param line] at the bottom of the viewport.
Sets the current background color of the line. Set to [code]Color(0, 0, 0, 0)[/code] for no color.
If [param clickable] is [code]true[/code], makes the [param gutter] on [param line] clickable. See [signal gutter_clicked].
Sets the icon for [param gutter] on [param line] to [param icon].
Sets the color for [param gutter] on [param line] to [param color].
Sets the metadata for [param gutter] on [param line] to [param metadata].
Sets the text for [param gutter] on [param line] to [param text].
If [code]true[/code], sets the user into overtype mode. When the user types in this mode, it will override existing text.
Sets the search [param flags]. This is used with [method set_search_text] to highlight occurrences of the searched text. Search flags can be specified from the [enum SearchFlags] enum.
Sets the search text. See [method set_search_flags].
Sets the current selection mode.
Sets the tab size for the [TextEdit] to use.
Provide custom tooltip text. The callback method must take the following args: [code]hovered_word: String[/code].
Starts an action, will end the current action if [param action] is different. An action will also end after a call to [method end_action], after [member ProjectSettings.gui/timers/text_edit_idle_detect_sec] is triggered or a new undoable step outside the [method start_action] and [method end_action] calls.
Swaps the two lines.
Tag the current version as saved.
Perform undo operation.
- If [member wrap_mode] is set to [constant LINE_WRAPPING_BOUNDARY], sets text wrapping mode. To see how each mode behaves, see [enum TextServer.AutowrapMode].
- If [code]true[/code], makes the caret blink.
- The interval at which the caret blinks (in seconds).
- If [code]true[/code], caret will be visible when [member editable] is disabled.
- Allow moving caret, selecting and removing the individual composite character components. [b]Note:[/b] [kbd]Backspace[/kbd] is always removing individual composite character components.
- If [code]true[/code], a right-click moves the caret at the mouse position before displaying the context menu. If [code]false[/code], the context menu disregards mouse location.
- Sets if multiple carets are allowed.
- Set the type of caret to draw.
- If [code]true[/code], a right-click displays the context menu.
- If [code]true[/code], the selected text will be deselected when focus is lost.
- If [code]true[/code], allow drag and drop of selected text.
- If [code]true[/code], control characters are displayed.
- If [code]true[/code], the "space" character will have a visible representation.
- If [code]true[/code], the "tab" character will have a visible representation.
- If [code]false[/code], existing text cannot be modified and new text cannot be added.
- If [code]true[/code], all occurrences of the selected text will be highlighted.
- If [code]true[/code], the line containing the cursor is highlighted.
- Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
- If [code]false[/code], using middle mouse button to paste clipboard will be disabled. [b]Note:[/b] This method is only implemented on Linux.
- If [code]true[/code], a minimap is shown, providing an outline of your source code.
- The width, in pixels, of the minimap.
- Text shown when the [TextEdit] is empty. It is [b]not[/b] the [TextEdit]'s default value (see [member text]).
- If [code]true[/code], [TextEdit] will disable vertical scroll and fit minimum height to the number of visible lines.
- If there is a horizontal scrollbar, this determines the current horizontal scroll value in pixels.
- Allow scrolling past the last line into "virtual" space.
- Scroll smoothly over the text rather then jumping to the next location.
- Sets the scroll speed with the minimap or when [member scroll_smooth] is enabled.
- If there is a vertical scrollbar, this determines the current vertical scroll value in line numbers, starting at 0 for the top line.
- If [code]true[/code], text can be selected. If [code]false[/code], text can not be selected by the user or by the [method select] or [method select_all] methods.
- If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled.
- Set BiDi algorithm override for the structured text.
- Set additional options for BiDi override.
- Sets the [SyntaxHighlighter] to use.
- String value of the [TextEdit].
- Base text writing direction.
- If [code]true[/code], the native virtual keyboard is shown when focused on platforms that support it.
- Sets the line wrapping mode to use.
Emitted when the caret changes position.
Emitted when a gutter is added.
Emitted when a gutter is clicked.
Emitted when a gutter is removed.
Emitted immediately when the text changes. When text is added [param from_line] will be less than [param to_line]. On a remove [param to_line] will be less than [param from_line].
Emitted when the text changes.
Emitted when [method clear] is called or [member text] is set.
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).
Erases the whole [TextEdit] text.
Selects the whole [TextEdit] text.
Undoes the previous action.
Redoes the previous 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.
Represents the size of the [enum MenuItems] enum.
No current action.
A typing action.
A backwards delete action.
A forward delete action.
Match case when searching.
Match whole words when searching.
Search from end to beginning.
Vertical line caret.
Block caret.
Not selecting.
Select as if [code]shift[/code] is pressed.
Select single characters as if the user single clicked.
Select whole words as if the user double clicked.
Select whole lines as if the user triple clicked.
Line wrapping is disabled.
Line wrapping occurs at the control boundary, beyond what would normally be visible.
Draw a string.
Draw an icon.
Custom draw.
Sets the background [Color] of this [TextEdit].
[Color] of the text behind the caret when using a block caret.
[Color] of the caret. This can be set to a fully transparent color to hide the caret entirely.
Background [Color] of the line containing the caret.
Sets the font [Color].
The tint of text outline of the [TextEdit].
Font color for [member placeholder_text].
Sets the font [Color] when [member editable] is disabled.
Sets the [Color] of the selected text. If equal to [code]Color(0, 0, 0, 0)[/code], it will be ignored.
[Color] of the border around text that matches the search query.
[Color] behind the text that matches the search query.
Sets the highlight [Color] of text selections.
Sets the highlight [Color] of multiple occurrences. [member highlight_all_occurrences] has to be enabled.
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. If set to [code]0[/code] or lower, the caret width is automatically set to 1 pixel and multiplied by the display scaling factor.
Sets the spacing between the lines.
The size of the text outline. [b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Sets the default [Font].
Sets default font size.
Sets a custom [Texture2D] for space text characters.
Sets a custom [Texture2D] for tab text characters.
Sets the [StyleBox] when in focus. The [code]focus[/code] [StyleBox] is displayed [i]over[/i] 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.
Sets the [StyleBox] of this [TextEdit].
Sets the [StyleBox] of this [TextEdit] when [member editable] is disabled.