godot-docs/classes/class_codeedit.rst

:github_url: hide

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

.. _class_CodeEdit:

CodeEdit
========

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

A multiline text editor designed for editing code.

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

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

CodeEdit is a specialized :ref:`TextEdit<class_TextEdit>` designed for editing plain text code files. It has many features commonly found in code editors such as line numbers, line folding, code completion, indent management, and string/comment management.

\ **Note:** Regardless of locale, **CodeEdit** will by default always use left-to-right text direction to correctly display source code.

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

Properties
----------

.. table::
   :widths: auto

   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`auto_brace_completion_enabled<class_CodeEdit_property_auto_brace_completion_enabled>`                       | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`auto_brace_completion_highlight_matching<class_CodeEdit_property_auto_brace_completion_highlight_matching>` | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`Dictionary<class_Dictionary>`                      | :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>`                           | ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }``                |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`code_completion_enabled<class_CodeEdit_property_code_completion_enabled>`                                   | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`code_completion_prefixes<class_CodeEdit_property_code_completion_prefixes>`                                 | ``[]``                                                                    |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`delimiter_comments<class_CodeEdit_property_delimiter_comments>`                                             | ``[]``                                                                    |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`delimiter_strings<class_CodeEdit_property_delimiter_strings>`                                               | ``["' '", "\" \""]``                                                      |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`gutters_draw_bookmarks<class_CodeEdit_property_gutters_draw_bookmarks>`                                     | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`gutters_draw_breakpoints_gutter<class_CodeEdit_property_gutters_draw_breakpoints_gutter>`                   | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`gutters_draw_executing_lines<class_CodeEdit_property_gutters_draw_executing_lines>`                         | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`gutters_draw_fold_gutter<class_CodeEdit_property_gutters_draw_fold_gutter>`                                 | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`gutters_draw_line_numbers<class_CodeEdit_property_gutters_draw_line_numbers>`                               | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`gutters_zero_pad_line_numbers<class_CodeEdit_property_gutters_zero_pad_line_numbers>`                       | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`indent_automatic<class_CodeEdit_property_indent_automatic>`                                                 | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`indent_automatic_prefixes<class_CodeEdit_property_indent_automatic_prefixes>`                               | ``[":", "{", "[", "("]``                                                  |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                    | :ref:`indent_size<class_CodeEdit_property_indent_size>`                                                           | ``4``                                                                     |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`                                               | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`LayoutDirection<enum_Control_LayoutDirection>`     | layout_direction                                                                                                  | ``2`` (overrides :ref:`Control<class_Control_property_layout_direction>`) |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`line_folding<class_CodeEdit_property_line_folding>`                                                         | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`int<class_int>`\]       | :ref:`line_length_guidelines<class_CodeEdit_property_line_length_guidelines>`                                     | ``[]``                                                                    |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`symbol_lookup_on_click<class_CodeEdit_property_symbol_lookup_on_click>`                                     | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                  | :ref:`symbol_tooltip_on_hover<class_CodeEdit_property_symbol_tooltip_on_hover>`                                   | ``false``                                                                 |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
   | :ref:`TextDirection<enum_Control_TextDirection>`         | text_direction                                                                                                    | ``1`` (overrides :ref:`TextEdit<class_TextEdit_property_text_direction>`) |
   +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+

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

Methods
-------

.. table::
   :widths: auto

   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`_confirm_code_completion<class_CodeEdit_private_method__confirm_code_completion>`\ (\ replace\: :ref:`bool<class_bool>`\ ) |virtual|                                                                                                                                                                                                                                                                                                             |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`_filter_code_completion_candidates<class_CodeEdit_private_method__filter_code_completion_candidates>`\ (\ candidates\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) |virtual| |const|                                                                                                                                                                                                                                     |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`_request_code_completion<class_CodeEdit_private_method__request_code_completion>`\ (\ force\: :ref:`bool<class_bool>`\ ) |virtual|                                                                                                                                                                                                                                                                                                               |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`add_auto_brace_completion_pair<class_CodeEdit_method_add_auto_brace_completion_pair>`\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                      |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`add_code_completion_option<class_CodeEdit_method_add_code_completion_option>`\ (\ type\: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`, display_text\: :ref:`String<class_String>`, insert_text\: :ref:`String<class_String>`, text_color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), icon\: :ref:`Resource<class_Resource>` = null, value\: :ref:`Variant<class_Variant>` = null, location\: :ref:`int<class_int>` = 1024\ ) |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`add_comment_delimiter<class_CodeEdit_method_add_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                           |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`add_string_delimiter<class_CodeEdit_method_add_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                             |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`can_fold_line<class_CodeEdit_method_can_fold_line>`\ (\ line\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`cancel_code_completion<class_CodeEdit_method_cancel_code_completion>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                      |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`clear_bookmarked_lines<class_CodeEdit_method_clear_bookmarked_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                      |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`clear_breakpointed_lines<class_CodeEdit_method_clear_breakpointed_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`clear_comment_delimiters<class_CodeEdit_method_clear_comment_delimiters>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`clear_executing_lines<class_CodeEdit_method_clear_executing_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                        |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`clear_string_delimiters<class_CodeEdit_method_clear_string_delimiters>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`confirm_code_completion<class_CodeEdit_method_confirm_code_completion>`\ (\ replace\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                         |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`convert_indent<class_CodeEdit_method_convert_indent>`\ (\ from_line\: :ref:`int<class_int>` = -1, to_line\: :ref:`int<class_int>` = -1\ )                                                                                                                                                                                                                                                                                                        |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`create_code_region<class_CodeEdit_method_create_code_region>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                              |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`delete_lines<class_CodeEdit_method_delete_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                          |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`do_indent<class_CodeEdit_method_do_indent>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`duplicate_lines<class_CodeEdit_method_duplicate_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`duplicate_selection<class_CodeEdit_method_duplicate_selection>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                            |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`fold_all_lines<class_CodeEdit_method_fold_all_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                      |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`fold_line<class_CodeEdit_method_fold_line>`\ (\ line\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_auto_brace_completion_close_key<class_CodeEdit_method_get_auto_brace_completion_close_key>`\ (\ open_key\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                            |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedInt32Array<class_PackedInt32Array>`                  | :ref:`get_bookmarked_lines<class_CodeEdit_method_get_bookmarked_lines>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedInt32Array<class_PackedInt32Array>`                  | :ref:`get_breakpointed_lines<class_CodeEdit_method_get_breakpointed_lines>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                              |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Dictionary<class_Dictionary>`                              | :ref:`get_code_completion_option<class_CodeEdit_method_get_code_completion_option>`\ (\ index\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                       |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`get_code_completion_options<class_CodeEdit_method_get_code_completion_options>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                            | :ref:`get_code_completion_selected_index<class_CodeEdit_method_get_code_completion_selected_index>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                      |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_code_region_end_tag<class_CodeEdit_method_get_code_region_end_tag>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                            |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_code_region_start_tag<class_CodeEdit_method_get_code_region_start_tag>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                        |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_delimiter_end_key<class_CodeEdit_method_get_delimiter_end_key>`\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                       |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                                    | :ref:`get_delimiter_end_position<class_CodeEdit_method_get_delimiter_end_position>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                        |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_delimiter_start_key<class_CodeEdit_method_get_delimiter_start_key>`\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                   |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                                    | :ref:`get_delimiter_start_position<class_CodeEdit_method_get_delimiter_start_position>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedInt32Array<class_PackedInt32Array>`                  | :ref:`get_executing_lines<class_CodeEdit_method_get_executing_lines>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Array<class_Array>`\[:ref:`int<class_int>`\]               | :ref:`get_folded_lines<class_CodeEdit_method_get_folded_lines>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                          |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_text_for_code_completion<class_CodeEdit_method_get_text_for_code_completion>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_text_for_symbol_lookup<class_CodeEdit_method_get_text_for_symbol_lookup>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                      |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`String<class_String>`                                      | :ref:`get_text_with_cursor_char<class_CodeEdit_method_get_text_with_cursor_char>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                          |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`has_auto_brace_completion_close_key<class_CodeEdit_method_has_auto_brace_completion_close_key>`\ (\ close_key\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                           |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`has_auto_brace_completion_open_key<class_CodeEdit_method_has_auto_brace_completion_open_key>`\ (\ open_key\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                              |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`has_comment_delimiter<class_CodeEdit_method_has_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                                                       |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`has_string_delimiter<class_CodeEdit_method_has_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |const|                                                                                                                                                                                                                                                                                                                         |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`indent_lines<class_CodeEdit_method_indent_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                          |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                            | :ref:`is_in_comment<class_CodeEdit_method_is_in_comment>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                             |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                            | :ref:`is_in_string<class_CodeEdit_method_is_in_string>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const|                                                                                                                                                                                                                                                                                                               |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`is_line_bookmarked<class_CodeEdit_method_is_line_bookmarked>`\ (\ line\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                        |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`is_line_breakpointed<class_CodeEdit_method_is_line_breakpointed>`\ (\ line\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`is_line_code_region_end<class_CodeEdit_method_is_line_code_region_end>`\ (\ line\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                              |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`is_line_code_region_start<class_CodeEdit_method_is_line_code_region_start>`\ (\ line\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                          |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`is_line_executing<class_CodeEdit_method_is_line_executing>`\ (\ line\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                          |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                          | :ref:`is_line_folded<class_CodeEdit_method_is_line_folded>`\ (\ line\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`move_lines_down<class_CodeEdit_method_move_lines_down>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`move_lines_up<class_CodeEdit_method_move_lines_up>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                        |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`remove_comment_delimiter<class_CodeEdit_method_remove_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                         |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`remove_string_delimiter<class_CodeEdit_method_remove_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                           |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`request_code_completion<class_CodeEdit_method_request_code_completion>`\ (\ force\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                           |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_code_completion_selected_index<class_CodeEdit_method_set_code_completion_selected_index>`\ (\ index\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                               |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_code_hint<class_CodeEdit_method_set_code_hint>`\ (\ code_hint\: :ref:`String<class_String>`\ )                                                                                                                                                                                                                                                                                                                                               |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_code_hint_draw_below<class_CodeEdit_method_set_code_hint_draw_below>`\ (\ draw_below\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                            |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_code_region_tags<class_CodeEdit_method_set_code_region_tags>`\ (\ start\: :ref:`String<class_String>` = "region", end\: :ref:`String<class_String>` = "endregion"\ )                                                                                                                                                                                                                                                                         |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_line_as_bookmarked<class_CodeEdit_method_set_line_as_bookmarked>`\ (\ line\: :ref:`int<class_int>`, bookmarked\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_line_as_breakpoint<class_CodeEdit_method_set_line_as_breakpoint>`\ (\ line\: :ref:`int<class_int>`, breakpointed\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_line_as_executing<class_CodeEdit_method_set_line_as_executing>`\ (\ line\: :ref:`int<class_int>`, executing\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                     |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`set_symbol_lookup_word_as_valid<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`\ (\ valid\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                   |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`toggle_foldable_line<class_CodeEdit_method_toggle_foldable_line>`\ (\ line\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                            |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`toggle_foldable_lines_at_carets<class_CodeEdit_method_toggle_foldable_lines_at_carets>`\ (\ )                                                                                                                                                                                                                                                                                                                                                    |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`unfold_all_lines<class_CodeEdit_method_unfold_all_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                  |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`unfold_line<class_CodeEdit_method_unfold_line>`\ (\ line\: :ref:`int<class_int>`\ )                                                                                                                                                                                                                                                                                                                                                              |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`unindent_lines<class_CodeEdit_method_unindent_lines>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                      |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                           | :ref:`update_code_completion_options<class_CodeEdit_method_update_code_completion_options>`\ (\ force\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                     |
   +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

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

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

.. table::
   :widths: auto

   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`bookmark_color<class_CodeEdit_theme_color_bookmark_color>`                                   | ``Color(0.5, 0.64, 1, 0.8)``      |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`brace_mismatch_color<class_CodeEdit_theme_color_brace_mismatch_color>`                       | ``Color(1, 0.2, 0.2, 1)``         |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`breakpoint_color<class_CodeEdit_theme_color_breakpoint_color>`                               | ``Color(0.9, 0.29, 0.3, 1)``      |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`code_folding_color<class_CodeEdit_theme_color_code_folding_color>`                           | ``Color(0.8, 0.8, 0.8, 0.8)``     |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`completion_background_color<class_CodeEdit_theme_color_completion_background_color>`         | ``Color(0.17, 0.16, 0.2, 1)``     |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`completion_existing_color<class_CodeEdit_theme_color_completion_existing_color>`             | ``Color(0.87, 0.87, 0.87, 0.13)`` |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`completion_scroll_color<class_CodeEdit_theme_color_completion_scroll_color>`                 | ``Color(1, 1, 1, 0.29)``          |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`completion_scroll_hovered_color<class_CodeEdit_theme_color_completion_scroll_hovered_color>` | ``Color(1, 1, 1, 0.4)``           |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`completion_selected_color<class_CodeEdit_theme_color_completion_selected_color>`             | ``Color(0.26, 0.26, 0.27, 1)``    |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`executing_line_color<class_CodeEdit_theme_color_executing_line_color>`                       | ``Color(0.98, 0.89, 0.27, 1)``    |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`folded_code_region_color<class_CodeEdit_theme_color_folded_code_region_color>`               | ``Color(0.68, 0.46, 0.77, 0.2)``  |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`line_length_guideline_color<class_CodeEdit_theme_color_line_length_guideline_color>`         | ``Color(0.3, 0.5, 0.8, 0.1)``     |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Color<class_Color>`         | :ref:`line_number_color<class_CodeEdit_theme_color_line_number_color>`                             | ``Color(0.67, 0.67, 0.67, 0.4)``  |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`completion_lines<class_CodeEdit_theme_constant_completion_lines>`                            | ``7``                             |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`completion_max_width<class_CodeEdit_theme_constant_completion_max_width>`                    | ``50``                            |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`int<class_int>`             | :ref:`completion_scroll_width<class_CodeEdit_theme_constant_completion_scroll_width>`              | ``6``                             |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`bookmark<class_CodeEdit_theme_icon_bookmark>`                                                |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`breakpoint<class_CodeEdit_theme_icon_breakpoint>`                                            |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`can_fold<class_CodeEdit_theme_icon_can_fold>`                                                |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`can_fold_code_region<class_CodeEdit_theme_icon_can_fold_code_region>`                        |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`completion_color_bg<class_CodeEdit_theme_icon_completion_color_bg>`                          |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`executing_line<class_CodeEdit_theme_icon_executing_line>`                                    |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`folded<class_CodeEdit_theme_icon_folded>`                                                    |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`folded_code_region<class_CodeEdit_theme_icon_folded_code_region>`                            |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`Texture2D<class_Texture2D>` | :ref:`folded_eol_icon<class_CodeEdit_theme_icon_folded_eol_icon>`                                  |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
   | :ref:`StyleBox<class_StyleBox>`   | :ref:`completion<class_CodeEdit_theme_style_completion>`                                           |                                   |
   +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+

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

----

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

Signals
-------

.. _class_CodeEdit_signal_breakpoint_toggled:

.. rst-class:: classref-signal

**breakpoint_toggled**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_breakpoint_toggled>`

Emitted when a breakpoint is added or removed from a line. If the line is removed via backspace, a signal is emitted at the old line.

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

----

.. _class_CodeEdit_signal_code_completion_requested:

.. rst-class:: classref-signal

**code_completion_requested**\ (\ ) :ref:`🔗<class_CodeEdit_signal_code_completion_requested>`

Emitted when the user requests code completion. This signal will not be sent if :ref:`_request_code_completion()<class_CodeEdit_private_method__request_code_completion>` is overridden or :ref:`code_completion_enabled<class_CodeEdit_property_code_completion_enabled>` is ``false``.

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

----

.. _class_CodeEdit_signal_symbol_hovered:

.. rst-class:: classref-signal

**symbol_hovered**\ (\ symbol\: :ref:`String<class_String>`, line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_hovered>`

Emitted when the user hovers over a symbol. Unlike :ref:`Control.mouse_entered<class_Control_signal_mouse_entered>`, this signal is not emitted immediately, but when the cursor is over the symbol for :ref:`ProjectSettings.gui/timers/tooltip_delay_sec<class_ProjectSettings_property_gui/timers/tooltip_delay_sec>` seconds.

\ **Note:** :ref:`symbol_tooltip_on_hover<class_CodeEdit_property_symbol_tooltip_on_hover>` must be ``true`` for this signal to be emitted.

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

----

.. _class_CodeEdit_signal_symbol_lookup:

.. rst-class:: classref-signal

**symbol_lookup**\ (\ symbol\: :ref:`String<class_String>`, line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_lookup>`

Emitted when the user has clicked on a valid symbol.

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

----

.. _class_CodeEdit_signal_symbol_validate:

.. rst-class:: classref-signal

**symbol_validate**\ (\ symbol\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_validate>`

Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling :ref:`set_symbol_lookup_word_as_valid()<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`.

\ **Note:** :ref:`symbol_lookup_on_click<class_CodeEdit_property_symbol_lookup_on_click>` must be ``true`` for this signal to be emitted.

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

----

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

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

.. _enum_CodeEdit_CodeCompletionKind:

.. rst-class:: classref-enumeration

enum **CodeCompletionKind**: :ref:`🔗<enum_CodeEdit_CodeCompletionKind>`

.. _class_CodeEdit_constant_KIND_CLASS:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CLASS** = ``0``

Marks the option as a class.

.. _class_CodeEdit_constant_KIND_FUNCTION:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FUNCTION** = ``1``

Marks the option as a function.

.. _class_CodeEdit_constant_KIND_SIGNAL:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_SIGNAL** = ``2``

Marks the option as a Godot signal.

.. _class_CodeEdit_constant_KIND_VARIABLE:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_VARIABLE** = ``3``

Marks the option as a variable.

.. _class_CodeEdit_constant_KIND_MEMBER:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_MEMBER** = ``4``

Marks the option as a member.

.. _class_CodeEdit_constant_KIND_ENUM:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_ENUM** = ``5``

Marks the option as an enum entry.

.. _class_CodeEdit_constant_KIND_CONSTANT:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CONSTANT** = ``6``

Marks the option as a constant.

.. _class_CodeEdit_constant_KIND_NODE_PATH:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_NODE_PATH** = ``7``

Marks the option as a Godot node path.

.. _class_CodeEdit_constant_KIND_FILE_PATH:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FILE_PATH** = ``8``

Marks the option as a file path.

.. _class_CodeEdit_constant_KIND_PLAIN_TEXT:

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

:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_PLAIN_TEXT** = ``9``

Marks the option as unclassified or plain text.

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

----

.. _enum_CodeEdit_CodeCompletionLocation:

.. rst-class:: classref-enumeration

enum **CodeCompletionLocation**: :ref:`🔗<enum_CodeEdit_CodeCompletionLocation>`

.. _class_CodeEdit_constant_LOCATION_LOCAL:

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

:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_LOCAL** = ``0``

The option is local to the location of the code completion query - e.g. a local variable. Subsequent value of location represent options from the outer class, the exact value represent how far they are (in terms of inner classes).

.. _class_CodeEdit_constant_LOCATION_PARENT_MASK:

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

:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_PARENT_MASK** = ``256``

The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. ``0`` for the local class, ``1`` for the parent, ``2`` for the grandparent, etc.) to store the depth of an option in the class or a parent class.

.. _class_CodeEdit_constant_LOCATION_OTHER_USER_CODE:

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

:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER_USER_CODE** = ``512``

The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).

.. _class_CodeEdit_constant_LOCATION_OTHER:

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

:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER** = ``1024``

The option is from other engine code, not covered by the other enum constants - e.g. built-in classes.

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

----

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

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

.. _class_CodeEdit_property_auto_brace_completion_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **auto_brace_completion_enabled** = ``false`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_enabled>`

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

- |void| **set_auto_brace_completion_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_auto_brace_completion_enabled**\ (\ )

If ``true``, uses :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>` to automatically insert the closing brace when the opening brace is inserted by typing or autocompletion. Also automatically removes the closing brace when using backspace on the opening brace.

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

----

.. _class_CodeEdit_property_auto_brace_completion_highlight_matching:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **auto_brace_completion_highlight_matching** = ``false`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_highlight_matching>`

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

- |void| **set_highlight_matching_braces_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_highlight_matching_braces_enabled**\ (\ )

If ``true``, highlights brace pairs when the caret is on either one, using :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>`. If matching, the pairs will be underlined. If a brace is unmatched, it is colored with :ref:`brace_mismatch_color<class_CodeEdit_theme_color_brace_mismatch_color>`.

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

----

.. _class_CodeEdit_property_auto_brace_completion_pairs:

.. rst-class:: classref-property

:ref:`Dictionary<class_Dictionary>` **auto_brace_completion_pairs** = ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_pairs>`

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

- |void| **set_auto_brace_completion_pairs**\ (\ value\: :ref:`Dictionary<class_Dictionary>`\ )
- :ref:`Dictionary<class_Dictionary>` **get_auto_brace_completion_pairs**\ (\ )

Sets the brace pairs to be autocompleted. For each entry in the dictionary, the key is the opening brace and the value is the closing brace that matches it. A brace is a :ref:`String<class_String>` made of symbols. See :ref:`auto_brace_completion_enabled<class_CodeEdit_property_auto_brace_completion_enabled>` and :ref:`auto_brace_completion_highlight_matching<class_CodeEdit_property_auto_brace_completion_highlight_matching>`.

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

----

.. _class_CodeEdit_property_code_completion_enabled:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **code_completion_enabled** = ``false`` :ref:`🔗<class_CodeEdit_property_code_completion_enabled>`

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

- |void| **set_code_completion_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_code_completion_enabled**\ (\ )

If ``true``, the :ref:`ProjectSettings.input/ui_text_completion_query<class_ProjectSettings_property_input/ui_text_completion_query>` action requests code completion. To handle it, see :ref:`_request_code_completion()<class_CodeEdit_private_method__request_code_completion>` or :ref:`code_completion_requested<class_CodeEdit_signal_code_completion_requested>`.

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

----

.. _class_CodeEdit_property_code_completion_prefixes:

.. rst-class:: classref-property

:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **code_completion_prefixes** = ``[]`` :ref:`🔗<class_CodeEdit_property_code_completion_prefixes>`

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

- |void| **set_code_completion_prefixes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_code_completion_prefixes**\ (\ )

Sets prefixes that will trigger code completion.

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

----

.. _class_CodeEdit_property_delimiter_comments:

.. rst-class:: classref-property

:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **delimiter_comments** = ``[]`` :ref:`🔗<class_CodeEdit_property_delimiter_comments>`

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

- |void| **set_comment_delimiters**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_comment_delimiters**\ (\ )

Sets the comment delimiters. All existing comment delimiters will be removed.

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

----

.. _class_CodeEdit_property_delimiter_strings:

.. rst-class:: classref-property

:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **delimiter_strings** = ``["' '", "\" \""]`` :ref:`🔗<class_CodeEdit_property_delimiter_strings>`

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

- |void| **set_string_delimiters**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_string_delimiters**\ (\ )

Sets the string delimiters. All existing string delimiters will be removed.

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

----

.. _class_CodeEdit_property_gutters_draw_bookmarks:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **gutters_draw_bookmarks** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_bookmarks>`

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

- |void| **set_draw_bookmarks_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_drawing_bookmarks_gutter**\ (\ )

If ``true``, bookmarks are drawn in the gutter. This gutter is shared with breakpoints and executing lines. See :ref:`set_line_as_bookmarked()<class_CodeEdit_method_set_line_as_bookmarked>`.

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

----

.. _class_CodeEdit_property_gutters_draw_breakpoints_gutter:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **gutters_draw_breakpoints_gutter** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_breakpoints_gutter>`

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

- |void| **set_draw_breakpoints_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_drawing_breakpoints_gutter**\ (\ )

If ``true``, breakpoints are drawn in the gutter. This gutter is shared with bookmarks and executing lines. Clicking the gutter will toggle the breakpoint for the line, see :ref:`set_line_as_breakpoint()<class_CodeEdit_method_set_line_as_breakpoint>`.

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

----

.. _class_CodeEdit_property_gutters_draw_executing_lines:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **gutters_draw_executing_lines** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_executing_lines>`

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

- |void| **set_draw_executing_lines_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_drawing_executing_lines_gutter**\ (\ )

If ``true``, executing lines are marked in the gutter. This gutter is shared with breakpoints and bookmarks. See :ref:`set_line_as_executing()<class_CodeEdit_method_set_line_as_executing>`.

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

----

.. _class_CodeEdit_property_gutters_draw_fold_gutter:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **gutters_draw_fold_gutter** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_fold_gutter>`

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

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

If ``true``, the fold gutter is drawn. In this gutter, the :ref:`can_fold_code_region<class_CodeEdit_theme_icon_can_fold_code_region>` icon is drawn for each foldable line (see :ref:`can_fold_line()<class_CodeEdit_method_can_fold_line>`) and the :ref:`folded_code_region<class_CodeEdit_theme_icon_folded_code_region>` icon is drawn for each folded line (see :ref:`is_line_folded()<class_CodeEdit_method_is_line_folded>`). These icons can be clicked to toggle the fold state, see :ref:`toggle_foldable_line()<class_CodeEdit_method_toggle_foldable_line>`. :ref:`line_folding<class_CodeEdit_property_line_folding>` must be ``true`` to show icons.

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

----

.. _class_CodeEdit_property_gutters_draw_line_numbers:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **gutters_draw_line_numbers** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_line_numbers>`

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

- |void| **set_draw_line_numbers**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_draw_line_numbers_enabled**\ (\ )

If ``true``, the line number gutter is drawn. Line numbers start at ``1`` and are incremented for each line of text. Clicking and dragging in the line number gutter will select entire lines of text.

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

----

.. _class_CodeEdit_property_gutters_zero_pad_line_numbers:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **gutters_zero_pad_line_numbers** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_zero_pad_line_numbers>`

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

- |void| **set_line_numbers_zero_padded**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_line_numbers_zero_padded**\ (\ )

If ``true``, line numbers drawn in the gutter are zero padded based on the total line count. Requires :ref:`gutters_draw_line_numbers<class_CodeEdit_property_gutters_draw_line_numbers>` to be set to ``true``.

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

----

.. _class_CodeEdit_property_indent_automatic:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **indent_automatic** = ``false`` :ref:`🔗<class_CodeEdit_property_indent_automatic>`

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

- |void| **set_auto_indent_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_auto_indent_enabled**\ (\ )

If ``true``, an extra indent is automatically inserted when a new line is added and a prefix in :ref:`indent_automatic_prefixes<class_CodeEdit_property_indent_automatic_prefixes>` is found. If a brace pair opening key is found, the matching closing brace will be moved to another new line (see :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>`).

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

----

.. _class_CodeEdit_property_indent_automatic_prefixes:

.. rst-class:: classref-property

:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **indent_automatic_prefixes** = ``[":", "{", "[", "("]`` :ref:`🔗<class_CodeEdit_property_indent_automatic_prefixes>`

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

- |void| **set_auto_indent_prefixes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_auto_indent_prefixes**\ (\ )

Prefixes to trigger an automatic indent. Used when :ref:`indent_automatic<class_CodeEdit_property_indent_automatic>` is set to ``true``.

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

----

.. _class_CodeEdit_property_indent_size:

.. rst-class:: classref-property

:ref:`int<class_int>` **indent_size** = ``4`` :ref:`🔗<class_CodeEdit_property_indent_size>`

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

- |void| **set_indent_size**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_indent_size**\ (\ )

Size of the tabulation indent (one :kbd:`Tab` press) in characters. If :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>` is enabled the number of spaces to use.

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

----

.. _class_CodeEdit_property_indent_use_spaces:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **indent_use_spaces** = ``false`` :ref:`🔗<class_CodeEdit_property_indent_use_spaces>`

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

- |void| **set_indent_using_spaces**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_indent_using_spaces**\ (\ )

Use spaces instead of tabs for indentation.

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

----

.. _class_CodeEdit_property_line_folding:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **line_folding** = ``false`` :ref:`🔗<class_CodeEdit_property_line_folding>`

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

- |void| **set_line_folding_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_line_folding_enabled**\ (\ )

If ``true``, lines can be folded. Otherwise, line folding methods like :ref:`fold_line()<class_CodeEdit_method_fold_line>` will not work and :ref:`can_fold_line()<class_CodeEdit_method_can_fold_line>` will always return ``false``. See :ref:`gutters_draw_fold_gutter<class_CodeEdit_property_gutters_draw_fold_gutter>`.

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

----

.. _class_CodeEdit_property_line_length_guidelines:

.. rst-class:: classref-property

:ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **line_length_guidelines** = ``[]`` :ref:`🔗<class_CodeEdit_property_line_length_guidelines>`

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

- |void| **set_line_length_guidelines**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`int<class_int>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **get_line_length_guidelines**\ (\ )

Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is drawn more prominently.

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

----

.. _class_CodeEdit_property_symbol_lookup_on_click:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **symbol_lookup_on_click** = ``false`` :ref:`🔗<class_CodeEdit_property_symbol_lookup_on_click>`

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

- |void| **set_symbol_lookup_on_click_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_symbol_lookup_on_click_enabled**\ (\ )

Set when a validated word from :ref:`symbol_validate<class_CodeEdit_signal_symbol_validate>` is clicked, the :ref:`symbol_lookup<class_CodeEdit_signal_symbol_lookup>` should be emitted.

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

----

.. _class_CodeEdit_property_symbol_tooltip_on_hover:

.. rst-class:: classref-property

:ref:`bool<class_bool>` **symbol_tooltip_on_hover** = ``false`` :ref:`🔗<class_CodeEdit_property_symbol_tooltip_on_hover>`

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

- |void| **set_symbol_tooltip_on_hover_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_symbol_tooltip_on_hover_enabled**\ (\ )

If ``true``, the :ref:`symbol_hovered<class_CodeEdit_signal_symbol_hovered>` signal is emitted when hovering over a word.

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

----

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

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

.. _class_CodeEdit_private_method__confirm_code_completion:

.. rst-class:: classref-method

|void| **_confirm_code_completion**\ (\ replace\: :ref:`bool<class_bool>`\ ) |virtual| :ref:`🔗<class_CodeEdit_private_method__confirm_code_completion>`

Override this method to define how the selected entry should be inserted. If ``replace`` is ``true``, any existing text should be replaced.

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

----

.. _class_CodeEdit_private_method__filter_code_completion_candidates:

.. rst-class:: classref-method

:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_filter_code_completion_candidates**\ (\ candidates\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) |virtual| |const| :ref:`🔗<class_CodeEdit_private_method__filter_code_completion_candidates>`

Override this method to define what items in ``candidates`` should be displayed.

Both ``candidates`` and the return is an :ref:`Array<class_Array>` of :ref:`Dictionary<class_Dictionary>`, see :ref:`get_code_completion_option()<class_CodeEdit_method_get_code_completion_option>` for :ref:`Dictionary<class_Dictionary>` content.

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

----

.. _class_CodeEdit_private_method__request_code_completion:

.. rst-class:: classref-method

|void| **_request_code_completion**\ (\ force\: :ref:`bool<class_bool>`\ ) |virtual| :ref:`🔗<class_CodeEdit_private_method__request_code_completion>`

Override this method to define what happens when the user requests code completion. If ``force`` is ``true``, any checks should be bypassed.

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

----

.. _class_CodeEdit_method_add_auto_brace_completion_pair:

.. rst-class:: classref-method

|void| **add_auto_brace_completion_pair**\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_add_auto_brace_completion_pair>`

Adds a brace pair.

Both the start and end keys must be symbols. Only the start key has to be unique.

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

----

.. _class_CodeEdit_method_add_code_completion_option:

.. rst-class:: classref-method

|void| **add_code_completion_option**\ (\ type\: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`, display_text\: :ref:`String<class_String>`, insert_text\: :ref:`String<class_String>`, text_color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), icon\: :ref:`Resource<class_Resource>` = null, value\: :ref:`Variant<class_Variant>` = null, location\: :ref:`int<class_int>` = 1024\ ) :ref:`🔗<class_CodeEdit_method_add_code_completion_option>`

Submits an item to the queue of potential candidates for the autocomplete menu. Call :ref:`update_code_completion_options()<class_CodeEdit_method_update_code_completion_options>` to update the list.

\ ``location`` indicates location of the option relative to the location of the code completion query. See :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` for how to set this value.

\ **Note:** This list will replace all current candidates.

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

----

.. _class_CodeEdit_method_add_comment_delimiter:

.. rst-class:: classref-method

|void| **add_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_add_comment_delimiter>`

Adds a comment delimiter from ``start_key`` to ``end_key``. Both keys should be symbols, and ``start_key`` must not be shared with other delimiters.

If ``line_only`` is ``true`` or ``end_key`` is an empty :ref:`String<class_String>`, the region does not carry over to the next line.

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

----

.. _class_CodeEdit_method_add_string_delimiter:

.. rst-class:: classref-method

|void| **add_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_add_string_delimiter>`

Defines a string delimiter from ``start_key`` to ``end_key``. Both keys should be symbols, and ``start_key`` must not be shared with other delimiters.

If ``line_only`` is ``true`` or ``end_key`` is an empty :ref:`String<class_String>`, the region does not carry over to the next line.

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

----

.. _class_CodeEdit_method_can_fold_line:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **can_fold_line**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_can_fold_line>`

Returns ``true`` if the given line is foldable. A line is foldable if it is the start of a valid code region (see :ref:`get_code_region_start_tag()<class_CodeEdit_method_get_code_region_start_tag>`), if it is the start of a comment or string block, or if the next non-empty line is more indented (see :ref:`TextEdit.get_indent_level()<class_TextEdit_method_get_indent_level>`).

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

----

.. _class_CodeEdit_method_cancel_code_completion:

.. rst-class:: classref-method

|void| **cancel_code_completion**\ (\ ) :ref:`🔗<class_CodeEdit_method_cancel_code_completion>`

Cancels the autocomplete menu.

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

----

.. _class_CodeEdit_method_clear_bookmarked_lines:

.. rst-class:: classref-method

|void| **clear_bookmarked_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_bookmarked_lines>`

Clears all bookmarked lines.

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

----

.. _class_CodeEdit_method_clear_breakpointed_lines:

.. rst-class:: classref-method

|void| **clear_breakpointed_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_breakpointed_lines>`

Clears all breakpointed lines.

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

----

.. _class_CodeEdit_method_clear_comment_delimiters:

.. rst-class:: classref-method

|void| **clear_comment_delimiters**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_comment_delimiters>`

Removes all comment delimiters.

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

----

.. _class_CodeEdit_method_clear_executing_lines:

.. rst-class:: classref-method

|void| **clear_executing_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_executing_lines>`

Clears all executed lines.

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

----

.. _class_CodeEdit_method_clear_string_delimiters:

.. rst-class:: classref-method

|void| **clear_string_delimiters**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_string_delimiters>`

Removes all string delimiters.

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

----

.. _class_CodeEdit_method_confirm_code_completion:

.. rst-class:: classref-method

|void| **confirm_code_completion**\ (\ replace\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_confirm_code_completion>`

Inserts the selected entry into the text. If ``replace`` is ``true``, any existing text is replaced rather than merged.

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

----

.. _class_CodeEdit_method_convert_indent:

.. rst-class:: classref-method

|void| **convert_indent**\ (\ from_line\: :ref:`int<class_int>` = -1, to_line\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_CodeEdit_method_convert_indent>`

Converts the indents of lines between ``from_line`` and ``to_line`` to tabs or spaces as set by :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`.

Values of ``-1`` convert the entire text.

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

----

.. _class_CodeEdit_method_create_code_region:

.. rst-class:: classref-method

|void| **create_code_region**\ (\ ) :ref:`🔗<class_CodeEdit_method_create_code_region>`

Creates a new code region with the selection. At least one single line comment delimiter have to be defined (see :ref:`add_comment_delimiter()<class_CodeEdit_method_add_comment_delimiter>`).

A code region is a part of code that is highlighted when folded and can help organize your script.

Code region start and end tags can be customized (see :ref:`set_code_region_tags()<class_CodeEdit_method_set_code_region_tags>`).

Code regions are delimited using start and end tags (respectively ``region`` and ``endregion`` by default) preceded by one line comment delimiter. (eg. ``#region`` and ``#endregion``)

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

----

.. _class_CodeEdit_method_delete_lines:

.. rst-class:: classref-method

|void| **delete_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_delete_lines>`

Deletes all lines that are selected or have a caret on them.

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

----

.. _class_CodeEdit_method_do_indent:

.. rst-class:: classref-method

|void| **do_indent**\ (\ ) :ref:`🔗<class_CodeEdit_method_do_indent>`

If there is no selection, indentation is inserted at the caret. Otherwise, the selected lines are indented like :ref:`indent_lines()<class_CodeEdit_method_indent_lines>`. Equivalent to the :ref:`ProjectSettings.input/ui_text_indent<class_ProjectSettings_property_input/ui_text_indent>` action. The indentation characters used depend on :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>` and :ref:`indent_size<class_CodeEdit_property_indent_size>`.

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

----

.. _class_CodeEdit_method_duplicate_lines:

.. rst-class:: classref-method

|void| **duplicate_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_duplicate_lines>`

Duplicates all lines currently selected with any caret. Duplicates the entire line beneath the current one no matter where the caret is within the line.

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

----

.. _class_CodeEdit_method_duplicate_selection:

.. rst-class:: classref-method

|void| **duplicate_selection**\ (\ ) :ref:`🔗<class_CodeEdit_method_duplicate_selection>`

Duplicates all selected text and duplicates all lines with a caret on them.

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

----

.. _class_CodeEdit_method_fold_all_lines:

.. rst-class:: classref-method

|void| **fold_all_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_fold_all_lines>`

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

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

----

.. _class_CodeEdit_method_fold_line:

.. rst-class:: classref-method

|void| **fold_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_fold_line>`

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

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

----

.. _class_CodeEdit_method_get_auto_brace_completion_close_key:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_auto_brace_completion_close_key**\ (\ open_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_auto_brace_completion_close_key>`

Gets the matching auto brace close key for ``open_key``.

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

----

.. _class_CodeEdit_method_get_bookmarked_lines:

.. rst-class:: classref-method

:ref:`PackedInt32Array<class_PackedInt32Array>` **get_bookmarked_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_bookmarked_lines>`

Gets all bookmarked lines.

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

----

.. _class_CodeEdit_method_get_breakpointed_lines:

.. rst-class:: classref-method

:ref:`PackedInt32Array<class_PackedInt32Array>` **get_breakpointed_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_breakpointed_lines>`

Gets all breakpointed lines.

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

----

.. _class_CodeEdit_method_get_code_completion_option:

.. rst-class:: classref-method

:ref:`Dictionary<class_Dictionary>` **get_code_completion_option**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_option>`

Gets the completion option at ``index``. The return :ref:`Dictionary<class_Dictionary>` has the following key-values:

\ ``kind``: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`\ 

\ ``display_text``: Text that is shown on the autocomplete menu.

\ ``insert_text``: Text that is to be inserted when this item is selected.

\ ``font_color``: Color of the text on the autocomplete menu.

\ ``icon``: Icon to draw on the autocomplete menu.

\ ``default_value``: Value of the symbol.

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

----

.. _class_CodeEdit_method_get_code_completion_options:

.. rst-class:: classref-method

:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_code_completion_options**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_options>`

Gets all completion options, see :ref:`get_code_completion_option()<class_CodeEdit_method_get_code_completion_option>` for return content.

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

----

.. _class_CodeEdit_method_get_code_completion_selected_index:

.. rst-class:: classref-method

:ref:`int<class_int>` **get_code_completion_selected_index**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_selected_index>`

Gets the index of the current selected completion option.

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

----

.. _class_CodeEdit_method_get_code_region_end_tag:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_code_region_end_tag**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_region_end_tag>`

Returns the code region end tag (without comment delimiter).

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

----

.. _class_CodeEdit_method_get_code_region_start_tag:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_code_region_start_tag**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_region_start_tag>`

Returns the code region start tag (without comment delimiter).

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

----

.. _class_CodeEdit_method_get_delimiter_end_key:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_delimiter_end_key**\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_end_key>`

Gets the end key for a string or comment region index.

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

----

.. _class_CodeEdit_method_get_delimiter_end_position:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_delimiter_end_position**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_end_position>`

If ``line`` ``column`` is in a string or comment, returns the end position of the region. If not or no end could be found, both :ref:`Vector2<class_Vector2>` values will be ``-1``.

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

----

.. _class_CodeEdit_method_get_delimiter_start_key:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_delimiter_start_key**\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_start_key>`

Gets the start key for a string or comment region index.

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

----

.. _class_CodeEdit_method_get_delimiter_start_position:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **get_delimiter_start_position**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_start_position>`

If ``line`` ``column`` is in a string or comment, returns the start position of the region. If not or no start could be found, both :ref:`Vector2<class_Vector2>` values will be ``-1``.

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

----

.. _class_CodeEdit_method_get_executing_lines:

.. rst-class:: classref-method

:ref:`PackedInt32Array<class_PackedInt32Array>` **get_executing_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_executing_lines>`

Gets all executing lines.

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

----

.. _class_CodeEdit_method_get_folded_lines:

.. rst-class:: classref-method

:ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **get_folded_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_folded_lines>`

Returns all lines that are currently folded.

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

----

.. _class_CodeEdit_method_get_text_for_code_completion:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_text_for_code_completion**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_for_code_completion>`

Returns the full text with char ``0xFFFF`` at the caret location.

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

----

.. _class_CodeEdit_method_get_text_for_symbol_lookup:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_text_for_symbol_lookup**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_for_symbol_lookup>`

Returns the full text with char ``0xFFFF`` at the cursor location.

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

----

.. _class_CodeEdit_method_get_text_with_cursor_char:

.. rst-class:: classref-method

:ref:`String<class_String>` **get_text_with_cursor_char**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_with_cursor_char>`

Returns the full text with char ``0xFFFF`` at the specified location.

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

----

.. _class_CodeEdit_method_has_auto_brace_completion_close_key:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_auto_brace_completion_close_key**\ (\ close_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_auto_brace_completion_close_key>`

Returns ``true`` if close key ``close_key`` exists.

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

----

.. _class_CodeEdit_method_has_auto_brace_completion_open_key:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_auto_brace_completion_open_key**\ (\ open_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_auto_brace_completion_open_key>`

Returns ``true`` if open key ``open_key`` exists.

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

----

.. _class_CodeEdit_method_has_comment_delimiter:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_comment_delimiter>`

Returns ``true`` if comment ``start_key`` exists.

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

----

.. _class_CodeEdit_method_has_string_delimiter:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **has_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_string_delimiter>`

Returns ``true`` if string ``start_key`` exists.

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

----

.. _class_CodeEdit_method_indent_lines:

.. rst-class:: classref-method

|void| **indent_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_indent_lines>`

Indents all lines that are selected or have a caret on them. Uses spaces or a tab depending on :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`. See :ref:`unindent_lines()<class_CodeEdit_method_unindent_lines>`.

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

----

.. _class_CodeEdit_method_is_in_comment:

.. rst-class:: classref-method

:ref:`int<class_int>` **is_in_comment**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_CodeEdit_method_is_in_comment>`

Returns delimiter index if ``line`` ``column`` is in a comment. If ``column`` is not provided, will return delimiter index if the entire ``line`` is a comment. Otherwise ``-1``.

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

----

.. _class_CodeEdit_method_is_in_string:

.. rst-class:: classref-method

:ref:`int<class_int>` **is_in_string**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_CodeEdit_method_is_in_string>`

Returns the delimiter index if ``line`` ``column`` is in a string. If ``column`` is not provided, will return the delimiter index if the entire ``line`` is a string. Otherwise ``-1``.

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

----

.. _class_CodeEdit_method_is_line_bookmarked:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_bookmarked**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_bookmarked>`

Returns ``true`` if the given line is bookmarked. See :ref:`set_line_as_bookmarked()<class_CodeEdit_method_set_line_as_bookmarked>`.

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

----

.. _class_CodeEdit_method_is_line_breakpointed:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_breakpointed**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_breakpointed>`

Returns ``true`` if the given line is breakpointed. See :ref:`set_line_as_breakpoint()<class_CodeEdit_method_set_line_as_breakpoint>`.

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

----

.. _class_CodeEdit_method_is_line_code_region_end:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_code_region_end**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_code_region_end>`

Returns ``true`` if the given line is a code region end. See :ref:`set_code_region_tags()<class_CodeEdit_method_set_code_region_tags>`.

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

----

.. _class_CodeEdit_method_is_line_code_region_start:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_code_region_start**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_code_region_start>`

Returns ``true`` if the given line is a code region start. See :ref:`set_code_region_tags()<class_CodeEdit_method_set_code_region_tags>`.

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

----

.. _class_CodeEdit_method_is_line_executing:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_executing**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_executing>`

Returns ``true`` if the given line is marked as executing. See :ref:`set_line_as_executing()<class_CodeEdit_method_set_line_as_executing>`.

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

----

.. _class_CodeEdit_method_is_line_folded:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_line_folded**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_folded>`

Returns ``true`` if the given line is folded. See :ref:`fold_line()<class_CodeEdit_method_fold_line>`.

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

----

.. _class_CodeEdit_method_move_lines_down:

.. rst-class:: classref-method

|void| **move_lines_down**\ (\ ) :ref:`🔗<class_CodeEdit_method_move_lines_down>`

Moves all lines down that are selected or have a caret on them.

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

----

.. _class_CodeEdit_method_move_lines_up:

.. rst-class:: classref-method

|void| **move_lines_up**\ (\ ) :ref:`🔗<class_CodeEdit_method_move_lines_up>`

Moves all lines up that are selected or have a caret on them.

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

----

.. _class_CodeEdit_method_remove_comment_delimiter:

.. rst-class:: classref-method

|void| **remove_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_remove_comment_delimiter>`

Removes the comment delimiter with ``start_key``.

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

----

.. _class_CodeEdit_method_remove_string_delimiter:

.. rst-class:: classref-method

|void| **remove_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_remove_string_delimiter>`

Removes the string delimiter with ``start_key``.

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

----

.. _class_CodeEdit_method_request_code_completion:

.. rst-class:: classref-method

|void| **request_code_completion**\ (\ force\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_request_code_completion>`

Emits :ref:`code_completion_requested<class_CodeEdit_signal_code_completion_requested>`, if ``force`` is ``true`` will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path, or signal.

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

----

.. _class_CodeEdit_method_set_code_completion_selected_index:

.. rst-class:: classref-method

|void| **set_code_completion_selected_index**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_completion_selected_index>`

Sets the current selected completion option.

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

----

.. _class_CodeEdit_method_set_code_hint:

.. rst-class:: classref-method

|void| **set_code_hint**\ (\ code_hint\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_hint>`

Sets the code hint text. Pass an empty string to clear.

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

----

.. _class_CodeEdit_method_set_code_hint_draw_below:

.. rst-class:: classref-method

|void| **set_code_hint_draw_below**\ (\ draw_below\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_hint_draw_below>`

If ``true``, the code hint will draw below the main caret. If ``false``, the code hint will draw above the main caret. See :ref:`set_code_hint()<class_CodeEdit_method_set_code_hint>`.

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

----

.. _class_CodeEdit_method_set_code_region_tags:

.. rst-class:: classref-method

|void| **set_code_region_tags**\ (\ start\: :ref:`String<class_String>` = "region", end\: :ref:`String<class_String>` = "endregion"\ ) :ref:`🔗<class_CodeEdit_method_set_code_region_tags>`

Sets the code region start and end tags (without comment delimiter).

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

----

.. _class_CodeEdit_method_set_line_as_bookmarked:

.. rst-class:: classref-method

|void| **set_line_as_bookmarked**\ (\ line\: :ref:`int<class_int>`, bookmarked\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_bookmarked>`

Sets the given line as bookmarked. If ``true`` and :ref:`gutters_draw_bookmarks<class_CodeEdit_property_gutters_draw_bookmarks>` is ``true``, draws the :ref:`bookmark<class_CodeEdit_theme_icon_bookmark>` icon in the gutter for this line. See :ref:`get_bookmarked_lines()<class_CodeEdit_method_get_bookmarked_lines>` and :ref:`is_line_bookmarked()<class_CodeEdit_method_is_line_bookmarked>`.

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

----

.. _class_CodeEdit_method_set_line_as_breakpoint:

.. rst-class:: classref-method

|void| **set_line_as_breakpoint**\ (\ line\: :ref:`int<class_int>`, breakpointed\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_breakpoint>`

Sets the given line as a breakpoint. If ``true`` and :ref:`gutters_draw_breakpoints_gutter<class_CodeEdit_property_gutters_draw_breakpoints_gutter>` is ``true``, draws the :ref:`breakpoint<class_CodeEdit_theme_icon_breakpoint>` icon in the gutter for this line. See :ref:`get_breakpointed_lines()<class_CodeEdit_method_get_breakpointed_lines>` and :ref:`is_line_breakpointed()<class_CodeEdit_method_is_line_breakpointed>`.

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

----

.. _class_CodeEdit_method_set_line_as_executing:

.. rst-class:: classref-method

|void| **set_line_as_executing**\ (\ line\: :ref:`int<class_int>`, executing\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_executing>`

Sets the given line as executing. If ``true`` and :ref:`gutters_draw_executing_lines<class_CodeEdit_property_gutters_draw_executing_lines>` is ``true``, draws the :ref:`executing_line<class_CodeEdit_theme_icon_executing_line>` icon in the gutter for this line. See :ref:`get_executing_lines()<class_CodeEdit_method_get_executing_lines>` and :ref:`is_line_executing()<class_CodeEdit_method_is_line_executing>`.

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

----

.. _class_CodeEdit_method_set_symbol_lookup_word_as_valid:

.. rst-class:: classref-method

|void| **set_symbol_lookup_word_as_valid**\ (\ valid\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`

Sets the symbol emitted by :ref:`symbol_validate<class_CodeEdit_signal_symbol_validate>` as a valid lookup.

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

----

.. _class_CodeEdit_method_toggle_foldable_line:

.. rst-class:: classref-method

|void| **toggle_foldable_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_toggle_foldable_line>`

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

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

----

.. _class_CodeEdit_method_toggle_foldable_lines_at_carets:

.. rst-class:: classref-method

|void| **toggle_foldable_lines_at_carets**\ (\ ) :ref:`🔗<class_CodeEdit_method_toggle_foldable_lines_at_carets>`

Toggle the folding of the code block on all lines with a caret on them.

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

----

.. _class_CodeEdit_method_unfold_all_lines:

.. rst-class:: classref-method

|void| **unfold_all_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_unfold_all_lines>`

Unfolds all lines that are folded.

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

----

.. _class_CodeEdit_method_unfold_line:

.. rst-class:: classref-method

|void| **unfold_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_unfold_line>`

Unfolds the given line if it is folded or if it is hidden under a folded line.

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

----

.. _class_CodeEdit_method_unindent_lines:

.. rst-class:: classref-method

|void| **unindent_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_unindent_lines>`

Unindents all lines that are selected or have a caret on them. Uses spaces or a tab depending on :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`. Equivalent to the :ref:`ProjectSettings.input/ui_text_dedent<class_ProjectSettings_property_input/ui_text_dedent>` action. See :ref:`indent_lines()<class_CodeEdit_method_indent_lines>`.

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

----

.. _class_CodeEdit_method_update_code_completion_options:

.. rst-class:: classref-method

|void| **update_code_completion_options**\ (\ force\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_update_code_completion_options>`

Submits all completion options added with :ref:`add_code_completion_option()<class_CodeEdit_method_add_code_completion_option>`. Will try to force the autocomplete menu to popup, if ``force`` is ``true``.

\ **Note:** This will replace all current candidates.

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

----

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

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

.. _class_CodeEdit_theme_color_bookmark_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **bookmark_color** = ``Color(0.5, 0.64, 1, 0.8)`` :ref:`🔗<class_CodeEdit_theme_color_bookmark_color>`

:ref:`Color<class_Color>` of the bookmark icon for bookmarked lines.

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

----

.. _class_CodeEdit_theme_color_brace_mismatch_color:

.. rst-class:: classref-themeproperty

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

:ref:`Color<class_Color>` of the text to highlight mismatched braces.

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

----

.. _class_CodeEdit_theme_color_breakpoint_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **breakpoint_color** = ``Color(0.9, 0.29, 0.3, 1)`` :ref:`🔗<class_CodeEdit_theme_color_breakpoint_color>`

:ref:`Color<class_Color>` of the breakpoint icon for bookmarked lines.

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

----

.. _class_CodeEdit_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)`` :ref:`🔗<class_CodeEdit_theme_color_code_folding_color>`

:ref:`Color<class_Color>` for all icons related to line folding.

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

----

.. _class_CodeEdit_theme_color_completion_background_color:

.. rst-class:: classref-themeproperty

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

Sets the background :ref:`Color<class_Color>` for the code completion popup.

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

----

.. _class_CodeEdit_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)`` :ref:`🔗<class_CodeEdit_theme_color_completion_existing_color>`

Background highlight :ref:`Color<class_Color>` for matching text in code completion options.

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

----

.. _class_CodeEdit_theme_color_completion_scroll_color:

.. rst-class:: classref-themeproperty

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

:ref:`Color<class_Color>` of the scrollbar in the code completion popup.

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

----

.. _class_CodeEdit_theme_color_completion_scroll_hovered_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **completion_scroll_hovered_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗<class_CodeEdit_theme_color_completion_scroll_hovered_color>`

:ref:`Color<class_Color>` of the scrollbar in the code completion popup when hovered.

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

----

.. _class_CodeEdit_theme_color_completion_selected_color:

.. rst-class:: classref-themeproperty

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

Background highlight :ref:`Color<class_Color>` for the current selected option item in the code completion popup.

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

----

.. _class_CodeEdit_theme_color_executing_line_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **executing_line_color** = ``Color(0.98, 0.89, 0.27, 1)`` :ref:`🔗<class_CodeEdit_theme_color_executing_line_color>`

:ref:`Color<class_Color>` of the executing icon for executing lines.

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

----

.. _class_CodeEdit_theme_color_folded_code_region_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **folded_code_region_color** = ``Color(0.68, 0.46, 0.77, 0.2)`` :ref:`🔗<class_CodeEdit_theme_color_folded_code_region_color>`

:ref:`Color<class_Color>` of background line highlight for folded code region.

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

----

.. _class_CodeEdit_theme_color_line_length_guideline_color:

.. rst-class:: classref-themeproperty

:ref:`Color<class_Color>` **line_length_guideline_color** = ``Color(0.3, 0.5, 0.8, 0.1)`` :ref:`🔗<class_CodeEdit_theme_color_line_length_guideline_color>`

:ref:`Color<class_Color>` of the main line length guideline, secondary guidelines will have 50% alpha applied.

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

----

.. _class_CodeEdit_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)`` :ref:`🔗<class_CodeEdit_theme_color_line_number_color>`

Sets the :ref:`Color<class_Color>` of line numbers.

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

----

.. _class_CodeEdit_theme_constant_completion_lines:

.. rst-class:: classref-themeproperty

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

Max number of options to display in the code completion popup at any one time.

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

----

.. _class_CodeEdit_theme_constant_completion_max_width:

.. rst-class:: classref-themeproperty

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

Max width of options in the code completion popup. Options longer than this will be cut off.

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

----

.. _class_CodeEdit_theme_constant_completion_scroll_width:

.. rst-class:: classref-themeproperty

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

Width of the scrollbar in the code completion popup.

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

----

.. _class_CodeEdit_theme_icon_bookmark:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **bookmark** :ref:`🔗<class_CodeEdit_theme_icon_bookmark>`

Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the bookmark gutter for bookmarked lines.

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

----

.. _class_CodeEdit_theme_icon_breakpoint:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **breakpoint** :ref:`🔗<class_CodeEdit_theme_icon_breakpoint>`

Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the breakpoint gutter for breakpointed lines.

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

----

.. _class_CodeEdit_theme_icon_can_fold:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **can_fold** :ref:`🔗<class_CodeEdit_theme_icon_can_fold>`

Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line can be folded.

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

----

.. _class_CodeEdit_theme_icon_can_fold_code_region:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **can_fold_code_region** :ref:`🔗<class_CodeEdit_theme_icon_can_fold_code_region>`

Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a code region can be folded.

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

----

.. _class_CodeEdit_theme_icon_completion_color_bg:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **completion_color_bg** :ref:`🔗<class_CodeEdit_theme_icon_completion_color_bg>`

Background panel for the color preview box in autocompletion (visible when the color is translucent).

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

----

.. _class_CodeEdit_theme_icon_executing_line:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **executing_line** :ref:`🔗<class_CodeEdit_theme_icon_executing_line>`

Icon to draw in the executing gutter for executing lines.

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

----

.. _class_CodeEdit_theme_icon_folded:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **folded** :ref:`🔗<class_CodeEdit_theme_icon_folded>`

Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line is folded and can be unfolded.

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

----

.. _class_CodeEdit_theme_icon_folded_code_region:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **folded_code_region** :ref:`🔗<class_CodeEdit_theme_icon_folded_code_region>`

Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a code region is folded and can be unfolded.

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

----

.. _class_CodeEdit_theme_icon_folded_eol_icon:

.. rst-class:: classref-themeproperty

:ref:`Texture2D<class_Texture2D>` **folded_eol_icon** :ref:`🔗<class_CodeEdit_theme_icon_folded_eol_icon>`

Sets a custom :ref:`Texture2D<class_Texture2D>` to draw at the end of a folded line.

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

----

.. _class_CodeEdit_theme_style_completion:

.. rst-class:: classref-themeproperty

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

:ref:`StyleBox<class_StyleBox>` for the code completion popup.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |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.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`