godot-docs/classes/class_textedit.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/TextEdit.xml.

.. _class_TextEdit:

TextEdit
========

**Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`

Multiline text editing control.

.. rst-class:: classref-introduction-group

Description
-----------

TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo.

\ **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 Godot script editor.

.. rst-class:: classref-reftable-group

Properties
----------

.. table::
   :widths: auto

   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`bookmark_gutter<class_TextEdit_property_bookmark_gutter>`                                 | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>`                             | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`caret_blink<class_TextEdit_property_caret_blink>`                                         | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                    | :ref:`caret_blink_speed<class_TextEdit_property_caret_blink_speed>`                             | ``0.65``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`caret_block_mode<class_TextEdit_property_caret_block_mode>`                               | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`caret_moving_by_right_click<class_TextEdit_property_caret_moving_by_right_click>`         | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`context_menu_enabled<class_TextEdit_property_context_menu_enabled>`                       | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`deselect_on_focus_loss_enabled<class_TextEdit_property_deselect_on_focus_loss_enabled>`   | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`drag_and_drop_selection_enabled<class_TextEdit_property_drag_and_drop_selection_enabled>` | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`draw_spaces<class_TextEdit_property_draw_spaces>`                                         | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`draw_tabs<class_TextEdit_property_draw_tabs>`                                             | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`FocusMode<enum_Control_FocusMode>`     | focus_mode                                                                                      | ``2`` (overrides :ref:`Control<class_Control_property_focus_mode>`)                 |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`fold_gutter<class_TextEdit_property_fold_gutter>`                                         | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`hiding_enabled<class_TextEdit_property_hiding_enabled>`                                   | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>`             | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`highlight_current_line<class_TextEdit_property_highlight_current_line>`                   | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`middle_mouse_paste_enabled<class_TextEdit_property_middle_mouse_paste_enabled>`           | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`minimap_draw<class_TextEdit_property_minimap_draw>`                                       | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                        | :ref:`minimap_width<class_TextEdit_property_minimap_width>`                                     | ``80``                                                                              |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`CursorShape<enum_Control_CursorShape>` | mouse_default_cursor_shape                                                                      | ``1`` (overrides :ref:`Control<class_Control_property_mouse_default_cursor_shape>`) |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`override_selected_font_color<class_TextEdit_property_override_selected_font_color>`       | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`readonly<class_TextEdit_property_readonly>`                                               | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                        | :ref:`scroll_horizontal<class_TextEdit_property_scroll_horizontal>`                             | ``0``                                                                               |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                    | :ref:`scroll_vertical<class_TextEdit_property_scroll_vertical>`                                 | ``0.0``                                                                             |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>`                             | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`shortcut_keys_enabled<class_TextEdit_property_shortcut_keys_enabled>`                     | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`show_line_numbers<class_TextEdit_property_show_line_numbers>`                             | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`smooth_scrolling<class_TextEdit_property_smooth_scrolling>`                               | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`syntax_highlighting<class_TextEdit_property_syntax_highlighting>`                         | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                  | :ref:`text<class_TextEdit_property_text>`                                                       | ``""``                                                                              |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`float<class_float>`                    | :ref:`v_scroll_speed<class_TextEdit_property_v_scroll_speed>`                                   | ``80.0``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`virtual_keyboard_enabled<class_TextEdit_property_virtual_keyboard_enabled>`               | ``true``                                                                            |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                      | :ref:`wrap_enabled<class_TextEdit_property_wrap_enabled>`                                       | ``false``                                                                           |
   +----------------------------------------------+-------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`add_color_region<class_TextEdit_method_add_color_region>` **(** :ref:`String<class_String>` begin_key, :ref:`String<class_String>` end_key, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` line_only=false **)**   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`add_keyword_color<class_TextEdit_method_add_keyword_color>` **(** :ref:`String<class_String>` keyword, :ref:`Color<class_Color>` color **)**                                                                                 |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`can_fold<class_TextEdit_method_can_fold>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`center_viewport_to_cursor<class_TextEdit_method_center_viewport_to_cursor>` **(** **)**                                                                                                                                      |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`clear_colors<class_TextEdit_method_clear_colors>` **(** **)**                                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`clear_undo_history<class_TextEdit_method_clear_undo_history>` **(** **)**                                                                                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`copy<class_TextEdit_method_copy>` **(** **)**                                                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`cursor_get_column<class_TextEdit_method_cursor_get_column>` **(** **)** |const|                                                                                                                                              |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`cursor_get_line<class_TextEdit_method_cursor_get_line>` **(** **)** |const|                                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`cursor_set_column<class_TextEdit_method_cursor_set_column>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=true **)**                                                                           |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`cursor_set_line<class_TextEdit_method_cursor_set_line>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` adjust_viewport=true, :ref:`bool<class_bool>` can_be_hidden=true, :ref:`int<class_int>` wrap_index=0 **)** |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`cut<class_TextEdit_method_cut>` **(** **)**                                                                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`deselect<class_TextEdit_method_deselect>` **(** **)**                                                                                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`fold_all_lines<class_TextEdit_method_fold_all_lines>` **(** **)**                                                                                                                                                            |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`fold_line<class_TextEdit_method_fold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                           |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`                     | :ref:`get_breakpoints<class_TextEdit_method_get_breakpoints>` **(** **)** |const|                                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Color<class_Color>`                     | :ref:`get_keyword_color<class_TextEdit_method_get_keyword_color>` **(** :ref:`String<class_String>` keyword **)** |const|                                                                                                          |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                   | :ref:`get_line<class_TextEdit_method_get_line>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                 | :ref:`get_line_column_at_pos<class_TextEdit_method_get_line_column_at_pos>` **(** :ref:`Vector2<class_Vector2>` position **)** |const|                                                                                             |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_line_count<class_TextEdit_method_get_line_count>` **(** **)** |const|                                                                                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_line_height<class_TextEdit_method_get_line_height>` **(** **)** |const|                                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_line_width<class_TextEdit_method_get_line_width>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` wrap_index=-1 **)** |const|                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_line_wrap_count<class_TextEdit_method_get_line_wrap_count>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PoolStringArray<class_PoolStringArray>` | :ref:`get_line_wrapped_text<class_TextEdit_method_get_line_wrapped_text>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                           |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PopupMenu<class_PopupMenu>`             | :ref:`get_menu<class_TextEdit_method_get_menu>` **(** **)** |const|                                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                 | :ref:`get_pos_at_line_column<class_TextEdit_method_get_pos_at_line_column>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const|                                                                           |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Rect2<class_Rect2>`                     | :ref:`get_rect_at_line_column<class_TextEdit_method_get_rect_at_line_column>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const|                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_selection_from_column<class_TextEdit_method_get_selection_from_column>` **(** **)** |const|                                                                                                                              |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_selection_from_line<class_TextEdit_method_get_selection_from_line>` **(** **)** |const|                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                   | :ref:`get_selection_text<class_TextEdit_method_get_selection_text>` **(** **)** |const|                                                                                                                                            |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_selection_to_column<class_TextEdit_method_get_selection_to_column>` **(** **)** |const|                                                                                                                                  |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_selection_to_line<class_TextEdit_method_get_selection_to_line>` **(** **)** |const|                                                                                                                                      |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_total_gutter_width<class_TextEdit_method_get_total_gutter_width>` **(** **)** |const|                                                                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_total_visible_rows<class_TextEdit_method_get_total_visible_rows>` **(** **)** |const|                                                                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                         | :ref:`get_visible_rows<class_TextEdit_method_get_visible_rows>` **(** **)** |const|                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                   | :ref:`get_word_under_cursor<class_TextEdit_method_get_word_under_cursor>` **(** **)** |const|                                                                                                                                      |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`has_keyword_color<class_TextEdit_method_has_keyword_color>` **(** :ref:`String<class_String>` keyword **)** |const|                                                                                                          |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`has_redo<class_TextEdit_method_has_redo>` **(** **)** |const|                                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`has_undo<class_TextEdit_method_has_undo>` **(** **)** |const|                                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`insert_text_at_cursor<class_TextEdit_method_insert_text_at_cursor>` **(** :ref:`String<class_String>` text **)**                                                                                                             |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_folded<class_TextEdit_method_is_folded>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                                                   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_line_hidden<class_TextEdit_method_is_line_hidden>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_line_set_as_bookmark<class_TextEdit_method_is_line_set_as_bookmark>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_line_set_as_breakpoint<class_TextEdit_method_is_line_set_as_breakpoint>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_line_set_as_safe<class_TextEdit_method_is_line_set_as_safe>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_line_wrapped<class_TextEdit_method_is_line_wrapped>` **(** :ref:`int<class_int>` line **)** |const|                                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_mouse_over_selection<class_TextEdit_method_is_mouse_over_selection>` **(** :ref:`bool<class_bool>` edges **)** |const|                                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                       | :ref:`is_selection_active<class_TextEdit_method_is_selection_active>` **(** **)** |const|                                                                                                                                          |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`menu_option<class_TextEdit_method_menu_option>` **(** :ref:`int<class_int>` option **)**                                                                                                                                     |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`paste<class_TextEdit_method_paste>` **(** **)**                                                                                                                                                                              |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`redo<class_TextEdit_method_redo>` **(** **)**                                                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`remove_breakpoints<class_TextEdit_method_remove_breakpoints>` **(** **)**                                                                                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PoolIntArray<class_PoolIntArray>`       | :ref:`search<class_TextEdit_method_search>` **(** :ref:`String<class_String>` key, :ref:`int<class_int>` flags, :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column **)** |const|                                   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`select<class_TextEdit_method_select>` **(** :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line, :ref:`int<class_int>` to_column **)**                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`select_all<class_TextEdit_method_select_all>` **(** **)**                                                                                                                                                                    |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`set_line<class_TextEdit_method_set_line>` **(** :ref:`int<class_int>` line, :ref:`String<class_String>` new_text **)**                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`set_line_as_bookmark<class_TextEdit_method_set_line_as_bookmark>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` bookmark **)**                                                                                   |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`set_line_as_breakpoint<class_TextEdit_method_set_line_as_breakpoint>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` breakpoint **)**                                                                             |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**                                                                                         |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`set_line_as_safe<class_TextEdit_method_set_line_as_safe>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` safe **)**                                                                                               |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`toggle_fold_line<class_TextEdit_method_toggle_fold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                             |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`undo<class_TextEdit_method_undo>` **(** **)**                                                                                                                                                                                |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`unfold_line<class_TextEdit_method_unfold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                       |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | void                                          | :ref:`unhide_all_lines<class_TextEdit_method_unhide_all_lines>` **(** **)**                                                                                                                                                        |
   +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-reftable-group

Theme Properties
----------------

.. table::
   :widths: auto

   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`background_color<class_TextEdit_theme_color_background_color>`                       | ``Color( 0, 0, 0, 0 )``             |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`bookmark_color<class_TextEdit_theme_color_bookmark_color>`                           | ``Color( 0.08, 0.49, 0.98, 1 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`brace_mismatch_color<class_TextEdit_theme_color_brace_mismatch_color>`               | ``Color( 1, 0.2, 0.2, 1 )``         |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`breakpoint_color<class_TextEdit_theme_color_breakpoint_color>`                       | ``Color( 0.8, 0.8, 0.4, 0.2 )``     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`caret_background_color<class_TextEdit_theme_color_caret_background_color>`           | ``Color( 0, 0, 0, 1 )``             |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`caret_color<class_TextEdit_theme_color_caret_color>`                                 | ``Color( 0.88, 0.88, 0.88, 1 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`code_folding_color<class_TextEdit_theme_color_code_folding_color>`                   | ``Color( 0.8, 0.8, 0.8, 0.8 )``     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`completion_background_color<class_TextEdit_theme_color_completion_background_color>` | ``Color( 0.17, 0.16, 0.2, 1 )``     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`completion_existing_color<class_TextEdit_theme_color_completion_existing_color>`     | ``Color( 0.87, 0.87, 0.87, 0.13 )`` |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`completion_font_color<class_TextEdit_theme_color_completion_font_color>`             | ``Color( 0.67, 0.67, 0.67, 1 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`completion_scroll_color<class_TextEdit_theme_color_completion_scroll_color>`         | ``Color( 1, 1, 1, 0.29 )``          |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`completion_selected_color<class_TextEdit_theme_color_completion_selected_color>`     | ``Color( 0.26, 0.26, 0.27, 1 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`current_line_color<class_TextEdit_theme_color_current_line_color>`                   | ``Color( 0.25, 0.25, 0.26, 0.8 )``  |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`executing_line_color<class_TextEdit_theme_color_executing_line_color>`               | ``Color( 0.2, 0.8, 0.2, 0.4 )``     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color<class_TextEdit_theme_color_font_color>`                                   | ``Color( 0.88, 0.88, 0.88, 1 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_readonly<class_TextEdit_theme_color_font_color_readonly>`                 | ``Color( 0.88, 0.88, 0.88, 0.5 )``  |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`font_color_selected<class_TextEdit_theme_color_font_color_selected>`                 | ``Color( 0, 0, 0, 1 )``             |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`function_color<class_TextEdit_theme_color_function_color>`                           | ``Color( 0.4, 0.64, 0.81, 1 )``     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`line_number_color<class_TextEdit_theme_color_line_number_color>`                     | ``Color( 0.67, 0.67, 0.67, 0.4 )``  |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`mark_color<class_TextEdit_theme_color_mark_color>`                                   | ``Color( 1, 0.4, 0.4, 0.4 )``       |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`member_variable_color<class_TextEdit_theme_color_member_variable_color>`             | ``Color( 0.9, 0.31, 0.35, 1 )``     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`number_color<class_TextEdit_theme_color_number_color>`                               | ``Color( 0.92, 0.58, 0.2, 1 )``     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`safe_line_number_color<class_TextEdit_theme_color_safe_line_number_color>`           | ``Color( 0.67, 0.78, 0.67, 0.6 )``  |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`selection_color<class_TextEdit_theme_color_selection_color>`                         | ``Color( 0.49, 0.49, 0.49, 1 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`symbol_color<class_TextEdit_theme_color_symbol_color>`                               | ``Color( 0.94, 0.94, 0.94, 1 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Color<class_Color>`       | :ref:`word_highlighted_color<class_TextEdit_theme_color_word_highlighted_color>`           | ``Color( 0.8, 0.9, 0.9, 0.15 )``    |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`int<class_int>`           | :ref:`completion_lines<class_TextEdit_theme_constant_completion_lines>`                    | ``7``                               |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`int<class_int>`           | :ref:`completion_max_width<class_TextEdit_theme_constant_completion_max_width>`            | ``50``                              |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`int<class_int>`           | :ref:`completion_scroll_width<class_TextEdit_theme_constant_completion_scroll_width>`      | ``6``                               |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`int<class_int>`           | :ref:`line_spacing<class_TextEdit_theme_constant_line_spacing>`                            | ``4``                               |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Font<class_Font>`         | :ref:`font<class_TextEdit_theme_font_font>`                                                |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`fold<class_TextEdit_theme_icon_fold>`                                                |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`folded<class_TextEdit_theme_icon_folded>`                                            |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`space<class_TextEdit_theme_icon_space>`                                              |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`Texture<class_Texture>`   | :ref:`tab<class_TextEdit_theme_icon_tab>`                                                  |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`completion<class_TextEdit_theme_style_completion>`                                   |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_TextEdit_theme_style_focus>`                                             |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_TextEdit_theme_style_normal>`                                           |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
   | :ref:`StyleBox<class_StyleBox>` | :ref:`read_only<class_TextEdit_theme_style_read_only>`                                     |                                     |
   +---------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Signals
-------

.. _class_TextEdit_signal_breakpoint_toggled:

.. rst-class:: classref-signal

**breakpoint_toggled** **(** :ref:`int<class_int>` row **)**

Emitted when a breakpoint is placed via the breakpoint gutter.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_signal_cursor_changed:

.. rst-class:: classref-signal

**cursor_changed** **(** **)**

Emitted when the cursor changes.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_signal_info_clicked:

.. rst-class:: classref-signal

**info_clicked** **(** :ref:`int<class_int>` row, :ref:`String<class_String>` info **)**

Emitted when the info icon is clicked.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_signal_request_completion:

.. rst-class:: classref-signal

**request_completion** **(** **)**

.. container:: contribute

	There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_signal_symbol_lookup:

.. rst-class:: classref-signal

**symbol_lookup** **(** :ref:`String<class_String>` symbol, :ref:`int<class_int>` row, :ref:`int<class_int>` column **)**

.. container:: contribute

	There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_signal_text_changed:

.. rst-class:: classref-signal

**text_changed** **(** **)**

Emitted when the text changes.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Enumerations
------------

.. _enum_TextEdit_SearchFlags:

.. rst-class:: classref-enumeration

enum **SearchFlags**:

.. _class_TextEdit_constant_SEARCH_MATCH_CASE:

.. rst-class:: classref-enumeration-constant

:ref:`SearchFlags<enum_TextEdit_SearchFlags>` **SEARCH_MATCH_CASE** = ``1``

Match case when searching.

.. _class_TextEdit_constant_SEARCH_WHOLE_WORDS:

.. rst-class:: classref-enumeration-constant

:ref:`SearchFlags<enum_TextEdit_SearchFlags>` **SEARCH_WHOLE_WORDS** = ``2``

Match whole words when searching.

.. _class_TextEdit_constant_SEARCH_BACKWARDS:

.. rst-class:: classref-enumeration-constant

:ref:`SearchFlags<enum_TextEdit_SearchFlags>` **SEARCH_BACKWARDS** = ``4``

Search from end to beginning.

.. rst-class:: classref-item-separator

----

.. _enum_TextEdit_SearchResult:

.. rst-class:: classref-enumeration

enum **SearchResult**:

.. _class_TextEdit_constant_SEARCH_RESULT_COLUMN:

.. rst-class:: classref-enumeration-constant

:ref:`SearchResult<enum_TextEdit_SearchResult>` **SEARCH_RESULT_COLUMN** = ``0``

Used to access the result column from :ref:`search<class_TextEdit_method_search>`.

.. _class_TextEdit_constant_SEARCH_RESULT_LINE:

.. rst-class:: classref-enumeration-constant

:ref:`SearchResult<enum_TextEdit_SearchResult>` **SEARCH_RESULT_LINE** = ``1``

Used to access the result line from :ref:`search<class_TextEdit_method_search>`.

.. rst-class:: classref-item-separator

----

.. _enum_TextEdit_MenuItems:

.. rst-class:: classref-enumeration

enum **MenuItems**:

.. _class_TextEdit_constant_MENU_CUT:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_CUT** = ``0``

Cuts (copies and clears) the selected text.

.. _class_TextEdit_constant_MENU_COPY:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_COPY** = ``1``

Copies the selected text.

.. _class_TextEdit_constant_MENU_PASTE:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_PASTE** = ``2``

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

.. _class_TextEdit_constant_MENU_CLEAR:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_CLEAR** = ``3``

Erases the whole **TextEdit** text.

.. _class_TextEdit_constant_MENU_SELECT_ALL:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_SELECT_ALL** = ``4``

Selects the whole **TextEdit** text.

.. _class_TextEdit_constant_MENU_UNDO:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_UNDO** = ``5``

Undoes the previous action.

.. _class_TextEdit_constant_MENU_REDO:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_REDO** = ``6``

Redoes the previous action.

.. _class_TextEdit_constant_MENU_MAX:

.. rst-class:: classref-enumeration-constant

:ref:`MenuItems<enum_TextEdit_MenuItems>` **MENU_MAX** = ``7``

Represents the size of the :ref:`MenuItems<enum_TextEdit_MenuItems>` enum.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Property Descriptions
---------------------

.. _class_TextEdit_property_bookmark_gutter:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **bookmark_gutter** = ``false``

.. rst-class:: classref-property-setget

- void **set_bookmark_gutter_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_bookmark_gutter_enabled** **(** **)**

If ``true``, the bookmark gutter is visible.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_breakpoint_gutter:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **breakpoint_gutter** = ``false``

.. rst-class:: classref-property-setget

- void **set_breakpoint_gutter_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_breakpoint_gutter_enabled** **(** **)**

If ``true``, the breakpoint gutter is visible.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_caret_blink:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **caret_blink** = ``false``

.. rst-class:: classref-property-setget

- void **cursor_set_blink_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **cursor_get_blink_enabled** **(** **)**

If ``true``, the caret (visual cursor) blinks.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_caret_blink_speed:

.. rst-class:: classref-property

:ref:`float<class_float>` **caret_blink_speed** = ``0.65``

.. rst-class:: classref-property-setget

- void **cursor_set_blink_speed** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **cursor_get_blink_speed** **(** **)**

Duration (in seconds) of a caret's blinking cycle.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_caret_block_mode:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **caret_block_mode** = ``false``

.. rst-class:: classref-property-setget

- void **cursor_set_block_mode** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **cursor_is_block_mode** **(** **)**

If ``true``, the caret displays as a rectangle.

If ``false``, the caret displays as a bar.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_caret_moving_by_right_click:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **caret_moving_by_right_click** = ``true``

.. rst-class:: classref-property-setget

- void **set_right_click_moves_caret** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_right_click_moving_caret** **(** **)**

If ``true``, a right-click moves the cursor at the mouse position before displaying the context menu.

If ``false``, the context menu disregards mouse location.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_context_menu_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **context_menu_enabled** = ``true``

.. rst-class:: classref-property-setget

- void **set_context_menu_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_context_menu_enabled** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_deselect_on_focus_loss_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **deselect_on_focus_loss_enabled** = ``true``

.. rst-class:: classref-property-setget

- void **set_deselect_on_focus_loss_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_deselect_on_focus_loss_enabled** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_drag_and_drop_selection_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **drag_and_drop_selection_enabled** = ``true``

.. rst-class:: classref-property-setget

- void **set_drag_and_drop_selection_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drag_and_drop_selection_enabled** **(** **)**

If ``true``, allow drag and drop of selected text.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_draw_spaces:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **draw_spaces** = ``false``

.. rst-class:: classref-property-setget

- void **set_draw_spaces** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_spaces** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_draw_tabs:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **draw_tabs** = ``false``

.. rst-class:: classref-property-setget

- void **set_draw_tabs** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_tabs** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_fold_gutter:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **fold_gutter** = ``false``

.. rst-class:: classref-property-setget

- void **set_draw_fold_gutter** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_fold_gutter** **(** **)**

If ``true``, the fold gutter is visible. This enables folding groups of indented lines.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_hiding_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **hiding_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_hiding_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_hiding_enabled** **(** **)**

If ``true``, all lines that have been set to hidden by :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`, will not be visible.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_highlight_all_occurrences:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **highlight_all_occurrences** = ``false``

.. rst-class:: classref-property-setget

- void **set_highlight_all_occurrences** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_highlight_all_occurrences_enabled** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_highlight_current_line:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **highlight_current_line** = ``false``

.. rst-class:: classref-property-setget

- void **set_highlight_current_line** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_highlight_current_line_enabled** **(** **)**

If ``true``, the line containing the cursor is highlighted.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_middle_mouse_paste_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **middle_mouse_paste_enabled** = ``true``

.. rst-class:: classref-property-setget

- void **set_middle_mouse_paste_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_middle_mouse_paste_enabled** **(** **)**

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

\ **Note:** This method is only implemented on Linux.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_minimap_draw:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **minimap_draw** = ``false``

.. rst-class:: classref-property-setget

- void **draw_minimap** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_minimap** **(** **)**

If ``true``, a minimap is shown, providing an outline of your source code.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_minimap_width:

.. rst-class:: classref-property

:ref:`int<class_int>` **minimap_width** = ``80``

.. rst-class:: classref-property-setget

- void **set_minimap_width** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_minimap_width** **(** **)**

The width, in pixels, of the minimap.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_override_selected_font_color:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **override_selected_font_color** = ``false``

.. rst-class:: classref-property-setget

- void **set_override_selected_font_color** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_overriding_selected_font_color** **(** **)**

If ``true``, custom ``font_color_selected`` will be used for selected text.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_readonly:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **readonly** = ``false``

.. rst-class:: classref-property-setget

- void **set_readonly** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_readonly** **(** **)**

If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_scroll_horizontal:

.. rst-class:: classref-property

:ref:`int<class_int>` **scroll_horizontal** = ``0``

.. rst-class:: classref-property-setget

- void **set_h_scroll** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_h_scroll** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_scroll_vertical:

.. rst-class:: classref-property

:ref:`float<class_float>` **scroll_vertical** = ``0.0``

.. rst-class:: classref-property-setget

- void **set_v_scroll** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_v_scroll** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_selecting_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **selecting_enabled** = ``true``

.. rst-class:: classref-property-setget

- void **set_selecting_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_selecting_enabled** **(** **)**

If ``true``, text can be selected.

If ``false``, text can not be selected by the user or by the :ref:`select<class_TextEdit_method_select>` or :ref:`select_all<class_TextEdit_method_select_all>` methods.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_shortcut_keys_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **shortcut_keys_enabled** = ``true``

.. rst-class:: classref-property-setget

- void **set_shortcut_keys_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_shortcut_keys_enabled** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_show_line_numbers:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **show_line_numbers** = ``false``

.. rst-class:: classref-property-setget

- void **set_show_line_numbers** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_show_line_numbers_enabled** **(** **)**

If ``true``, line numbers are displayed to the left of the text.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_smooth_scrolling:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **smooth_scrolling** = ``false``

.. rst-class:: classref-property-setget

- void **set_smooth_scroll_enable** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_smooth_scroll_enabled** **(** **)**

If ``true``, sets the ``step`` of the scrollbars to ``0.25`` which results in smoother scrolling.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_syntax_highlighting:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **syntax_highlighting** = ``false``

.. rst-class:: classref-property-setget

- void **set_syntax_coloring** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_syntax_coloring_enabled** **(** **)**

If ``true``, any custom color properties that have been set for this **TextEdit** will be visible.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_text:

.. rst-class:: classref-property

:ref:`String<class_String>` **text** = ``""``

.. rst-class:: classref-property-setget

- void **set_text** **(** :ref:`String<class_String>` value **)**
- :ref:`String<class_String>` **get_text** **(** **)**

String value of the **TextEdit**.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_v_scroll_speed:

.. rst-class:: classref-property

:ref:`float<class_float>` **v_scroll_speed** = ``80.0``

.. rst-class:: classref-property-setget

- void **set_v_scroll_speed** **(** :ref:`float<class_float>` value **)**
- :ref:`float<class_float>` **get_v_scroll_speed** **(** **)**

Vertical scroll sensitivity.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_virtual_keyboard_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **virtual_keyboard_enabled** = ``true``

.. rst-class:: classref-property-setget

- void **set_virtual_keyboard_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_virtual_keyboard_enabled** **(** **)**

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

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_property_wrap_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **wrap_enabled** = ``false``

.. rst-class:: classref-property-setget

- void **set_wrap_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_wrap_enabled** **(** **)**

If ``true``, enables text wrapping when it goes beyond the edge of what is visible.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_TextEdit_method_add_color_region:

.. rst-class:: classref-method

void **add_color_region** **(** :ref:`String<class_String>` begin_key, :ref:`String<class_String>` end_key, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` line_only=false **)**

Adds color region (given the delimiters) and its colors.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_add_keyword_color:

.. rst-class:: classref-method

void **add_keyword_color** **(** :ref:`String<class_String>` keyword, :ref:`Color<class_Color>` color **)**

Adds a ``keyword`` and its :ref:`Color<class_Color>`.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_can_fold:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **can_fold** **(** :ref:`int<class_int>` line **)** |const|

Returns if the given line is foldable, that is, it has indented lines right below it.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_center_viewport_to_cursor:

.. rst-class:: classref-method

void **center_viewport_to_cursor** **(** **)**

Centers the viewport on the line the editing cursor is at. This also resets the :ref:`scroll_horizontal<class_TextEdit_property_scroll_horizontal>` value to ``0``.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_clear_colors:

.. rst-class:: classref-method

void **clear_colors** **(** **)**

Clears all custom syntax coloring information previously added with :ref:`add_color_region<class_TextEdit_method_add_color_region>` or :ref:`add_keyword_color<class_TextEdit_method_add_keyword_color>`.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_clear_undo_history:

.. rst-class:: classref-method

void **clear_undo_history** **(** **)**

Clears the undo history.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_copy:

.. rst-class:: classref-method

void **copy** **(** **)**

Copy's the current text selection.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_cursor_get_column:

.. rst-class:: classref-method

:ref:`int<class_int>` **cursor_get_column** **(** **)** |const|

Returns the column the editing cursor is at.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_cursor_get_line:

.. rst-class:: classref-method

:ref:`int<class_int>` **cursor_get_line** **(** **)** |const|

Returns the line the editing cursor is at.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_cursor_set_column:

.. rst-class:: classref-method

void **cursor_set_column** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=true **)**

Moves the cursor at the specified ``column`` index.

If ``adjust_viewport`` is set to ``true``, the viewport will center at the cursor position after the move occurs.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_cursor_set_line:

.. rst-class:: classref-method

void **cursor_set_line** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` adjust_viewport=true, :ref:`bool<class_bool>` can_be_hidden=true, :ref:`int<class_int>` wrap_index=0 **)**

Moves the cursor at the specified ``line`` index.

If ``adjust_viewport`` is set to ``true``, the viewport will center at the cursor position after the move occurs.

If ``can_be_hidden`` is set to ``true``, the specified ``line`` can be hidden using :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_cut:

.. rst-class:: classref-method

void **cut** **(** **)**

Cut's the current selection.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_deselect:

.. rst-class:: classref-method

void **deselect** **(** **)**

Deselects the current selection.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_fold_all_lines:

.. rst-class:: classref-method

void **fold_all_lines** **(** **)**

Folds all lines that are possible to be folded (see :ref:`can_fold<class_TextEdit_method_can_fold>`).

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_fold_line:

.. rst-class:: classref-method

void **fold_line** **(** :ref:`int<class_int>` line **)**

Folds the given line, if possible (see :ref:`can_fold<class_TextEdit_method_can_fold>`).

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_breakpoints:

.. rst-class:: classref-method

:ref:`Array<class_Array>` **get_breakpoints** **(** **)** |const|

Returns an array containing the line number of each breakpoint.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_keyword_color:

.. rst-class:: classref-method

:ref:`Color<class_Color>` **get_keyword_color** **(** :ref:`String<class_String>` keyword **)** |const|

Returns the :ref:`Color<class_Color>` of the specified ``keyword``.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_line:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_line** **(** :ref:`int<class_int>` line **)** |const|

Returns the text of a specific line.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_line_column_at_pos:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_line_column_at_pos** **(** :ref:`Vector2<class_Vector2>` position **)** |const|

Returns the line and column at the given position. In the returned vector, ``x`` is the column, ``y`` is the line.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_line_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_line_count** **(** **)** |const|

Returns the amount of total lines in the text.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_line_height:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_line_height** **(** **)** |const|

Returns the height of a largest line.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_line_width:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_line_width** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` wrap_index=-1 **)** |const|

Returns the width in pixels of the ``wrap_index`` on ``line``.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_line_wrap_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_line_wrap_count** **(** :ref:`int<class_int>` line **)** |const|

Returns the number of times the given line is wrapped.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_line_wrapped_text:

.. rst-class:: classref-method

:ref:`PoolStringArray<class_PoolStringArray>` **get_line_wrapped_text** **(** :ref:`int<class_int>` line **)** |const|

Returns an array of :ref:`String<class_String>`\ s representing each wrapped index.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_menu:

.. rst-class:: classref-method

:ref:`PopupMenu<class_PopupMenu>` **get_menu** **(** **)** |const|

Returns the :ref:`PopupMenu<class_PopupMenu>` of this **TextEdit**. By default, this menu is displayed when right-clicking on the **TextEdit**.

\ **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 :ref:`CanvasItem.visible<class_CanvasItem_property_visible>` property.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_pos_at_line_column:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_pos_at_line_column** **(** :ref:`int<class_int>` line, :ref:`int<class_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 :ref:`get_rect_at_line_column<class_TextEdit_method_get_rect_at_line_column>` to get the top side position.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_rect_at_line_column:

.. rst-class:: classref-method

:ref:`Rect2<class_Rect2>` **get_rect_at_line_column** **(** :ref:`int<class_int>` line, :ref:`int<class_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 :ref:`get_pos_at_line_column<class_TextEdit_method_get_pos_at_line_column>` which returns the bottom side.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_selection_from_column:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_selection_from_column** **(** **)** |const|

Returns the selection begin column.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_selection_from_line:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_selection_from_line** **(** **)** |const|

Returns the selection begin line.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_selection_text:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_selection_text** **(** **)** |const|

Returns the text inside the selection.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_selection_to_column:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_selection_to_column** **(** **)** |const|

Returns the selection end column.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_selection_to_line:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_selection_to_line** **(** **)** |const|

Returns the selection end line.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_total_gutter_width:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_total_gutter_width** **(** **)** |const|

Returns the total width of all gutters and internal padding.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_total_visible_rows:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_total_visible_rows** **(** **)** |const|

Returns the total amount of lines that could be drawn.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_visible_rows:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_visible_rows** **(** **)** |const|

Returns the number of visible lines, including wrapped text.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_get_word_under_cursor:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_word_under_cursor** **(** **)** |const|

Returns a :ref:`String<class_String>` text with the word under the caret (text cursor) location.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_has_keyword_color:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_keyword_color** **(** :ref:`String<class_String>` keyword **)** |const|

Returns whether the specified ``keyword`` has a color set to it or not.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_has_redo:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_redo** **(** **)** |const|

Returns ``true`` if a "redo" action is available.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_has_undo:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_undo** **(** **)** |const|

Returns ``true`` if an "undo" action is available.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_insert_text_at_cursor:

.. rst-class:: classref-method

void **insert_text_at_cursor** **(** :ref:`String<class_String>` text **)**

Insert the specified text at the cursor position.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_folded:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_folded** **(** :ref:`int<class_int>` line **)** |const|

Returns whether the line at the specified index is folded or not.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_line_hidden:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_hidden** **(** :ref:`int<class_int>` line **)** |const|

Returns whether the line at the specified index is hidden or not.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_line_set_as_bookmark:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_set_as_bookmark** **(** :ref:`int<class_int>` line **)** |const|

Returns ``true`` when the specified ``line`` is bookmarked.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_line_set_as_breakpoint:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_set_as_breakpoint** **(** :ref:`int<class_int>` line **)** |const|

Returns ``true`` when the specified ``line`` has a breakpoint.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_line_set_as_safe:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_set_as_safe** **(** :ref:`int<class_int>` line **)** |const|

Returns ``true`` when the specified ``line`` is marked as safe.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_line_wrapped:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_wrapped** **(** :ref:`int<class_int>` line **)** |const|

Returns if the given line is wrapped.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_mouse_over_selection:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_mouse_over_selection** **(** :ref:`bool<class_bool>` edges **)** |const|

Returns whether the mouse is over selection. If ``edges`` is ``true``, the edges are considered part of the selection.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_is_selection_active:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_selection_active** **(** **)** |const|

Returns ``true`` if the selection is active.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_menu_option:

.. rst-class:: classref-method

void **menu_option** **(** :ref:`int<class_int>` option **)**

Triggers a right-click menu action by the specified index. See :ref:`MenuItems<enum_TextEdit_MenuItems>` for a list of available indexes.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_paste:

.. rst-class:: classref-method

void **paste** **(** **)**

Paste the current selection.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_redo:

.. rst-class:: classref-method

void **redo** **(** **)**

Perform redo operation.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_remove_breakpoints:

.. rst-class:: classref-method

void **remove_breakpoints** **(** **)**

Removes all the breakpoints. This will not fire the :ref:`breakpoint_toggled<class_TextEdit_signal_breakpoint_toggled>` signal.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_search:

.. rst-class:: classref-method

:ref:`PoolIntArray<class_PoolIntArray>` **search** **(** :ref:`String<class_String>` key, :ref:`int<class_int>` flags, :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column **)** |const|

Perform a search inside the text. Search flags can be specified in the :ref:`SearchFlags<enum_TextEdit_SearchFlags>` enum.

Returns an empty ``PoolIntArray`` if no result was found. Otherwise, the result line and column can be accessed at indices specified in the :ref:`SearchResult<enum_TextEdit_SearchResult>` enum, e.g:

::

    var result = search(key, flags, line, column)
    if result.size() > 0:
        # Result found.
        var res_line = result[TextEdit.SEARCH_RESULT_LINE]
        var res_column = result[TextEdit.SEARCH_RESULT_COLUMN]

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_select:

.. rst-class:: classref-method

void **select** **(** :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line, :ref:`int<class_int>` to_column **)**

Perform selection, from line/column to line/column.

If :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` is ``false``, no selection will occur.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_select_all:

.. rst-class:: classref-method

void **select_all** **(** **)**

Select all the text.

If :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` is ``false``, no selection will occur.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_set_line:

.. rst-class:: classref-method

void **set_line** **(** :ref:`int<class_int>` line, :ref:`String<class_String>` new_text **)**

Sets the text for a specific line.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_set_line_as_bookmark:

.. rst-class:: classref-method

void **set_line_as_bookmark** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` bookmark **)**

Bookmarks the ``line`` if ``bookmark`` is ``true``. Deletes the bookmark if ``bookmark`` is ``false``.

Bookmarks are shown in the :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>`.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_set_line_as_breakpoint:

.. rst-class:: classref-method

void **set_line_as_breakpoint** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` breakpoint **)**

Adds or removes the breakpoint in ``line``. Breakpoints are shown in the :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>`.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_set_line_as_hidden:

.. rst-class:: classref-method

void **set_line_as_hidden** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**

If ``true``, hides the line of the specified index.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_set_line_as_safe:

.. rst-class:: classref-method

void **set_line_as_safe** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` safe **)**

If ``true``, marks the ``line`` as safe.

This will show the line number with the color provided in the ``safe_line_number_color`` theme property.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_toggle_fold_line:

.. rst-class:: classref-method

void **toggle_fold_line** **(** :ref:`int<class_int>` line **)**

Toggle the folding of the code block at the given line.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_undo:

.. rst-class:: classref-method

void **undo** **(** **)**

Perform undo operation.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_unfold_line:

.. rst-class:: classref-method

void **unfold_line** **(** :ref:`int<class_int>` line **)**

Unfolds the given line, if folded.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_method_unhide_all_lines:

.. rst-class:: classref-method

void **unhide_all_lines** **(** **)**

Unhide all lines that were previously set to hidden by :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`.

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Theme Property Descriptions
---------------------------

.. _class_TextEdit_theme_color_background_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **background_color** = ``Color( 0, 0, 0, 0 )``

Sets the background :ref:`Color<class_Color>` of this **TextEdit**. :ref:`syntax_highlighting<class_TextEdit_property_syntax_highlighting>` has to be enabled.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_bookmark_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **bookmark_color** = ``Color( 0.08, 0.49, 0.98, 1 )``

Sets the :ref:`Color<class_Color>` of the bookmark marker. :ref:`syntax_highlighting<class_TextEdit_property_syntax_highlighting>` has to be enabled.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_brace_mismatch_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **brace_mismatch_color** = ``Color( 1, 0.2, 0.2, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_breakpoint_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **breakpoint_color** = ``Color( 0.8, 0.8, 0.4, 0.2 )``

Sets the :ref:`Color<class_Color>` of the breakpoints. :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>` has to be enabled.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_caret_background_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **caret_background_color** = ``Color( 0, 0, 0, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_caret_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **caret_color** = ``Color( 0.88, 0.88, 0.88, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_code_folding_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **code_folding_color** = ``Color( 0.8, 0.8, 0.8, 0.8 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_completion_background_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **completion_background_color** = ``Color( 0.17, 0.16, 0.2, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_completion_existing_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **completion_existing_color** = ``Color( 0.87, 0.87, 0.87, 0.13 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_completion_font_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **completion_font_color** = ``Color( 0.67, 0.67, 0.67, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_completion_scroll_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **completion_scroll_color** = ``Color( 1, 1, 1, 0.29 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_completion_selected_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **completion_selected_color** = ``Color( 0.26, 0.26, 0.27, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_current_line_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **current_line_color** = ``Color( 0.25, 0.25, 0.26, 0.8 )``

Sets the :ref:`Color<class_Color>` of the breakpoints. :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>` has to be enabled.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_executing_line_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **executing_line_color** = ``Color( 0.2, 0.8, 0.2, 0.4 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_font_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color** = ``Color( 0.88, 0.88, 0.88, 1 )``

Sets the font :ref:`Color<class_Color>`.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_font_color_readonly:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_readonly** = ``Color( 0.88, 0.88, 0.88, 0.5 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_font_color_selected:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **font_color_selected** = ``Color( 0, 0, 0, 1 )``

Sets the :ref:`Color<class_Color>` of the selected text. :ref:`override_selected_font_color<class_TextEdit_property_override_selected_font_color>` has to be enabled.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_function_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **function_color** = ``Color( 0.4, 0.64, 0.81, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_line_number_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **line_number_color** = ``Color( 0.67, 0.67, 0.67, 0.4 )``

Sets the :ref:`Color<class_Color>` of the line numbers. :ref:`show_line_numbers<class_TextEdit_property_show_line_numbers>` has to be enabled.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_mark_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **mark_color** = ``Color( 1, 0.4, 0.4, 0.4 )``

Sets the :ref:`Color<class_Color>` of marked text.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_member_variable_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **member_variable_color** = ``Color( 0.9, 0.31, 0.35, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_number_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **number_color** = ``Color( 0.92, 0.58, 0.2, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_safe_line_number_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **safe_line_number_color** = ``Color( 0.67, 0.78, 0.67, 0.6 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_selection_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **selection_color** = ``Color( 0.49, 0.49, 0.49, 1 )``

Sets the highlight :ref:`Color<class_Color>` of text selections.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_symbol_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **symbol_color** = ``Color( 0.94, 0.94, 0.94, 1 )``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_color_word_highlighted_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **word_highlighted_color** = ``Color( 0.8, 0.9, 0.9, 0.15 )``

Sets the highlight :ref:`Color<class_Color>` of multiple occurrences. :ref:`highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>` has to be enabled.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_constant_completion_lines:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **completion_lines** = ``7``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_constant_completion_max_width:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **completion_max_width** = ``50``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_constant_completion_scroll_width:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **completion_scroll_width** = ``6``

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_constant_line_spacing:

.. rst-class:: classref-themeproperty

:ref:`int<class_int>` **line_spacing** = ``4``

Sets the spacing between the lines.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_font_font:

.. rst-class:: classref-themeproperty

:ref:`Font<class_Font>` **font**

Sets the default :ref:`Font<class_Font>`.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_icon_fold:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **fold**

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_icon_folded:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **folded**

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_icon_space:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **space**

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_icon_tab:

.. rst-class:: classref-themeproperty

:ref:`Texture<class_Texture>` **tab**

Sets a custom :ref:`Texture<class_Texture>` for tab text characters.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_style_completion:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **completion**

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_style_focus:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **focus**

.. container:: contribute

	There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_style_normal:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **normal**

Sets the :ref:`StyleBox<class_StyleBox>` of this **TextEdit**.

.. rst-class:: classref-item-separator

----

.. _class_TextEdit_theme_style_read_only:

.. rst-class:: classref-themeproperty

:ref:`StyleBox<class_StyleBox>` **read_only**

Sets the :ref:`StyleBox<class_StyleBox>` of this **TextEdit** when :ref:`readonly<class_TextEdit_property_readonly>` is enabled.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`