Class reference

TextEdit

Inherits Control

A multiline text editor.

Description

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. 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. Note: Most viewport, caret, and edit methods contain a caret_index argument for caret_multiple support. The argument should be one of the following: -1 for all carets, 0 for the main caret, or greater than 0 for secondary carets in the order they were created. Note: When holding down Alt, the vertical scroll wheel will scroll 5 times as fast as it would normally do. This also works in the Redot script editor.

Properties

bool backspace_deletes_composite_character_enabled = false

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.

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

bool caret_draw_when_editable_disabled = false

If true, caret will be visible when editable is disabled.

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 caret_move_on_right_click = true

If true, a right-click moves the caret at the mouse position before displaying the context menu. If false, the context menu ignores mouse location.

int caret_type = 0

Set the type of caret to draw.

bool clip_contents = true

bool context_menu_enabled = true

If true, a right-click displays the context menu.

String custom_word_separators = ""

The characters to consider as word delimiters if use_custom_word_separators is true. The characters should be defined without separation, for example #_!.

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. Text can still be dropped from other sources.

bool draw_control_chars = false

If true, control characters are displayed.

bool draw_spaces = false

If true, the "space" character will have a visible representation.

bool draw_tabs = false

If true, the "tab" character will have a visible representation.

bool editable = true

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

bool emoji_menu_enabled = true

If true, "Emoji and Symbols" menu is enabled.

bool empty_selection_clipboard_enabled = true

If true, copying or cutting without a selection is performed on all lines with a caret. Otherwise, copy and cut require a selection.

int focus_mode = 2

bool highlight_all_occurrences = false

If true, all occurrences of the selected text will be highlighted.

bool highlight_current_line = false

If true, the line containing the cursor is highlighted.

bool indent_wrapped_lines = false

If true, all wrapped lines are indented to the same amount as the unwrapped line.

String language = ""

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

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.

bool minimap_draw = false

If true, a minimap is shown, providing an outline of your source code. The minimap uses a fixed-width text size.

int minimap_width = 80

The width, in pixels, of the minimap.

int mouse_default_cursor_shape = 1

bool scroll_fit_content_height = false

If true, TextEdit will disable vertical scroll and fit minimum height to the number of visible lines. When both this property and scroll_fit_content_width are true, no scrollbars will be displayed.

bool scroll_fit_content_width = false

If true, TextEdit will disable horizontal scroll and fit minimum width to the widest line in the text. When both this property and scroll_fit_content_height are true, no scrollbars will be displayed.

int scroll_horizontal = 0

If there is a horizontal scrollbar, this determines the current horizontal scroll value in pixels.

bool scroll_past_end_of_file = false

Allow scrolling past the last line into "virtual" space.

bool scroll_smooth = false

Scroll smoothly over the text rather than jumping to the next location.

float scroll_v_scroll_speed = 80.0

Sets the scroll speed with the minimap or when scroll_smooth is enabled.

float scroll_vertical = 0.0

If there is a vertical scrollbar, this determines the current vertical scroll value in line numbers, starting at 0 for the top line.

bool selecting_enabled = true

If true, text can be selected. If false, text can not be selected by the user or by the select() or select_all() methods.

bool shortcut_keys_enabled = true

If true, shortcut keys for context menu items are enabled, even if the context menu is disabled.

int structured_text_bidi_override = 0

Set BiDi algorithm override for the structured text.

Array structured_text_bidi_override_options = []

Set additional options for BiDi override.

int text_direction = 0

Base text writing direction.

bool use_custom_word_separators = false

If false, using Ctrl + Left or Ctrl + Right (Cmd + Left or Cmd + Right on macOS) bindings will use the behavior of use_default_word_separators. If true, it will also stop the caret if a character within custom_word_separators is detected. Useful for subword moving. This behavior also will be applied to the behavior of text selection.

bool use_default_word_separators = true

If false, using Ctrl + Left or Ctrl + Right (Cmd + Left or Cmd + Right on macOS) bindings will stop moving caret only if a space or punctuation is detected. If true, it will also stop the caret if a character is part of !"#$%&'()*+,-./:;<=>?@[\]^`{|}~, the Unicode General Punctuation table, or the Unicode CJK Punctuation table. Useful for subword moving. This behavior also will be applied to the behavior of text selection.

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.

int wrap_mode = 0

Sets the line wrapping mode to use.

Methods

void _backspace(int caret_index) virtual

Override this method to define what happens when the user presses the backspace key.

void _copy(int caret_index) virtual

Override this method to define what happens when the user performs a copy operation.

void _cut(int caret_index) virtual

Override this method to define what happens when the user performs a cut operation.

void _handle_unicode_input(int unicode_char, int caret_index) virtual

Override this method to define what happens when the user types in the provided key unicode_char.

void _paste(int caret_index) virtual

Override this method to define what happens when the user performs a paste operation.

void _paste_primary_clipboard(int caret_index) virtual

Override this method to define what happens when the user performs a paste operation with middle mouse button. Note: This method is only implemented on Linux.

int add_caret(int line, int column)

Adds a new caret at the given location. Returns the index of the new caret, or -1 if the location is invalid.

void add_caret_at_carets(bool below)

Adds an additional caret above or below every caret. If below is true the new caret will be added below and above otherwise.

void add_gutter(int at = -1)

Register a new gutter to this TextEdit. Use at to have a specific gutter order. A value of -1 appends the gutter to the right.

void add_selection_for_next_occurrence()

Adds a selection and a caret for the next occurrence of the current selection. If there is no active selection, selects word under caret.

void adjust_carets_after_edit(int caret, int from_line, int from_col, int to_line, int to_col)

Deprecated.

No longer necessary since methods now adjust carets themselves.

This method does nothing.

void adjust_viewport_to_caret(int caret_index = 0)

Adjust the viewport so the caret is visible.

void apply_ime()

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

void backspace(int caret_index = -1)

Called when the user presses the backspace key. Can be overridden with _backspace().

void begin_complex_operation()

Starts a multipart edit. All edits will be treated as one action until end_complex_operation() is called.

void begin_multicaret_edit()

Starts an edit for multiple carets. The edit must be ended with end_multicaret_edit(). Multicaret edits can be used to edit text at multiple carets and delay merging the carets until the end, so the caret indexes aren't affected immediately. begin_multicaret_edit() and end_multicaret_edit() can be nested, and the merge will happen at the last end_multicaret_edit().

				begin_complex_operation()
				begin_multicaret_edit()
				for i in range(get_caret_count()):
					if multicaret_edit_ignore_caret(i):
						continue
					# Logic here.
				end_multicaret_edit()
				end_complex_operation()

void cancel_ime()

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

void center_viewport_to_caret(int caret_index = 0)

Centers the viewport on the line the editing caret is at. This also resets the scroll_horizontal value to 0.

void clear()

Performs a full reset of TextEdit, including undo history.

void clear_undo_history()

Clears the undo history.

void copy(int caret_index = -1)

Copies the current text selection. Can be overridden with _copy().

void cut(int caret_index = -1)

Cut's the current selection. Can be overridden with _cut().

void delete_selection(int caret_index = -1)

Deletes the selected text.

void deselect(int caret_index = -1)

Deselects the current selection.

void end_action()

Marks the end of steps in the current action started with start_action().

void end_complex_operation()

Ends a multipart edit, started with begin_complex_operation(). If called outside a complex operation, the current operation is pushed onto the undo/redo stack.

int get_caret_column(int caret_index = 0) const

Returns the column the editing caret is at.

int get_caret_count() const

Returns the number of carets in this TextEdit.

Vector2 get_caret_draw_pos(int caret_index = 0) const

Returns the caret pixel draw position.

PackedInt32Array get_caret_index_edit_order()

Deprecated.

Carets no longer need to be edited in any specific order. If the carets need to be sorted, use get_sorted_carets() instead.

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 insert_text_at_caret() are applied.

int get_caret_line(int caret_index = 0) const

Returns the line the editing caret is on.

int get_caret_wrap_index(int caret_index = 0) const

Returns the wrap index the editing caret is on.

int get_first_non_whitespace_column(int line) const

Returns the first column containing a non-whitespace character on the given line. If there is only whitespace, returns the number of characters.

int get_first_visible_line() const

Returns the first visible line.

int get_gutter_count() const

Returns the number of gutters registered.

String get_gutter_name(int gutter) const

Returns the name of the gutter at the given index.

int get_gutter_type(int gutter) const

Returns the type of the gutter at the given index. Gutters can contain icons, text, or custom visuals.

int get_gutter_width(int gutter) const

Returns the width of the gutter at the given index.

int get_indent_level(int line) const

Returns the indent level of the given line. This is the number of spaces and tabs at the beginning of the line, with the tabs taking the tab size into account (see get_tab_size()).

int get_last_full_visible_line_wrap_index() const

Returns the last visible wrap index of the last visible line.

int get_last_unhidden_line() const

Returns the last unhidden line in the entire TextEdit.

String get_line(int line) const

Returns the text of a specific line.

Color get_line_background_color(int line) const

Returns the custom background color of the given line. If no color is set, returns Color(0, 0, 0, 0).

Vector2i get_line_column_at_pos(Vector2i position, bool clamp_line = true, bool clamp_column = true) const

Returns the line and column at the given position. In the returned vector, x is the column and y is the line. If clamp_line is false and position is below the last line, Vector2i(-1, -1) is returned. If clamp_column is false and position is outside the column range of the line, Vector2i(-1, -1) is returned.

int get_line_count() const

Returns the number of lines in the text.

Color get_line_gutter_item_color(int line, int gutter) const

Returns the color currently in gutter at line.

Variant get_line_gutter_metadata(int line, int gutter) const

Returns the metadata currently in gutter at line.

int get_line_height() const

Returns the maximum value of the line height among all lines. Note: The return value is influenced by line_spacing and font_size. And it will not be less than 1.

Vector2i[] get_line_ranges_from_carets(bool only_selections = false, bool merge_adjacent = true) const

Returns an Array of line ranges where x is the first line and y is the last line. All lines within these ranges will have a caret on them or be part of a selection. Each line will only be part of one line range, even if it has multiple carets on it. If a selection's end column (get_selection_to_column()) is at column 0, that line will not be included. If a selection begins on the line after another selection ends and merge_adjacent is true, or they begin and end on the same line, one line range will include both selections.

int get_line_width(int line, int wrap_index = -1) const

Returns the width in pixels of the wrap_index on line.

String get_line_with_ime(int line) const

Returns line text as it is currently displayed, including IME composition string.

int get_line_wrap_count(int line) const

Returns the number of times the given line is wrapped.

int get_line_wrap_index_at_column(int line, int column) const

Returns the wrap index of the given column on the given line. This ranges from 0 to get_line_wrap_count().

Vector2 get_local_mouse_pos() const

Returns the local mouse position adjusted for the text direction.

PopupMenu get_menu() const

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

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_minimap_line_at_pos(Vector2i position) const

Returns the equivalent minimap line at position.

int get_minimap_visible_lines() const

Returns the number of lines that may be drawn on the minimap.

int get_next_composite_character_column(int line, int column) 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_line(), get_caret_column())

int get_next_visible_line_offset_from(int line, int visible_amount) const

Returns the count to the next visible line from line to line + visible_amount. Can also count backwards. For example if a TextEdit has 5 lines with lines 2 and 3 hidden, calling this with line = 1, visible_amount = 1 would return 3.

Vector2i get_pos_at_line_column(int line, int column) const

Returns the local position for the given line and column. If x or y of the returned vector equal -1, the position is outside of the viewable area of the control. Note: The Y position corresponds to the bottom side of the line. Use get_rect_at_line_column() to get the top side position.

int get_previous_composite_character_column(int line, int column) 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_line(), get_caret_column())

Rect2i get_rect_at_line_column(int line, int column) const

Returns the local position and size for the grapheme at the given line and column. If x or y position of the returned rect equal -1, the position is outside of the viewable area of the control. Note: The Y position of the returned rect corresponds to the top side of the line, unlike get_pos_at_line_column() which returns the bottom side.

float get_scroll_pos_for_line(int line, int wrap_index = 0) const

Returns the scroll position for wrap_index of line.

String get_selected_text(int caret_index = -1)

Returns the text inside the selection of a caret, or all the carets if caret_index is its default value -1.

int get_selection_at_line_column(int line, int column, bool include_edges = true, bool only_selections = true) const

Returns the caret index of the selection at the given line and column, or -1 if there is none. If include_edges is false, the position must be inside the selection and not at either end. If only_selections is false, carets without a selection will also be considered.

int get_selection_from_column(int caret_index = 0) const

Returns the selection begin column. Returns the caret column if there is no selection.

int get_selection_from_line(int caret_index = 0) const

Returns the selection begin line. Returns the caret line if there is no selection.

int get_selection_mode() const

Returns the current selection mode.

int get_selection_origin_column(int caret_index = 0) const

Returns the origin column of the selection. This is the opposite end from the caret.

int get_selection_origin_line(int caret_index = 0) const

Returns the origin line of the selection. This is the opposite end from the caret.

int get_selection_to_column(int caret_index = 0) const

Returns the selection end column. Returns the caret column if there is no selection.

int get_selection_to_line(int caret_index = 0) const

Returns the selection end line. Returns the caret line if there is no selection.

PackedInt32Array get_sorted_carets(bool include_ignored_carets = false) const

Returns the carets sorted by selection beginning from lowest line and column to highest (from top to bottom of text). If include_ignored_carets is false, carets from multicaret_edit_ignore_caret() will be ignored.

int get_tab_size() const

Returns the TextEdit's' tab size.

int get_total_gutter_width() const

Returns the total width of all gutters and internal padding.

int get_version() const

Returns the current version of the TextEdit. The version is a count of recorded operations by the undo/redo history.

int get_visible_line_count() const

Returns the number of lines that can visually fit, rounded down, based on this control's height.

int get_visible_line_count_in_range(int from_line, int to_line) const

Returns the total number of lines between from_line and to_line (inclusive) in the text. This includes wrapped lines and excludes folded lines. If the range covers all lines it is equivalent to get_total_visible_line_count().

String get_word_at_pos(Vector2 position) const

Returns the word at position.

String get_word_under_caret(int caret_index = -1) const

Returns a String text with the word under the caret's location.

bool has_redo() const

Returns true if a "redo" action is available.

bool has_selection(int caret_index = -1) const

Returns true if the user has selected text.

bool has_undo() const

Returns true if an "undo" action is available.

void insert_line_at(int line, String text)

Inserts a new line with text at line.

void insert_text(String text, int line, int column, bool before_selection_begin = true, bool before_selection_end = false)

Inserts the text at line and column. If before_selection_begin is true, carets and selections that begin at line and column will moved to the end of the inserted text, along with all carets after it. If before_selection_end is true, selections that end at line and column will be extended to the end of the inserted text. These parameters can be used to insert text inside of or outside of selections.

void insert_text_at_caret(String text, int caret_index = -1)

Insert the specified text at the caret position.

bool is_caret_after_selection_origin(int caret_index = 0) const

Returns true if the caret of the selection is after the selection origin. This can be used to determine the direction of the selection.

bool is_caret_visible(int caret_index = 0) const

Returns true if the caret is visible, false otherwise. A caret will be considered hidden if it is outside the scrollable area when scrolling is enabled. Note: is_caret_visible() does not account for a caret being off-screen if it is still within the scrollable area. It will return true even if the caret is off-screen as long as it meets TextEdit's own conditions for being visible. This includes uses of scroll_fit_content_width and scroll_fit_content_height that cause the TextEdit to expand beyond the viewport's bounds.

bool is_dragging_cursor() const

Returns true if the user is dragging their mouse for scrolling, selecting, or text dragging.

bool is_gutter_drawn(int gutter) const

Returns true if the gutter at the given index is currently drawn. See set_gutter_draw().

bool is_line_wrapped(int line) const

Returns if the given line is wrapped.

bool is_menu_visible() const

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

bool is_mouse_over_selection(bool edges, int caret_index = -1) const

Returns true if the mouse is over a selection. If edges is true, the edges are considered part of the selection.

void menu_option(int option)

Executes a given action as defined in the MenuItems enum.

void merge_gutters(int from_line, int to_line)

Merge the gutters from from_line into to_line. Only overwritable gutters will be copied. See set_gutter_overwritable().

void merge_overlapping_carets()

Merges any overlapping carets. Will favor the newest caret, or the caret with a selection. If is_in_mulitcaret_edit() is true, the merge will be queued to happen at the end of the multicaret edit. See begin_multicaret_edit() and end_multicaret_edit(). Note: 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.

bool multicaret_edit_ignore_caret(int caret_index) const

Returns true if the given caret_index should be ignored as part of a multicaret edit. See begin_multicaret_edit() and end_multicaret_edit(). Carets that should be ignored are ones that were part of removed text and will likely be merged at the end of the edit, or carets that were added during the edit. It is recommended to continue within a loop iterating on multiple carets if a caret should be ignored.

void paste(int caret_index = -1)

Paste at the current location. Can be overridden with _paste().

void paste_primary_clipboard(int caret_index = -1)

Pastes the primary clipboard.

void redo()

Perform redo operation.

void remove_caret(int caret)

Removes the given caret index. Note: This can result in adjustment of all other caret indices.

void remove_gutter(int gutter)

Removes the gutter at the given index.

void remove_line_at(int line, bool move_carets_down = true)

Removes the line of text at line. Carets on this line will attempt to match their previous visual x position. If move_carets_down is true carets will move to the next line down, otherwise carets will move up.

void remove_secondary_carets()

Removes all additional carets.

void remove_text(int from_line, int from_column, int to_line, int to_column)

Removes text between the given positions.

Perform a search inside the text. Search flags can be specified in the SearchFlags enum. In the returned vector, x is the column, y is the line. If no results are found, both are equal to -1.

				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
				
				Vector2I result = Search("print", (uint)TextEdit.SearchFlags.WholeWords, 0, 0);
				if (result.X != -1)
				{
					// Result found.
					int lineNumber = result.Y;
					int columnNumber = result.X;
				}

void select(int origin_line, int origin_column, int caret_line, int caret_column, int caret_index = 0)

Selects text from origin_line and origin_column to caret_line and caret_column for the given caret_index. This moves the selection origin and the caret. If the positions are the same, the selection will be deselected. If selecting_enabled is false, no selection will occur. Note: If supporting multiple carets this will not check for any overlap. See merge_overlapping_carets().

void select_all()

Select all the text. If selecting_enabled is false, no selection will occur.

void select_word_under_caret(int caret_index = -1)

Selects the word under the caret.

void set_caret_column(int column, bool adjust_viewport = true, int caret_index = 0)

Moves the caret to the specified column index. If adjust_viewport is true, the viewport will center at the caret position after the move occurs. Note: If supporting multiple carets this will not check for any overlap. See merge_overlapping_carets().

void set_caret_line(int line, bool adjust_viewport = true, bool can_be_hidden = true, int wrap_index = 0, int caret_index = 0)

Moves the caret to the specified line index. The caret column will be moved to the same visual position it was at the last time set_caret_column() was called, or clamped to the end of the line. If adjust_viewport is true, the viewport will center at the caret position after the move occurs. If can_be_hidden is true, the specified line can be hidden. If wrap_index is -1, the caret column will be clamped to the line's length. If wrap_index is greater than -1, the column will be moved to attempt to match the visual x position on the line's wrap_index to the position from the last time set_caret_column() was called. Note: If supporting multiple carets this will not check for any overlap. See merge_overlapping_carets().

void set_gutter_custom_draw(int column, Callable draw_callback)

Set a custom draw callback for the gutter at the given index. draw_callback must take the following arguments: A line index int, a gutter index int, and an area Rect2. This callback only works when the gutter type is GUTTER_TYPE_CUSTOM (see set_gutter_type()).

void set_gutter_name(int gutter, String name)

Sets the name of the gutter at the given index.

void set_gutter_type(int gutter, int type)

Sets the type of gutter at the given index. Gutters can contain icons, text, or custom visuals.

void set_gutter_width(int gutter, int width)

Set the width of the gutter at the given index.

void set_line(int line, String new_text)

Sets the text for a specific line. Carets on the line will attempt to keep their visual x position.

void set_line_as_center_visible(int line, int wrap_index = 0)

Positions the wrap_index of line at the center of the viewport.

void set_line_as_first_visible(int line, int wrap_index = 0)

Positions the wrap_index of line at the top of the viewport.

void set_line_as_last_visible(int line, int wrap_index = 0)

Positions the wrap_index of line at the bottom of the viewport.

void set_line_background_color(int line, Color color)

Sets the custom background color of the given line. If transparent, this color is applied on top of the default background color (See background_color). If set to Color(0, 0, 0, 0), no additional color is applied.

void set_line_gutter_item_color(int line, int gutter, Color color)

Sets the color for gutter on line to color.

void set_line_gutter_metadata(int line, int gutter, Variant metadata)

Sets the metadata for gutter on line to metadata.

void set_search_flags(int flags)

Sets the search flags. This is used with set_search_text() to highlight occurrences of the searched text. Search flags can be specified from the SearchFlags enum.

void set_selection_mode(int mode)

Sets the current selection mode.

void set_selection_origin_column(int column, int caret_index = 0)

Sets the selection origin column to the column for the given caret_index. If the selection origin is moved to the caret position, the selection will deselect.

void set_selection_origin_line(int line, bool can_be_hidden = true, int wrap_index = -1, int caret_index = 0)

Sets the selection origin line to the line for the given caret_index. If the selection origin is moved to the caret position, the selection will deselect. If can_be_hidden is false, The line will be set to the nearest unhidden line below or above. If wrap_index is -1, the selection origin column will be clamped to the line's length. If wrap_index is greater than -1, the column will be moved to attempt to match the visual x position on the line's wrap_index to the position from the last time set_selection_origin_column() or select() was called.

void set_tab_size(int size)

Sets the tab size for the TextEdit to use.

void set_tooltip_request_func(Callable callback)

Provide custom tooltip text. The callback method must take the following args: hovered_word: String.

void skip_selection_for_next_occurrence()

Moves a selection and a caret for the next occurrence of the current selection. If there is no active selection, moves to the next occurrence of the word under caret.

void swap_lines(int from_line, int to_line)

Swaps the two lines. Carets will be swapped with the lines.

void tag_saved_version()

Tag the current version as saved.

void undo()

Perform undo operation.

Signals

caret_changed()

Emitted when any caret changes position.

gutter_added()

Emitted when a gutter is added.

gutter_clicked(int line, int gutter)

Emitted when a gutter is clicked.

gutter_removed()

Emitted when a gutter is removed.

lines_edited_from(int from_line, int to_line)

Emitted immediately when the text changes. When text is added from_line will be less than to_line. On a remove to_line will be less than from_line.

text_changed()

Emitted when the text changes.

text_set()

Emitted when clear() is called or text is set.

Constants

MENU_CUT = 0

Enum: MenuItems

Cuts (copies and clears) the selected text.

MENU_COPY = 1

Enum: MenuItems

Copies the selected text.

MENU_PASTE = 2

Enum: MenuItems

Pastes the clipboard text over the selected text (or at the cursor's position).

MENU_CLEAR = 3

Enum: MenuItems

Erases the whole TextEdit text.

MENU_SELECT_ALL = 4

Enum: MenuItems

Selects the whole TextEdit text.

MENU_UNDO = 5

Enum: MenuItems

Undoes the previous action.

MENU_REDO = 6

Enum: MenuItems

Redoes the previous action.

MENU_SUBMENU_TEXT_DIR = 7

Enum: MenuItems

ID of "Text Writing Direction" submenu.

MENU_DIR_INHERITED = 8

Enum: MenuItems

Sets text direction to inherited.

MENU_DIR_AUTO = 9

Enum: MenuItems

Sets text direction to automatic.

MENU_DIR_LTR = 10

Enum: MenuItems

Sets text direction to left-to-right.

MENU_DIR_RTL = 11

Enum: MenuItems

Sets text direction to right-to-left.

MENU_DISPLAY_UCC = 12

Enum: MenuItems

Toggles control character display.

MENU_SUBMENU_INSERT_UCC = 13

Enum: MenuItems

ID of "Insert Control Character" submenu.

MENU_INSERT_LRM = 14

Enum: MenuItems

Inserts left-to-right mark (LRM) character.

MENU_INSERT_RLM = 15

Enum: MenuItems

Inserts right-to-left mark (RLM) character.

MENU_INSERT_LRE = 16

Enum: MenuItems

Inserts start of left-to-right embedding (LRE) character.

MENU_INSERT_RLE = 17

Enum: MenuItems

Inserts start of right-to-left embedding (RLE) character.

MENU_INSERT_LRO = 18

Enum: MenuItems

Inserts start of left-to-right override (LRO) character.

MENU_INSERT_RLO = 19

Enum: MenuItems

Inserts start of right-to-left override (RLO) character.

MENU_INSERT_PDF = 20

Enum: MenuItems

Inserts pop direction formatting (PDF) character.

MENU_INSERT_ALM = 21

Enum: MenuItems

Inserts Arabic letter mark (ALM) character.

MENU_INSERT_LRI = 22

Enum: MenuItems

Inserts left-to-right isolate (LRI) character.

MENU_INSERT_RLI = 23

Enum: MenuItems

Inserts right-to-left isolate (RLI) character.

MENU_INSERT_FSI = 24

Enum: MenuItems

Inserts first strong isolate (FSI) character.

MENU_INSERT_PDI = 25

Enum: MenuItems

Inserts pop direction isolate (PDI) character.

MENU_INSERT_ZWJ = 26

Enum: MenuItems

Inserts zero width joiner (ZWJ) character.

MENU_INSERT_ZWNJ = 27

Enum: MenuItems

Inserts zero width non-joiner (ZWNJ) character.

MENU_INSERT_WJ = 28

Enum: MenuItems

Inserts word joiner (WJ) character.

MENU_INSERT_SHY = 29

Enum: MenuItems

Inserts soft hyphen (SHY) character.

MENU_EMOJI_AND_SYMBOL = 30

Enum: MenuItems

Opens system emoji and symbol picker.

MENU_MAX = 31

Enum: MenuItems

Represents the size of the MenuItems enum.

ACTION_NONE = 0

Enum: EditAction

No current action.

ACTION_TYPING = 1

Enum: EditAction

A typing action.

ACTION_BACKSPACE = 2

Enum: EditAction

A backwards delete action.

ACTION_DELETE = 3

Enum: EditAction

A forward delete action.

SEARCH_MATCH_CASE = 1

Enum: SearchFlags

Match case when searching.

SEARCH_WHOLE_WORDS = 2

Enum: SearchFlags

Match whole words when searching.

SEARCH_BACKWARDS = 4

Enum: SearchFlags

Search from end to beginning.

CARET_TYPE_LINE = 0

Enum: CaretType

Vertical line caret.

CARET_TYPE_BLOCK = 1

Enum: CaretType

Block caret.

SELECTION_MODE_NONE = 0

Enum: SelectionMode

Not selecting.

SELECTION_MODE_SHIFT = 1

Enum: SelectionMode

Select as if shift is pressed.

SELECTION_MODE_POINTER = 2

Enum: SelectionMode

Select single characters as if the user single clicked.

SELECTION_MODE_WORD = 3

Enum: SelectionMode

Select whole words as if the user double clicked.

SELECTION_MODE_LINE = 4

Enum: SelectionMode

Select whole lines as if the user triple clicked.

LINE_WRAPPING_NONE = 0

Enum: LineWrappingMode

Line wrapping is disabled.

LINE_WRAPPING_BOUNDARY = 1

Enum: LineWrappingMode

Line wrapping occurs at the control boundary, beyond what would normally be visible.

GUTTER_TYPE_CUSTOM = 2

Enum: GutterType

When a gutter is set to custom using set_gutter_type(), it is used to contain custom visuals controlled by a callback method set via the set_gutter_custom_draw() method.

Theme properties

Color caret_background_color = Color(0, 0, 0, 1)

Color of the text behind the caret when using a block caret.

Color caret_color = Color(0.875, 0.875, 0.875, 1)

Color of the caret. This can be set to a fully transparent color to hide the caret entirely.

Color current_line_color = Color(0.25, 0.25, 0.26, 0.8)

Background Color of the line containing the caret.

Color font_color = Color(0.875, 0.875, 0.875, 1)

Sets the font Color.

Color font_outline_color = Color(0, 0, 0, 1)

The tint of text outline of the TextEdit.

Color font_readonly_color = Color(0.875, 0.875, 0.875, 0.5)

Sets the font Color when editable is disabled.

Color font_selected_color = Color(0, 0, 0, 0)

Sets the Color of the selected text. If equal to Color(0, 0, 0, 0), it will be ignored.

Color search_result_border_color = Color(0.3, 0.3, 0.3, 0.4)

Color of the border around text that matches the search query.

Color search_result_color = Color(0.3, 0.3, 0.3, 1)

Color behind the text that matches the search query.

Color selection_color = Color(0.5, 0.5, 0.5, 1)

Sets the highlight Color of text selections.

int caret_width = 1

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 0 or lower, the caret width is automatically set to 1 pixel and multiplied by the display scaling factor.

int line_spacing = 4

Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.

int font_size

Sets default font size.

StyleBox focus

Sets the StyleBox when in 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.

Source revision 4f5b14abade2
Connection interrupted. Reload×

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.