<?xml version="1.0" encoding="UTF-8" ?> <class name="TextEdit" inherits="Control" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A multiline text editor. </brief_description> <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]. [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. </description> <tutorials> </tutorials> <methods> <method name="_backspace" qualifiers="virtual"> <return type="void" /> <param index="0" name="caret_index" type="int" /> <description> Override this method to define what happens when the user presses the backspace key. </description> </method> <method name="_copy" qualifiers="virtual"> <return type="void" /> <param index="0" name="caret_index" type="int" /> <description> Override this method to define what happens when the user performs a copy operation. </description> </method> <method name="_cut" qualifiers="virtual"> <return type="void" /> <param index="0" name="caret_index" type="int" /> <description> Override this method to define what happens when the user performs a cut operation. </description> </method> <method name="_handle_unicode_input" qualifiers="virtual"> <return type="void" /> <param index="0" name="unicode_char" type="int" /> <param index="1" name="caret_index" type="int" /> <description> Override this method to define what happens when the user types in the provided key [param unicode_char]. </description> </method> <method name="_paste" qualifiers="virtual"> <return type="void" /> <param index="0" name="caret_index" type="int" /> <description> Override this method to define what happens when the user performs a paste operation. </description> </method> <method name="_paste_primary_clipboard" qualifiers="virtual"> <return type="void" /> <param index="0" name="caret_index" type="int" /> <description> 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. </description> </method> <method name="add_caret"> <return type="int" /> <param index="0" name="line" type="int" /> <param index="1" name="col" type="int" /> <description> Adds a new caret at the given location. Returns the index of the new caret, or [code]-1[/code] if the location is invalid. </description> </method> <method name="add_caret_at_carets"> <return type="void" /> <param index="0" name="below" type="bool" /> <description> Adds an additional caret above or below every caret. If [param below] is true the new caret will be added below and above otherwise. </description> </method> <method name="add_gutter"> <return type="void" /> <param index="0" name="at" type="int" default="-1" /> <description> 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. </description> </method> <method name="add_selection_for_next_occurrence"> <return type="void" /> <description> Adds a selection and a caret for the next occurrence of the current selection. If there is no active selection, selects word under caret. </description> </method> <method name="adjust_carets_after_edit"> <return type="void" /> <param index="0" name="caret" type="int" /> <param index="1" name="from_line" type="int" /> <param index="2" name="from_col" type="int" /> <param index="3" name="to_line" type="int" /> <param index="4" name="to_col" type="int" /> <description> Reposition the carets affected by the edit. This assumes edits are applied in edit order, see [method get_caret_index_edit_order]. </description> </method> <method name="adjust_viewport_to_caret"> <return type="void" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Adjust the viewport so the caret is visible. </description> </method> <method name="backspace"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Called when the user presses the backspace key. Can be overridden with [method _backspace]. </description> </method> <method name="begin_complex_operation"> <return type="void" /> <description> Starts a multipart edit. All edits will be treated as one action until [method end_complex_operation] is called. </description> </method> <method name="center_viewport_to_caret"> <return type="void" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Centers the viewport on the line the editing caret is at. This also resets the [member scroll_horizontal] value to [code]0[/code]. </description> </method> <method name="clear"> <return type="void" /> <description> Performs a full reset of [TextEdit], including undo history. </description> </method> <method name="clear_undo_history"> <return type="void" /> <description> Clears the undo history. </description> </method> <method name="copy"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Copies the current text selection. Can be overridden with [method _copy]. </description> </method> <method name="cut"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Cut's the current selection. Can be overridden with [method _cut]. </description> </method> <method name="delete_selection"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Deletes the selected text. </description> </method> <method name="deselect"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Deselects the current selection. </description> </method> <method name="end_action"> <return type="void" /> <description> Marks the end of steps in the current action started with [method start_action]. </description> </method> <method name="end_complex_operation"> <return type="void" /> <description> 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. </description> </method> <method name="get_caret_column" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the column the editing caret is at. </description> </method> <method name="get_caret_count" qualifiers="const"> <return type="int" /> <description> Returns the number of carets in this [TextEdit]. </description> </method> <method name="get_caret_draw_pos" qualifiers="const"> <return type="Vector2" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the caret pixel draw position. </description> </method> <method name="get_caret_index_edit_order"> <return type="PackedInt32Array" /> <description> 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. </description> </method> <method name="get_caret_line" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the line the editing caret is on. </description> </method> <method name="get_caret_wrap_index" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the wrap index the editing caret is on. </description> </method> <method name="get_first_non_whitespace_column" qualifiers="const"> <return type="int" /> <param index="0" name="line" type="int" /> <description> Returns the first column containing a non-whitespace character. </description> </method> <method name="get_first_visible_line" qualifiers="const"> <return type="int" /> <description> Returns the first visible line. </description> </method> <method name="get_gutter_count" qualifiers="const"> <return type="int" /> <description> Returns the number of gutters registered. </description> </method> <method name="get_gutter_name" qualifiers="const"> <return type="String" /> <param index="0" name="gutter" type="int" /> <description> Returns the name of the gutter at the given index. </description> </method> <method name="get_gutter_type" qualifiers="const"> <return type="int" enum="TextEdit.GutterType" /> <param index="0" name="gutter" type="int" /> <description> Returns the type of the gutter at the given index. </description> </method> <method name="get_gutter_width" qualifiers="const"> <return type="int" /> <param index="0" name="gutter" type="int" /> <description> Returns the width of the gutter at the given index. </description> </method> <method name="get_h_scroll_bar" qualifiers="const"> <return type="HScrollBar" /> <description> Returns the [HScrollBar] used by [TextEdit]. </description> </method> <method name="get_indent_level" qualifiers="const"> <return type="int" /> <param index="0" name="line" type="int" /> <description> Returns the number of spaces and [code]tab * tab_size[/code] before the first char. </description> </method> <method name="get_last_full_visible_line" qualifiers="const"> <return type="int" /> <description> Returns the last visible line. Use [method get_last_full_visible_line_wrap_index] for the wrap index. </description> </method> <method name="get_last_full_visible_line_wrap_index" qualifiers="const"> <return type="int" /> <description> Returns the last visible wrap index of the last visible line. </description> </method> <method name="get_last_unhidden_line" qualifiers="const"> <return type="int" /> <description> Returns the last unhidden line in the entire [TextEdit]. </description> </method> <method name="get_line" qualifiers="const"> <return type="String" /> <param index="0" name="line" type="int" /> <description> Returns the text of a specific line. </description> </method> <method name="get_line_background_color" qualifiers="const"> <return type="Color" /> <param index="0" name="line" type="int" /> <description> Returns the current background color of the line. [code]Color(0, 0, 0, 0)[/code] is returned if no color is set. </description> </method> <method name="get_line_column_at_pos" qualifiers="const"> <return type="Vector2i" /> <param index="0" name="position" type="Vector2i" /> <param index="1" name="allow_out_of_bounds" type="bool" default="true" /> <description> 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]. </description> </method> <method name="get_line_count" qualifiers="const"> <return type="int" /> <description> Returns the number of lines in the text. </description> </method> <method name="get_line_gutter_icon" qualifiers="const"> <return type="Texture2D" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <description> Returns the icon currently in [param gutter] at [param line]. </description> </method> <method name="get_line_gutter_item_color" qualifiers="const"> <return type="Color" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <description> Returns the color currently in [param gutter] at [param line]. </description> </method> <method name="get_line_gutter_metadata" qualifiers="const"> <return type="Variant" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <description> Returns the metadata currently in [param gutter] at [param line]. </description> </method> <method name="get_line_gutter_text" qualifiers="const"> <return type="String" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <description> Returns the text currently in [param gutter] at [param line]. </description> </method> <method name="get_line_height" qualifiers="const"> <return type="int" /> <description> 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]. </description> </method> <method name="get_line_width" qualifiers="const"> <return type="int" /> <param index="0" name="line" type="int" /> <param index="1" name="wrap_index" type="int" default="-1" /> <description> Returns the width in pixels of the [param wrap_index] on [param line]. </description> </method> <method name="get_line_wrap_count" qualifiers="const"> <return type="int" /> <param index="0" name="line" type="int" /> <description> Returns the number of times the given line is wrapped. </description> </method> <method name="get_line_wrap_index_at_column" qualifiers="const"> <return type="int" /> <param index="0" name="line" type="int" /> <param index="1" name="column" type="int" /> <description> Returns the wrap index of the given line column. </description> </method> <method name="get_line_wrapped_text" qualifiers="const"> <return type="PackedStringArray" /> <param index="0" name="line" type="int" /> <description> Returns an array of [String]s representing each wrapped index. </description> </method> <method name="get_local_mouse_pos" qualifiers="const"> <return type="Vector2" /> <description> Returns the local mouse position adjusted for the text direction. </description> </method> <method name="get_menu" qualifiers="const"> <return type="PopupMenu" /> <description> 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. </description> </method> <method name="get_minimap_line_at_pos" qualifiers="const"> <return type="int" /> <param index="0" name="position" type="Vector2i" /> <description> Returns the equivalent minimap line at [param position]. </description> </method> <method name="get_minimap_visible_lines" qualifiers="const"> <return type="int" /> <description> Returns the number of lines that may be drawn on the minimap. </description> </method> <method name="get_next_visible_line_index_offset_from" qualifiers="const"> <return type="Vector2i" /> <param index="0" name="line" type="int" /> <param index="1" name="wrap_index" type="int" /> <param index="2" name="visible_amount" type="int" /> <description> 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. </description> </method> <method name="get_next_visible_line_offset_from" qualifiers="const"> <return type="int" /> <param index="0" name="line" type="int" /> <param index="1" name="visible_amount" type="int" /> <description> 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. </description> </method> <method name="get_pos_at_line_column" qualifiers="const"> <return type="Vector2i" /> <param index="0" name="line" type="int" /> <param index="1" name="column" type="int" /> <description> 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. </description> </method> <method name="get_rect_at_line_column" qualifiers="const"> <return type="Rect2i" /> <param index="0" name="line" type="int" /> <param index="1" name="column" type="int" /> <description> 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. </description> </method> <method name="get_saved_version" qualifiers="const"> <return type="int" /> <description> Returns the last tagged saved version from [method tag_saved_version]. </description> </method> <method name="get_scroll_pos_for_line" qualifiers="const"> <return type="float" /> <param index="0" name="line" type="int" /> <param index="1" name="wrap_index" type="int" default="0" /> <description> Returns the scroll position for [param wrap_index] of [param line]. </description> </method> <method name="get_selected_text"> <return type="String" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Returns the text inside the selection of a caret, or all the carets if [param caret_index] is its default value [code]-1[/code]. </description> </method> <method name="get_selection_column" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the original start column of the selection. </description> </method> <method name="get_selection_from_column" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the selection begin column. </description> </method> <method name="get_selection_from_line" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the selection begin line. </description> </method> <method name="get_selection_line" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the original start line of the selection. </description> </method> <method name="get_selection_mode" qualifiers="const"> <return type="int" enum="TextEdit.SelectionMode" /> <description> Returns the current selection mode. </description> </method> <method name="get_selection_to_column" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the selection end column. </description> </method> <method name="get_selection_to_line" qualifiers="const"> <return type="int" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns the selection end line. </description> </method> <method name="get_tab_size" qualifiers="const"> <return type="int" /> <description> Returns the [TextEdit]'s' tab size. </description> </method> <method name="get_total_gutter_width" qualifiers="const"> <return type="int" /> <description> Returns the total width of all gutters and internal padding. </description> </method> <method name="get_total_visible_line_count" qualifiers="const"> <return type="int" /> <description> Returns the number of lines that may be drawn. </description> </method> <method name="get_v_scroll_bar" qualifiers="const"> <return type="VScrollBar" /> <description> Returns the [VScrollBar] of the [TextEdit]. </description> </method> <method name="get_version" qualifiers="const"> <return type="int" /> <description> Returns the current version of the [TextEdit]. The version is a count of recorded operations by the undo/redo history. </description> </method> <method name="get_visible_line_count" qualifiers="const"> <return type="int" /> <description> Returns the number of visible lines, including wrapped text. </description> </method> <method name="get_visible_line_count_in_range" qualifiers="const"> <return type="int" /> <param index="0" name="from_line" type="int" /> <param index="1" name="to_line" type="int" /> <description> Returns the total number of visible + wrapped lines between the two lines. </description> </method> <method name="get_word_at_pos" qualifiers="const"> <return type="String" /> <param index="0" name="position" type="Vector2" /> <description> Returns the word at [param position]. </description> </method> <method name="get_word_under_caret" qualifiers="const"> <return type="String" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Returns a [String] text with the word under the caret's location. </description> </method> <method name="has_ime_text" qualifiers="const"> <return type="bool" /> <description> Returns if the user has IME text. </description> </method> <method name="has_redo" qualifiers="const"> <return type="bool" /> <description> Returns [code]true[/code] if a "redo" action is available. </description> </method> <method name="has_selection" qualifiers="const"> <return type="bool" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Returns [code]true[/code] if the user has selected text. </description> </method> <method name="has_undo" qualifiers="const"> <return type="bool" /> <description> Returns [code]true[/code] if an "undo" action is available. </description> </method> <method name="insert_line_at"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="text" type="String" /> <description> Inserts a new line with [param text] at [param line]. </description> </method> <method name="insert_text_at_caret"> <return type="void" /> <param index="0" name="text" type="String" /> <param index="1" name="caret_index" type="int" default="-1" /> <description> Insert the specified text at the caret position. </description> </method> <method name="is_caret_visible" qualifiers="const"> <return type="bool" /> <param index="0" name="caret_index" type="int" default="0" /> <description> Returns [code]true[/code] if the caret is visible on the screen. </description> </method> <method name="is_dragging_cursor" qualifiers="const"> <return type="bool" /> <description> Returns [code]true[/code] if the user is dragging their mouse for scrolling or selecting. </description> </method> <method name="is_gutter_clickable" qualifiers="const"> <return type="bool" /> <param index="0" name="gutter" type="int" /> <description> Returns whether the gutter is clickable. </description> </method> <method name="is_gutter_drawn" qualifiers="const"> <return type="bool" /> <param index="0" name="gutter" type="int" /> <description> Returns whether the gutter is currently drawn. </description> </method> <method name="is_gutter_overwritable" qualifiers="const"> <return type="bool" /> <param index="0" name="gutter" type="int" /> <description> Returns whether the gutter is overwritable. </description> </method> <method name="is_line_gutter_clickable" qualifiers="const"> <return type="bool" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <description> Returns whether the gutter on the given line is clickable. </description> </method> <method name="is_line_wrapped" qualifiers="const"> <return type="bool" /> <param index="0" name="line" type="int" /> <description> Returns if the given line is wrapped. </description> </method> <method name="is_menu_visible" qualifiers="const"> <return type="bool" /> <description> 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). </description> </method> <method name="is_mouse_over_selection" qualifiers="const"> <return type="bool" /> <param index="0" name="edges" type="bool" /> <param index="1" name="caret_index" type="int" default="-1" /> <description> Returns whether the mouse is over selection. If [param edges] is [code]true[/code], the edges are considered part of the selection. </description> </method> <method name="is_overtype_mode_enabled" qualifiers="const"> <return type="bool" /> <description> Returns whether the user is in overtype mode. </description> </method> <method name="menu_option"> <return type="void" /> <param index="0" name="option" type="int" /> <description> Executes a given action as defined in the [enum MenuItems] enum. </description> </method> <method name="merge_gutters"> <return type="void" /> <param index="0" name="from_line" type="int" /> <param index="1" name="to_line" type="int" /> <description> Merge the gutters from [param from_line] into [param to_line]. Only overwritable gutters will be copied. </description> </method> <method name="merge_overlapping_carets"> <return type="void" /> <description> 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. </description> </method> <method name="paste"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Paste at the current location. Can be overridden with [method _paste]. </description> </method> <method name="paste_primary_clipboard"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Pastes the primary clipboard. </description> </method> <method name="redo"> <return type="void" /> <description> Perform redo operation. </description> </method> <method name="remove_caret"> <return type="void" /> <param index="0" name="caret" type="int" /> <description> Removes the given caret index. [b]Note:[/b] This can result in adjustment of all other caret indices. </description> </method> <method name="remove_gutter"> <return type="void" /> <param index="0" name="gutter" type="int" /> <description> Removes the gutter from this [TextEdit]. </description> </method> <method name="remove_secondary_carets"> <return type="void" /> <description> Removes all additional carets. </description> </method> <method name="remove_text"> <return type="void" /> <param index="0" name="from_line" type="int" /> <param index="1" name="from_column" type="int" /> <param index="2" name="to_line" type="int" /> <param index="3" name="to_column" type="int" /> <description> 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. </description> </method> <method name="search" qualifiers="const"> <return type="Vector2i" /> <param index="0" name="text" type="String" /> <param index="1" name="flags" type="int" /> <param index="2" name="from_line" type="int" /> <param index="3" name="from_colum" type="int" /> <description> 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] </description> </method> <method name="select"> <return type="void" /> <param index="0" name="from_line" type="int" /> <param index="1" name="from_column" type="int" /> <param index="2" name="to_line" type="int" /> <param index="3" name="to_column" type="int" /> <param index="4" name="caret_index" type="int" default="0" /> <description> Perform selection, from line/column to line/column. If [member selecting_enabled] is [code]false[/code], no selection will occur. </description> </method> <method name="select_all"> <return type="void" /> <description> Select all the text. If [member selecting_enabled] is [code]false[/code], no selection will occur. </description> </method> <method name="select_word_under_caret"> <return type="void" /> <param index="0" name="caret_index" type="int" default="-1" /> <description> Selects the word under the caret. </description> </method> <method name="set_caret_column"> <return type="void" /> <param index="0" name="column" type="int" /> <param index="1" name="adjust_viewport" type="bool" default="true" /> <param index="2" name="caret_index" type="int" default="0" /> <description> 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]. </description> </method> <method name="set_caret_line"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="adjust_viewport" type="bool" default="true" /> <param index="2" name="can_be_hidden" type="bool" default="true" /> <param index="3" name="wrap_index" type="int" default="0" /> <param index="4" name="caret_index" type="int" default="0" /> <description> 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]. </description> </method> <method name="set_gutter_clickable"> <return type="void" /> <param index="0" name="gutter" type="int" /> <param index="1" name="clickable" type="bool" /> <description> Sets the gutter as clickable. This will change the mouse cursor to a pointing hand when hovering over the gutter. </description> </method> <method name="set_gutter_custom_draw"> <return type="void" /> <param index="0" name="column" type="int" /> <param index="1" name="draw_callback" type="Callable" /> <description> Set a custom draw method for the gutter. The callback method must take the following args: [code]line: int, gutter: int, Area: Rect2[/code]. </description> </method> <method name="set_gutter_draw"> <return type="void" /> <param index="0" name="gutter" type="int" /> <param index="1" name="draw" type="bool" /> <description> Sets whether the gutter should be drawn. </description> </method> <method name="set_gutter_name"> <return type="void" /> <param index="0" name="gutter" type="int" /> <param index="1" name="name" type="String" /> <description> Sets the name of the gutter. </description> </method> <method name="set_gutter_overwritable"> <return type="void" /> <param index="0" name="gutter" type="int" /> <param index="1" name="overwritable" type="bool" /> <description> Sets the gutter to overwritable. See [method merge_gutters]. </description> </method> <method name="set_gutter_type"> <return type="void" /> <param index="0" name="gutter" type="int" /> <param index="1" name="type" type="int" enum="TextEdit.GutterType" /> <description> Sets the type of gutter. </description> </method> <method name="set_gutter_width"> <return type="void" /> <param index="0" name="gutter" type="int" /> <param index="1" name="width" type="int" /> <description> Set the width of the gutter. </description> </method> <method name="set_line"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="new_text" type="String" /> <description> Sets the text for a specific line. </description> </method> <method name="set_line_as_center_visible"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="wrap_index" type="int" default="0" /> <description> Positions the [param wrap_index] of [param line] at the center of the viewport. </description> </method> <method name="set_line_as_first_visible"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="wrap_index" type="int" default="0" /> <description> Positions the [param wrap_index] of [param line] at the top of the viewport. </description> </method> <method name="set_line_as_last_visible"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="wrap_index" type="int" default="0" /> <description> Positions the [param wrap_index] of [param line] at the bottom of the viewport. </description> </method> <method name="set_line_background_color"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="color" type="Color" /> <description> Sets the current background color of the line. Set to [code]Color(0, 0, 0, 0)[/code] for no color. </description> </method> <method name="set_line_gutter_clickable"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <param index="2" name="clickable" type="bool" /> <description> If [param clickable] is [code]true[/code], makes the [param gutter] on [param line] clickable. See [signal gutter_clicked]. </description> </method> <method name="set_line_gutter_icon"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <param index="2" name="icon" type="Texture2D" /> <description> Sets the icon for [param gutter] on [param line] to [param icon]. </description> </method> <method name="set_line_gutter_item_color"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <param index="2" name="color" type="Color" /> <description> Sets the color for [param gutter] on [param line] to [param color]. </description> </method> <method name="set_line_gutter_metadata"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <param index="2" name="metadata" type="Variant" /> <description> Sets the metadata for [param gutter] on [param line] to [param metadata]. </description> </method> <method name="set_line_gutter_text"> <return type="void" /> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <param index="2" name="text" type="String" /> <description> Sets the text for [param gutter] on [param line] to [param text]. </description> </method> <method name="set_overtype_mode_enabled"> <return type="void" /> <param index="0" name="enabled" type="bool" /> <description> If [code]true[/code], sets the user into overtype mode. When the user types in this mode, it will override existing text. </description> </method> <method name="set_search_flags"> <return type="void" /> <param index="0" name="flags" type="int" /> <description> 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. </description> </method> <method name="set_search_text"> <return type="void" /> <param index="0" name="search_text" type="String" /> <description> Sets the search text. See [method set_search_flags]. </description> </method> <method name="set_selection_mode"> <return type="void" /> <param index="0" name="mode" type="int" enum="TextEdit.SelectionMode" /> <param index="1" name="line" type="int" default="-1" /> <param index="2" name="column" type="int" default="-1" /> <param index="3" name="caret_index" type="int" default="0" /> <description> Sets the current selection mode. </description> </method> <method name="set_tab_size"> <return type="void" /> <param index="0" name="size" type="int" /> <description> Sets the tab size for the [TextEdit] to use. </description> </method> <method name="set_tooltip_request_func"> <return type="void" /> <param index="0" name="callback" type="Callable" /> <description> Provide custom tooltip text. The callback method must take the following args: [code]hovered_word: String[/code]. </description> </method> <method name="start_action"> <return type="void" /> <param index="0" name="action" type="int" enum="TextEdit.EditAction" /> <description> 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. </description> </method> <method name="swap_lines"> <return type="void" /> <param index="0" name="from_line" type="int" /> <param index="1" name="to_line" type="int" /> <description> Swaps the two lines. </description> </method> <method name="tag_saved_version"> <return type="void" /> <description> Tag the current version as saved. </description> </method> <method name="undo"> <return type="void" /> <description> Perform undo operation. </description> </method> </methods> <members> <member name="autowrap_mode" type="int" setter="set_autowrap_mode" getter="get_autowrap_mode" enum="TextServer.AutowrapMode" default="3"> 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]. </member> <member name="caret_blink" type="bool" setter="set_caret_blink_enabled" getter="is_caret_blink_enabled" default="false"> If [code]true[/code], makes the caret blink. </member> <member name="caret_blink_interval" type="float" setter="set_caret_blink_interval" getter="get_caret_blink_interval" default="0.65"> The interval at which the caret blinks (in seconds). </member> <member name="caret_draw_when_editable_disabled" type="bool" setter="set_draw_caret_when_editable_disabled" getter="is_drawing_caret_when_editable_disabled" default="false"> If [code]true[/code], caret will be visible when [member editable] is disabled. </member> <member name="caret_mid_grapheme" type="bool" setter="set_caret_mid_grapheme_enabled" getter="is_caret_mid_grapheme_enabled" default="false"> Allow moving caret, selecting and removing the individual composite character components. [b]Note:[/b] [kbd]Backspace[/kbd] is always removing individual composite character components. </member> <member name="caret_move_on_right_click" type="bool" setter="set_move_caret_on_right_click_enabled" getter="is_move_caret_on_right_click_enabled" default="true"> 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. </member> <member name="caret_multiple" type="bool" setter="set_multiple_carets_enabled" getter="is_multiple_carets_enabled" default="true"> Sets if multiple carets are allowed. </member> <member name="caret_type" type="int" setter="set_caret_type" getter="get_caret_type" enum="TextEdit.CaretType" default="0"> Set the type of caret to draw. </member> <member name="context_menu_enabled" type="bool" setter="set_context_menu_enabled" getter="is_context_menu_enabled" default="true"> If [code]true[/code], a right-click displays the context menu. </member> <member name="deselect_on_focus_loss_enabled" type="bool" setter="set_deselect_on_focus_loss_enabled" getter="is_deselect_on_focus_loss_enabled" default="true"> If [code]true[/code], the selected text will be deselected when focus is lost. </member> <member name="drag_and_drop_selection_enabled" type="bool" setter="set_drag_and_drop_selection_enabled" getter="is_drag_and_drop_selection_enabled" default="true"> If [code]true[/code], allow drag and drop of selected text. </member> <member name="draw_control_chars" type="bool" setter="set_draw_control_chars" getter="get_draw_control_chars" default="false"> If [code]true[/code], control characters are displayed. </member> <member name="draw_spaces" type="bool" setter="set_draw_spaces" getter="is_drawing_spaces" default="false"> If [code]true[/code], the "space" character will have a visible representation. </member> <member name="draw_tabs" type="bool" setter="set_draw_tabs" getter="is_drawing_tabs" default="false"> If [code]true[/code], the "tab" character will have a visible representation. </member> <member name="editable" type="bool" setter="set_editable" getter="is_editable" default="true"> If [code]false[/code], existing text cannot be modified and new text cannot be added. </member> <member name="focus_mode" type="int" setter="set_focus_mode" getter="get_focus_mode" overrides="Control" enum="Control.FocusMode" default="2" /> <member name="highlight_all_occurrences" type="bool" setter="set_highlight_all_occurrences" getter="is_highlight_all_occurrences_enabled" default="false"> If [code]true[/code], all occurrences of the selected text will be highlighted. </member> <member name="highlight_current_line" type="bool" setter="set_highlight_current_line" getter="is_highlight_current_line_enabled" default="false"> If [code]true[/code], the line containing the cursor is highlighted. </member> <member name="language" type="String" setter="set_language" getter="get_language" default=""""> Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. </member> <member name="middle_mouse_paste_enabled" type="bool" setter="set_middle_mouse_paste_enabled" getter="is_middle_mouse_paste_enabled" default="true"> If [code]false[/code], using middle mouse button to paste clipboard will be disabled. [b]Note:[/b] This method is only implemented on Linux. </member> <member name="minimap_draw" type="bool" setter="set_draw_minimap" getter="is_drawing_minimap" default="false"> If [code]true[/code], a minimap is shown, providing an outline of your source code. </member> <member name="minimap_width" type="int" setter="set_minimap_width" getter="get_minimap_width" default="80"> The width, in pixels, of the minimap. </member> <member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" overrides="Control" enum="Control.CursorShape" default="1" /> <member name="placeholder_text" type="String" setter="set_placeholder" getter="get_placeholder" default=""""> Text shown when the [TextEdit] is empty. It is [b]not[/b] the [TextEdit]'s default value (see [member text]). </member> <member name="scroll_fit_content_height" type="bool" setter="set_fit_content_height_enabled" getter="is_fit_content_height_enabled" default="false"> If [code]true[/code], [TextEdit] will disable vertical scroll and fit minimum height to the number of visible lines. </member> <member name="scroll_horizontal" type="int" setter="set_h_scroll" getter="get_h_scroll" default="0"> If there is a horizontal scrollbar, this determines the current horizontal scroll value in pixels. </member> <member name="scroll_past_end_of_file" type="bool" setter="set_scroll_past_end_of_file_enabled" getter="is_scroll_past_end_of_file_enabled" default="false"> Allow scrolling past the last line into "virtual" space. </member> <member name="scroll_smooth" type="bool" setter="set_smooth_scroll_enabled" getter="is_smooth_scroll_enabled" default="false"> Scroll smoothly over the text rather then jumping to the next location. </member> <member name="scroll_v_scroll_speed" type="float" setter="set_v_scroll_speed" getter="get_v_scroll_speed" default="80.0"> Sets the scroll speed with the minimap or when [member scroll_smooth] is enabled. </member> <member name="scroll_vertical" type="float" setter="set_v_scroll" getter="get_v_scroll" default="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. </member> <member name="selecting_enabled" type="bool" setter="set_selecting_enabled" getter="is_selecting_enabled" default="true"> 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. </member> <member name="shortcut_keys_enabled" type="bool" setter="set_shortcut_keys_enabled" getter="is_shortcut_keys_enabled" default="true"> If [code]true[/code], shortcut keys for context menu items are enabled, even if the context menu is disabled. </member> <member name="structured_text_bidi_override" type="int" setter="set_structured_text_bidi_override" getter="get_structured_text_bidi_override" enum="TextServer.StructuredTextParser" default="0"> Set BiDi algorithm override for the structured text. </member> <member name="structured_text_bidi_override_options" type="Array" setter="set_structured_text_bidi_override_options" getter="get_structured_text_bidi_override_options" default="[]"> Set additional options for BiDi override. </member> <member name="syntax_highlighter" type="SyntaxHighlighter" setter="set_syntax_highlighter" getter="get_syntax_highlighter"> Sets the [SyntaxHighlighter] to use. </member> <member name="text" type="String" setter="set_text" getter="get_text" default=""""> String value of the [TextEdit]. </member> <member name="text_direction" type="int" setter="set_text_direction" getter="get_text_direction" enum="Control.TextDirection" default="0"> Base text writing direction. </member> <member name="virtual_keyboard_enabled" type="bool" setter="set_virtual_keyboard_enabled" getter="is_virtual_keyboard_enabled" default="true"> If [code]true[/code], the native virtual keyboard is shown when focused on platforms that support it. </member> <member name="wrap_mode" type="int" setter="set_line_wrapping_mode" getter="get_line_wrapping_mode" enum="TextEdit.LineWrappingMode" default="0"> Sets the line wrapping mode to use. </member> </members> <signals> <signal name="caret_changed"> <description> Emitted when the caret changes position. </description> </signal> <signal name="gutter_added"> <description> Emitted when a gutter is added. </description> </signal> <signal name="gutter_clicked"> <param index="0" name="line" type="int" /> <param index="1" name="gutter" type="int" /> <description> Emitted when a gutter is clicked. </description> </signal> <signal name="gutter_removed"> <description> Emitted when a gutter is removed. </description> </signal> <signal name="lines_edited_from"> <param index="0" name="from_line" type="int" /> <param index="1" name="to_line" type="int" /> <description> 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]. </description> </signal> <signal name="text_changed"> <description> Emitted when the text changes. </description> </signal> <signal name="text_set"> <description> Emitted when [method clear] is called or [member text] is set. </description> </signal> </signals> <constants> <constant name="MENU_CUT" value="0" enum="MenuItems"> Cuts (copies and clears) the selected text. </constant> <constant name="MENU_COPY" value="1" enum="MenuItems"> Copies the selected text. </constant> <constant name="MENU_PASTE" value="2" enum="MenuItems"> Pastes the clipboard text over the selected text (or at the cursor's position). </constant> <constant name="MENU_CLEAR" value="3" enum="MenuItems"> Erases the whole [TextEdit] text. </constant> <constant name="MENU_SELECT_ALL" value="4" enum="MenuItems"> Selects the whole [TextEdit] text. </constant> <constant name="MENU_UNDO" value="5" enum="MenuItems"> Undoes the previous action. </constant> <constant name="MENU_REDO" value="6" enum="MenuItems"> Redoes the previous action. </constant> <constant name="MENU_SUBMENU_TEXT_DIR" value="7" enum="MenuItems"> ID of "Text Writing Direction" submenu. </constant> <constant name="MENU_DIR_INHERITED" value="8" enum="MenuItems"> Sets text direction to inherited. </constant> <constant name="MENU_DIR_AUTO" value="9" enum="MenuItems"> Sets text direction to automatic. </constant> <constant name="MENU_DIR_LTR" value="10" enum="MenuItems"> Sets text direction to left-to-right. </constant> <constant name="MENU_DIR_RTL" value="11" enum="MenuItems"> Sets text direction to right-to-left. </constant> <constant name="MENU_DISPLAY_UCC" value="12" enum="MenuItems"> Toggles control character display. </constant> <constant name="MENU_SUBMENU_INSERT_UCC" value="13" enum="MenuItems"> ID of "Insert Control Character" submenu. </constant> <constant name="MENU_INSERT_LRM" value="14" enum="MenuItems"> Inserts left-to-right mark (LRM) character. </constant> <constant name="MENU_INSERT_RLM" value="15" enum="MenuItems"> Inserts right-to-left mark (RLM) character. </constant> <constant name="MENU_INSERT_LRE" value="16" enum="MenuItems"> Inserts start of left-to-right embedding (LRE) character. </constant> <constant name="MENU_INSERT_RLE" value="17" enum="MenuItems"> Inserts start of right-to-left embedding (RLE) character. </constant> <constant name="MENU_INSERT_LRO" value="18" enum="MenuItems"> Inserts start of left-to-right override (LRO) character. </constant> <constant name="MENU_INSERT_RLO" value="19" enum="MenuItems"> Inserts start of right-to-left override (RLO) character. </constant> <constant name="MENU_INSERT_PDF" value="20" enum="MenuItems"> Inserts pop direction formatting (PDF) character. </constant> <constant name="MENU_INSERT_ALM" value="21" enum="MenuItems"> Inserts Arabic letter mark (ALM) character. </constant> <constant name="MENU_INSERT_LRI" value="22" enum="MenuItems"> Inserts left-to-right isolate (LRI) character. </constant> <constant name="MENU_INSERT_RLI" value="23" enum="MenuItems"> Inserts right-to-left isolate (RLI) character. </constant> <constant name="MENU_INSERT_FSI" value="24" enum="MenuItems"> Inserts first strong isolate (FSI) character. </constant> <constant name="MENU_INSERT_PDI" value="25" enum="MenuItems"> Inserts pop direction isolate (PDI) character. </constant> <constant name="MENU_INSERT_ZWJ" value="26" enum="MenuItems"> Inserts zero width joiner (ZWJ) character. </constant> <constant name="MENU_INSERT_ZWNJ" value="27" enum="MenuItems"> Inserts zero width non-joiner (ZWNJ) character. </constant> <constant name="MENU_INSERT_WJ" value="28" enum="MenuItems"> Inserts word joiner (WJ) character. </constant> <constant name="MENU_INSERT_SHY" value="29" enum="MenuItems"> Inserts soft hyphen (SHY) character. </constant> <constant name="MENU_MAX" value="30" enum="MenuItems"> Represents the size of the [enum MenuItems] enum. </constant> <constant name="ACTION_NONE" value="0" enum="EditAction"> No current action. </constant> <constant name="ACTION_TYPING" value="1" enum="EditAction"> A typing action. </constant> <constant name="ACTION_BACKSPACE" value="2" enum="EditAction"> A backwards delete action. </constant> <constant name="ACTION_DELETE" value="3" enum="EditAction"> A forward delete action. </constant> <constant name="SEARCH_MATCH_CASE" value="1" enum="SearchFlags"> Match case when searching. </constant> <constant name="SEARCH_WHOLE_WORDS" value="2" enum="SearchFlags"> Match whole words when searching. </constant> <constant name="SEARCH_BACKWARDS" value="4" enum="SearchFlags"> Search from end to beginning. </constant> <constant name="CARET_TYPE_LINE" value="0" enum="CaretType"> Vertical line caret. </constant> <constant name="CARET_TYPE_BLOCK" value="1" enum="CaretType"> Block caret. </constant> <constant name="SELECTION_MODE_NONE" value="0" enum="SelectionMode"> Not selecting. </constant> <constant name="SELECTION_MODE_SHIFT" value="1" enum="SelectionMode"> Select as if [code]shift[/code] is pressed. </constant> <constant name="SELECTION_MODE_POINTER" value="2" enum="SelectionMode"> Select single characters as if the user single clicked. </constant> <constant name="SELECTION_MODE_WORD" value="3" enum="SelectionMode"> Select whole words as if the user double clicked. </constant> <constant name="SELECTION_MODE_LINE" value="4" enum="SelectionMode"> Select whole lines as if the user triple clicked. </constant> <constant name="LINE_WRAPPING_NONE" value="0" enum="LineWrappingMode"> Line wrapping is disabled. </constant> <constant name="LINE_WRAPPING_BOUNDARY" value="1" enum="LineWrappingMode"> Line wrapping occurs at the control boundary, beyond what would normally be visible. </constant> <constant name="GUTTER_TYPE_STRING" value="0" enum="GutterType"> Draw a string. </constant> <constant name="GUTTER_TYPE_ICON" value="1" enum="GutterType"> Draw an icon. </constant> <constant name="GUTTER_TYPE_CUSTOM" value="2" enum="GutterType"> Custom draw. </constant> </constants> <theme_items> <theme_item name="background_color" data_type="color" type="Color" default="Color(0, 0, 0, 0)"> Sets the background [Color] of this [TextEdit]. </theme_item> <theme_item name="caret_background_color" data_type="color" type="Color" default="Color(0, 0, 0, 1)"> [Color] of the text behind the caret when using a block caret. </theme_item> <theme_item name="caret_color" data_type="color" type="Color" default="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. </theme_item> <theme_item name="current_line_color" data_type="color" type="Color" default="Color(0.25, 0.25, 0.26, 0.8)"> Background [Color] of the line containing the caret. </theme_item> <theme_item name="font_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 1)"> Sets the font [Color]. </theme_item> <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> The tint of text outline of the [TextEdit]. </theme_item> <theme_item name="font_placeholder_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.6)"> Font color for [member placeholder_text]. </theme_item> <theme_item name="font_readonly_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.5)"> Sets the font [Color] when [member editable] is disabled. </theme_item> <theme_item name="font_selected_color" data_type="color" type="Color" default="Color(0, 0, 0, 0)"> Sets the [Color] of the selected text. If equal to [code]Color(0, 0, 0, 0)[/code], it will be ignored. </theme_item> <theme_item name="search_result_border_color" data_type="color" type="Color" default="Color(0.3, 0.3, 0.3, 0.4)"> [Color] of the border around text that matches the search query. </theme_item> <theme_item name="search_result_color" data_type="color" type="Color" default="Color(0.3, 0.3, 0.3, 1)"> [Color] behind the text that matches the search query. </theme_item> <theme_item name="selection_color" data_type="color" type="Color" default="Color(0.5, 0.5, 0.5, 1)"> Sets the highlight [Color] of text selections. </theme_item> <theme_item name="word_highlighted_color" data_type="color" type="Color" default="Color(0.5, 0.5, 0.5, 0.25)"> Sets the highlight [Color] of multiple occurrences. [member highlight_all_occurrences] has to be enabled. </theme_item> <theme_item name="caret_width" data_type="constant" type="int" default="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 [code]0[/code] or lower, the caret width is automatically set to 1 pixel and multiplied by the display scaling factor. </theme_item> <theme_item name="line_spacing" data_type="constant" type="int" default="4"> Sets the spacing between the lines. </theme_item> <theme_item name="outline_size" data_type="constant" type="int" default="0"> 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. </theme_item> <theme_item name="font" data_type="font" type="Font"> Sets the default [Font]. </theme_item> <theme_item name="font_size" data_type="font_size" type="int"> Sets default font size. </theme_item> <theme_item name="space" data_type="icon" type="Texture2D"> Sets a custom [Texture2D] for space text characters. </theme_item> <theme_item name="tab" data_type="icon" type="Texture2D"> Sets a custom [Texture2D] for tab text characters. </theme_item> <theme_item name="focus" data_type="style" type="StyleBox"> 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. </theme_item> <theme_item name="normal" data_type="style" type="StyleBox"> Sets the [StyleBox] of this [TextEdit]. </theme_item> <theme_item name="read_only" data_type="style" type="StyleBox"> Sets the [StyleBox] of this [TextEdit] when [member editable] is disabled. </theme_item> </theme_items> </class>