godotengine/godot-docs-l10n
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs-l10n.git synced 2026-01-05 14:10:19 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
e152ffea6cebc49a8474f2ae1600f8ac22ead11a
godot-docs-l10n/classes/zh_CN/class_codeedit.rst

1978 lines
128 KiB
ReStructuredText
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/CodeEdit.xml.
.. _class_CodeEdit:
CodeEdit
========
**继承：** :ref:`TextEdit<class_TextEdit>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
多行文本编辑器，针对编辑代码而设计。
.. rst-class:: classref-introduction-group
描述
----
CodeEdit 是一种专门用于编辑纯文本代码文件的 :ref:`TextEdit<class_TextEdit>`\ 。它包含了许多代码编辑器中的常见功能，如行号、折行、代码补全、缩进管理以及字符串/注释管理。
\ **注意：**\ 无论使用什么区域设置，\ **CodeEdit** 默认总是使用从左至右的文本方向来正确显示源代码。
.. rst-class:: classref-reftable-group
属性
----
.. 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:`String[]<class_String>` | :ref:`code_completion_prefixes<class_CodeEdit_property_code_completion_prefixes>` | ``[]`` |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`String[]<class_String>` | :ref:`delimiter_comments<class_CodeEdit_property_delimiter_comments>` | ``[]`` |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :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:`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:`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:`TextDirection<enum_Control_TextDirection>` | text_direction | ``1`` (overrides :ref:`TextEdit<class_TextEdit_property_text_direction>`) |
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
方法
----
.. table::
:widths: auto
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_confirm_code_completion<class_CodeEdit_private_method__confirm_code_completion>` **(** :ref:`bool<class_bool>` replace **)** |virtual| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary[]<class_Dictionary>` | :ref:`_filter_code_completion_candidates<class_CodeEdit_private_method__filter_code_completion_candidates>` **(** :ref:`Dictionary[]<class_Dictionary>` candidates **)** |virtual| |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`_request_code_completion<class_CodeEdit_private_method__request_code_completion>` **(** :ref:`bool<class_bool>` force **)** |virtual| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_auto_brace_completion_pair<class_CodeEdit_method_add_auto_brace_completion_pair>` **(** :ref:`String<class_String>` start_key, :ref:`String<class_String>` end_key **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_code_completion_option<class_CodeEdit_method_add_code_completion_option>` **(** :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` type, :ref:`String<class_String>` display_text, :ref:`String<class_String>` insert_text, :ref:`Color<class_Color>` text_color=Color(1, 1, 1, 1), :ref:`Resource<class_Resource>` icon=null, :ref:`Variant<class_Variant>` value=0, :ref:`int<class_int>` location=1024 **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_comment_delimiter<class_CodeEdit_method_add_comment_delimiter>` **(** :ref:`String<class_String>` start_key, :ref:`String<class_String>` end_key, :ref:`bool<class_bool>` line_only=false **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_string_delimiter<class_CodeEdit_method_add_string_delimiter>` **(** :ref:`String<class_String>` start_key, :ref:`String<class_String>` end_key, :ref:`bool<class_bool>` line_only=false **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_fold_line<class_CodeEdit_method_can_fold_line>` **(** :ref:`int<class_int>` line **)** |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>` **(** :ref:`bool<class_bool>` replace=false **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`convert_indent<class_CodeEdit_method_convert_indent>` **(** :ref:`int<class_int>` from_line=-1, :ref:`int<class_int>` to_line=-1 **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`create_code_region<class_CodeEdit_method_create_code_region>` **(** **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`do_indent<class_CodeEdit_method_do_indent>` **(** **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`duplicate_lines<class_CodeEdit_method_duplicate_lines>` **(** **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fold_all_lines<class_CodeEdit_method_fold_all_lines>` **(** **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fold_line<class_CodeEdit_method_fold_line>` **(** :ref:`int<class_int>` line **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_auto_brace_completion_close_key<class_CodeEdit_method_get_auto_brace_completion_close_key>` **(** :ref:`String<class_String>` open_key **)** |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>` **(** :ref:`int<class_int>` index **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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>` **(** :ref:`int<class_int>` delimiter_index **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_delimiter_end_position<class_CodeEdit_method_get_delimiter_end_position>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_delimiter_start_key<class_CodeEdit_method_get_delimiter_start_key>` **(** :ref:`int<class_int>` delimiter_index **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_delimiter_start_position<class_CodeEdit_method_get_delimiter_start_position>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_executing_lines<class_CodeEdit_method_get_executing_lines>` **(** **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_auto_brace_completion_close_key<class_CodeEdit_method_has_auto_brace_completion_close_key>` **(** :ref:`String<class_String>` close_key **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_auto_brace_completion_open_key<class_CodeEdit_method_has_auto_brace_completion_open_key>` **(** :ref:`String<class_String>` open_key **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_comment_delimiter<class_CodeEdit_method_has_comment_delimiter>` **(** :ref:`String<class_String>` start_key **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_string_delimiter<class_CodeEdit_method_has_string_delimiter>` **(** :ref:`String<class_String>` start_key **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`indent_lines<class_CodeEdit_method_indent_lines>` **(** **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_in_comment<class_CodeEdit_method_is_in_comment>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column=-1 **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_in_string<class_CodeEdit_method_is_in_string>` **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column=-1 **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_bookmarked<class_CodeEdit_method_is_line_bookmarked>` **(** :ref:`int<class_int>` line **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_breakpointed<class_CodeEdit_method_is_line_breakpointed>` **(** :ref:`int<class_int>` line **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_code_region_end<class_CodeEdit_method_is_line_code_region_end>` **(** :ref:`int<class_int>` line **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_code_region_start<class_CodeEdit_method_is_line_code_region_start>` **(** :ref:`int<class_int>` line **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_executing<class_CodeEdit_method_is_line_executing>` **(** :ref:`int<class_int>` line **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_folded<class_CodeEdit_method_is_line_folded>` **(** :ref:`int<class_int>` line **)** |const| |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_comment_delimiter<class_CodeEdit_method_remove_comment_delimiter>` **(** :ref:`String<class_String>` start_key **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_string_delimiter<class_CodeEdit_method_remove_string_delimiter>` **(** :ref:`String<class_String>` start_key **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`request_code_completion<class_CodeEdit_method_request_code_completion>` **(** :ref:`bool<class_bool>` force=false **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_code_completion_selected_index<class_CodeEdit_method_set_code_completion_selected_index>` **(** :ref:`int<class_int>` index **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_code_hint<class_CodeEdit_method_set_code_hint>` **(** :ref:`String<class_String>` code_hint **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_code_hint_draw_below<class_CodeEdit_method_set_code_hint_draw_below>` **(** :ref:`bool<class_bool>` draw_below **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_code_region_tags<class_CodeEdit_method_set_code_region_tags>` **(** :ref:`String<class_String>` start="region", :ref:`String<class_String>` end="endregion" **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_line_as_bookmarked<class_CodeEdit_method_set_line_as_bookmarked>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` bookmarked **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_line_as_breakpoint<class_CodeEdit_method_set_line_as_breakpoint>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` breakpointed **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_line_as_executing<class_CodeEdit_method_set_line_as_executing>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` executing **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_symbol_lookup_word_as_valid<class_CodeEdit_method_set_symbol_lookup_word_as_valid>` **(** :ref:`bool<class_bool>` valid **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`toggle_foldable_line<class_CodeEdit_method_toggle_foldable_line>` **(** :ref:`int<class_int>` line **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unfold_all_lines<class_CodeEdit_method_unfold_all_lines>` **(** **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unfold_line<class_CodeEdit_method_unfold_line>` **(** :ref:`int<class_int>` line **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`unindent_lines<class_CodeEdit_method_unindent_lines>` **(** **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`update_code_completion_options<class_CodeEdit_method_update_code_completion_options>` **(** :ref:`bool<class_bool>` force **)** |
+-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
主题属性
--------
.. 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:`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
信号
----
.. _class_CodeEdit_signal_breakpoint_toggled:
.. rst-class:: classref-signal
**breakpoint_toggled** **(** :ref:`int<class_int>` line **)**
在行中添加或移除断点时触发。如果该行通过退格键移动，则在旧行处触发一个移除的信号。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_signal_code_completion_requested:
.. rst-class:: classref-signal
**code_completion_requested** **(** **)**
当用户请求代码补全时触发。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_signal_symbol_lookup:
.. rst-class:: classref-signal
**symbol_lookup** **(** :ref:`String<class_String>` symbol, :ref:`int<class_int>` line, :ref:`int<class_int>` column **)**
用户点击有效符号时发出。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_signal_symbol_validate:
.. rst-class:: classref-signal
**symbol_validate** **(** :ref:`String<class_String>` symbol **)**
用户将鼠标悬停在符号上时发出。应该通过调用 :ref:`set_symbol_lookup_word_as_valid<class_CodeEdit_method_set_symbol_lookup_word_as_valid>` 对该符号进行验证和响应。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
枚举
----
.. _enum_CodeEdit_CodeCompletionKind:
.. rst-class:: classref-enumeration
enum **CodeCompletionKind**:
.. _class_CodeEdit_constant_KIND_CLASS:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CLASS** = ``0``
将该选项标记为类。
.. _class_CodeEdit_constant_KIND_FUNCTION:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FUNCTION** = ``1``
将该选项标记为函数。
.. _class_CodeEdit_constant_KIND_SIGNAL:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_SIGNAL** = ``2``
将该选项标记为 Godot 信号。
.. _class_CodeEdit_constant_KIND_VARIABLE:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_VARIABLE** = ``3``
将该选项标记为变量。
.. _class_CodeEdit_constant_KIND_MEMBER:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_MEMBER** = ``4``
将该选项标记为成员。
.. _class_CodeEdit_constant_KIND_ENUM:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_ENUM** = ``5``
将该选项标记为枚举条目。
.. _class_CodeEdit_constant_KIND_CONSTANT:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CONSTANT** = ``6``
将该选项标记为常量。
.. _class_CodeEdit_constant_KIND_NODE_PATH:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_NODE_PATH** = ``7``
将该选项标记为 Godot 节点路径。
.. _class_CodeEdit_constant_KIND_FILE_PATH:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FILE_PATH** = ``8``
将该选项标记为文件路径。
.. _class_CodeEdit_constant_KIND_PLAIN_TEXT:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_PLAIN_TEXT** = ``9``
将该选项标记为未分类或纯文本。
.. rst-class:: classref-item-separator
----
.. _enum_CodeEdit_CodeCompletionLocation:
.. rst-class:: classref-enumeration
enum **CodeCompletionLocation**:
.. _class_CodeEdit_constant_LOCATION_LOCAL:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_LOCAL** = ``0``
该选项是相对于代码补全查询位置的 - 例如局部变量。位置的后续值表示选项来自外部类，确切的值表示它们的距离（就内部类而言）。
.. _class_CodeEdit_constant_LOCATION_PARENT_MASK:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_PARENT_MASK** = ``256``
该选项来自于所在的类或父类，相对于代码补全查询的位置。请使用类的深度进行按位 OR（或）运算（例如 0 表示当前类，1 表示父类，2 表示父类的父类等），从而在当前类或父类中存储选项的深度。
.. _class_CodeEdit_constant_LOCATION_OTHER_USER_CODE:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER_USER_CODE** = ``512``
该选项来自用户代码，不是局部，也不是派生类（例如自动加载单例）。
.. _class_CodeEdit_constant_LOCATION_OTHER:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER** = ``1024``
该选项来自其他引擎代码，未被其他枚举常量覆盖 - 例如内置类。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
属性说明
--------
.. _class_CodeEdit_property_auto_brace_completion_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **auto_brace_completion_enabled** = ``false``
.. rst-class:: classref-property-setget
- void **set_auto_brace_completion_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_auto_brace_completion_enabled** **(** **)**
设置括号对是否应自动补全。
.. 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``
.. rst-class:: classref-property-setget
- void **set_highlight_matching_braces_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_highlight_matching_braces_enabled** **(** **)**
高亮不匹配的括号对。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_auto_brace_completion_pairs:
.. rst-class:: classref-property
:ref:`Dictionary<class_Dictionary>` **auto_brace_completion_pairs** = ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }``
.. rst-class:: classref-property-setget
- void **set_auto_brace_completion_pairs** **(** :ref:`Dictionary<class_Dictionary>` value **)**
- :ref:`Dictionary<class_Dictionary>` **get_auto_brace_completion_pairs** **(** **)**
将括号对设置为自动补全。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_code_completion_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **code_completion_enabled** = ``false``
.. rst-class:: classref-property-setget
- void **set_code_completion_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_code_completion_enabled** **(** **)**
设置是否允许代码补全。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_code_completion_prefixes:
.. rst-class:: classref-property
:ref:`String[]<class_String>` **code_completion_prefixes** = ``[]``
.. rst-class:: classref-property-setget
- void **set_code_completion_prefixes** **(** :ref:`String[]<class_String>` value **)**
- :ref:`String[]<class_String>` **get_code_completion_prefixes** **(** **)**
设置将触发代码补全的前缀。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_delimiter_comments:
.. rst-class:: classref-property
:ref:`String[]<class_String>` **delimiter_comments** = ``[]``
.. rst-class:: classref-property-setget
- void **set_comment_delimiters** **(** :ref:`String[]<class_String>` value **)**
- :ref:`String[]<class_String>` **get_comment_delimiters** **(** **)**
设置注释分隔符。将删除所有的现有注释分隔符。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_delimiter_strings:
.. rst-class:: classref-property
:ref:`String[]<class_String>` **delimiter_strings** = ``["' '", "\" \""]``
.. rst-class:: classref-property-setget
- void **set_string_delimiters** **(** :ref:`String[]<class_String>` value **)**
- :ref:`String[]<class_String>` **get_string_delimiters** **(** **)**
设置字符串分隔符。将删除所有的现有字符串分隔符。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_draw_bookmarks:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gutters_draw_bookmarks** = ``false``
.. rst-class:: classref-property-setget
- void **set_draw_bookmarks_gutter** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_bookmarks_gutter** **(** **)**
设置是否应在边栏中绘制书签。该边栏与断点和执行行共享。
.. 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``
.. rst-class:: classref-property-setget
- void **set_draw_breakpoints_gutter** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_breakpoints_gutter** **(** **)**
设置是否应在边栏中绘制断点。该边栏与书签和执行行共享。
.. 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``
.. rst-class:: classref-property-setget
- void **set_draw_executing_lines_gutter** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_executing_lines_gutter** **(** **)**
设置是否应在边栏中绘制执行行。该边栏与断点和书签共享。
.. 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``
.. rst-class:: classref-property-setget
- void **set_draw_fold_gutter** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_drawing_fold_gutter** **(** **)**
设置是否应在装订线中绘制可折叠行图标。
.. 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``
.. rst-class:: classref-property-setget
- void **set_draw_line_numbers** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_draw_line_numbers_enabled** **(** **)**
设置是否应在装订线中绘制行号。
.. 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``
.. rst-class:: classref-property-setget
- void **set_line_numbers_zero_padded** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_line_numbers_zero_padded** **(** **)**
设置在装订线中绘制的行号是否填充零。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_automatic:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **indent_automatic** = ``false``
.. rst-class:: classref-property-setget
- void **set_auto_indent_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_auto_indent_enabled** **(** **)**
设置是否启用自动缩进，如果找到前缀或括号，这将添加额外的缩进。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_automatic_prefixes:
.. rst-class:: classref-property
:ref:`String[]<class_String>` **indent_automatic_prefixes** = ``[":", "{", "[", "("]``
.. rst-class:: classref-property-setget
- void **set_auto_indent_prefixes** **(** :ref:`String[]<class_String>` value **)**
- :ref:`String[]<class_String>` **get_auto_indent_prefixes** **(** **)**
触发自动缩进的前缀。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_size:
.. rst-class:: classref-property
:ref:`int<class_int>` **indent_size** = ``4``
.. rst-class:: classref-property-setget
- void **set_indent_size** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_indent_size** **(** **)**
制表缩进的大小（按一次 :kbd:`Tab`\ ），以字符为单位。如果启用 :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`\ ，则代表使用的空格数。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_use_spaces:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **indent_use_spaces** = ``false``
.. rst-class:: classref-property-setget
- void **set_indent_using_spaces** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_indent_using_spaces** **(** **)**
使用空格代替制表符进行缩进。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_line_folding:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **line_folding** = ``false``
.. rst-class:: classref-property-setget
- void **set_line_folding_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_line_folding_enabled** **(** **)**
设置是否允许折叠行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_line_length_guidelines:
.. rst-class:: classref-property
:ref:`int[]<class_int>` **line_length_guidelines** = ``[]``
.. rst-class:: classref-property-setget
- void **set_line_length_guidelines** **(** :ref:`int[]<class_int>` value **)**
- :ref:`int[]<class_int>` **get_line_length_guidelines** **(** **)**
在提供的列上绘制垂直线。第一个条目被认为是主要的硬参考线，并且被绘制得更显眼。
.. 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``
.. rst-class:: classref-property-setget
- void **set_symbol_lookup_on_click_enabled** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_symbol_lookup_on_click_enabled** **(** **)**
设置当来自 :ref:`symbol_validate<class_CodeEdit_signal_symbol_validate>` 的验证词被点击时，应发出 :ref:`symbol_lookup<class_CodeEdit_signal_symbol_lookup>`\ 。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
方法说明
--------
.. _class_CodeEdit_private_method__confirm_code_completion:
.. rst-class:: classref-method
void **_confirm_code_completion** **(** :ref:`bool<class_bool>` replace **)** |virtual|
覆盖此方法以定义所选条目应如何插入。如果 ``replace`` 为真，任何现有的文本都应该被替换。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_private_method__filter_code_completion_candidates:
.. rst-class:: classref-method
:ref:`Dictionary[]<class_Dictionary>` **_filter_code_completion_candidates** **(** :ref:`Dictionary[]<class_Dictionary>` candidates **)** |virtual| |const|
覆盖此方法以确定应该显示 ``candidates`` 中的哪些项。
参数 ``candidates`` 和返回值都是一个 :ref:`Array<class_Array>` 的 :ref:`Dictionary<class_Dictionary>`\ ，而 :ref:`Dictionary<class_Dictionary>` 的键值，详见 :ref:`get_code_completion_option<class_CodeEdit_method_get_code_completion_option>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_private_method__request_code_completion:
.. rst-class:: classref-method
void **_request_code_completion** **(** :ref:`bool<class_bool>` force **)** |virtual|
覆盖此方法以定义当用户请求代码完成时发生的情况。如果 ``force`` 为真，会绕过任何检查。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_auto_brace_completion_pair:
.. rst-class:: classref-method
void **add_auto_brace_completion_pair** **(** :ref:`String<class_String>` start_key, :ref:`String<class_String>` end_key **)**
添加一对括号。
开始和结束键都必须是符号。只有开始键必须是唯一的。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_code_completion_option:
.. rst-class:: classref-method
void **add_code_completion_option** **(** :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` type, :ref:`String<class_String>` display_text, :ref:`String<class_String>` insert_text, :ref:`Color<class_Color>` text_color=Color(1, 1, 1, 1), :ref:`Resource<class_Resource>` icon=null, :ref:`Variant<class_Variant>` value=0, :ref:`int<class_int>` location=1024 **)**
向自动补全菜单的潜在候选队列提交条目。请调用 :ref:`update_code_completion_options<class_CodeEdit_method_update_code_completion_options>` 来更新列表。
\ ``location`` 指示的是该选项相对于代码补全请求位置的位置。这个值如何设置见 :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>`\ 。
\ **注意：**\ 这个列表将替换所有当前候选。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_comment_delimiter:
.. rst-class:: classref-method
void **add_comment_delimiter** **(** :ref:`String<class_String>` start_key, :ref:`String<class_String>` end_key, :ref:`bool<class_bool>` line_only=false **)**
添加注释分隔符。
开始键和结束键都必须是符号。只有开始键必须是唯一的。
\ ``line_only`` 表示该区域应该持续到该行的末尾，还是延续到下一行。如果结束键为空，则自动设置为\ ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_string_delimiter:
.. rst-class:: classref-method
void **add_string_delimiter** **(** :ref:`String<class_String>` start_key, :ref:`String<class_String>` end_key, :ref:`bool<class_bool>` line_only=false **)**
添加字符串分隔符。
开始键和结束键都必须是符号。只有开始键必须是唯一的。
\ ``line_only`` 表示该区域应该持续到该行的末尾，还是延续到下一行。如果结束键为空，则自动设置为\ ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_can_fold_line:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **can_fold_line** **(** :ref:`int<class_int>` line **)** |const|
返回给定的行是否可折叠，也就是说，它的正下方有缩进的行或注释 / 字符串块。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_cancel_code_completion:
.. rst-class:: classref-method
void **cancel_code_completion** **(** **)**
取消自动补全菜单。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_bookmarked_lines:
.. rst-class:: classref-method
void **clear_bookmarked_lines** **(** **)**
清除所有书签行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_breakpointed_lines:
.. rst-class:: classref-method
void **clear_breakpointed_lines** **(** **)**
清除所有断点行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_comment_delimiters:
.. rst-class:: classref-method
void **clear_comment_delimiters** **(** **)**
移除所有注释分隔符。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_executing_lines:
.. rst-class:: classref-method
void **clear_executing_lines** **(** **)**
清除所有已执行的行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_string_delimiters:
.. rst-class:: classref-method
void **clear_string_delimiters** **(** **)**
移除所有字符串分隔符。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_confirm_code_completion:
.. rst-class:: classref-method
void **confirm_code_completion** **(** :ref:`bool<class_bool>` replace=false **)**
将选定的条目插入到文本中。如果 ``replace`` 为真，任何现有的文本都会被替换，而不是被合并。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_convert_indent:
.. rst-class:: classref-method
void **convert_indent** **(** :ref:`int<class_int>` from_line=-1, :ref:`int<class_int>` to_line=-1 **)**
将 ``from_line`` 和 ``to_line`` 之间的行缩进，转换为 :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>` 设置的制表符或空格。
值均为 ``-1`` 将转换整个文本。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_create_code_region:
.. rst-class:: classref-method
void **create_code_region** **(** **)**
使用选区创建一个新的代码区块。必须至少定义一个单行注释分隔符（见 :ref:`add_comment_delimiter<class_CodeEdit_method_add_comment_delimiter>`\ ）。
代码区块是代码的一部分，它在折叠时会高亮显示，且可以帮助组织脚本。
代码区块的开始和结束标记可以被自定义（见 :ref:`set_code_region_tags<class_CodeEdit_method_set_code_region_tags>`\ ）。
代码区块使用开始和结束标记（默认情况下分别为 ``region`` 和 ``endregion``\ ）进行分隔，前面有一个行注释分隔符。（例如 ``#region`` 和 ``#endregion``\ ）
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_do_indent:
.. rst-class:: classref-method
void **do_indent** **(** **)**
执行一个缩进，就像用户触发了“ui_text_indent”动作一样。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_duplicate_lines:
.. rst-class:: classref-method
void **duplicate_lines** **(** **)**
复制当前使用任何文本光标选择的所有行。无论文本光标位于行内的哪个位置，复制当前行所在的整行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_fold_all_lines:
.. rst-class:: classref-method
void **fold_all_lines** **(** **)**
折叠所有可能被折叠的行（参见 :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** **(** :ref:`int<class_int>` line **)**
如果可能，折叠给定的行（参见 :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** **(** :ref:`String<class_String>` open_key **)** |const|
获取 ``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|
获取所有书签行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_breakpointed_lines:
.. rst-class:: classref-method
:ref:`PackedInt32Array<class_PackedInt32Array>` **get_breakpointed_lines** **(** **)** |const|
获取所有断点行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_code_completion_option:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_code_completion_option** **(** :ref:`int<class_int>` index **)** |const|
获取在 ``index`` 处的补全选项。返回的 :ref:`Dictionary<class_Dictionary>` 有以下键值。
\ ``kind``\ ：\ :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`\
\ ``display_text`` ：在自动补全菜单上显示的文本。
\ ``insert_text`` ：当选中这个选项时要插入的文本。
\ ``font_color``\ ：自动补全菜单上文本的颜色。
\ ``icon`` ：在自动补全菜单上绘制的图标。
\ ``default_value``\ ：符号的值。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_code_completion_options:
.. rst-class:: classref-method
:ref:`Dictionary[]<class_Dictionary>` **get_code_completion_options** **(** **)** |const|
获取所有补全选项，返回值见 :ref:`get_code_completion_option<class_CodeEdit_method_get_code_completion_option>`\ 。
.. 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|
获取当前已选定补全项的索引。
.. 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|
返回代码区块结束标签（不带注释分隔符）。
.. 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|
返回代码区块开始标签（不带注释分隔符）。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_delimiter_end_key:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_delimiter_end_key** **(** :ref:`int<class_int>` delimiter_index **)** |const|
获取字符串或注释块索引的结束键。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_delimiter_end_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_delimiter_end_position** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const|
如果 ``line`` ``column`` 是在一个字符串或注释中，则返回该区域的结束位置。如果不在或未找到结束位置，则 :ref:`Vector2<class_Vector2>` 的两个值都将是 ``-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** **(** :ref:`int<class_int>` delimiter_index **)** |const|
获取字符串或注释块索引的开始键。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_delimiter_start_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_delimiter_start_position** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const|
如果 ``line`` ``column`` 是在一个字符串或注释中，则返回该区域的起始位置。如果不在或未找到开始位置，则 :ref:`Vector2<class_Vector2>` 的两个值都将是 ``-1`` 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_executing_lines:
.. rst-class:: classref-method
:ref:`PackedInt32Array<class_PackedInt32Array>` **get_executing_lines** **(** **)** |const|
获取所有正在执行的行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_folded_lines:
.. rst-class:: classref-method
:ref:`int[]<class_int>` **get_folded_lines** **(** **)** |const|
返回当前折叠的所有行。
.. 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|
返回在文本光标位置带有 ``0xFFFF`` 字符的全文。
.. 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|
返回在鼠标光标处带有 ``0xFFFF`` 字符的全文。
.. 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** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column **)** |const|
返回在指定位置带有 ``0xFFFF`` 字符的全文。
.. 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** **(** :ref:`String<class_String>` close_key **)** |const|
如果关闭键 ``close_key`` 存在，则返回 ``true``\ 。
.. 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** **(** :ref:`String<class_String>` open_key **)** |const|
如果打开键 ``open_key`` 存在，则返回 ``true``\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_has_comment_delimiter:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_comment_delimiter** **(** :ref:`String<class_String>` start_key **)** |const|
如果注释的 ``start_key`` 存在，返回 ``true`` 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_has_string_delimiter:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_string_delimiter** **(** :ref:`String<class_String>` start_key **)** |const|
如果字符串的 ``start_key`` 存在，返回 ``true`` 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_indent_lines:
.. rst-class:: classref-method
void **indent_lines** **(** **)**
缩进选定的行，或者在没有选择的情况下，将光标行缩进一个。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_in_comment:
.. rst-class:: classref-method
:ref:`int<class_int>` **is_in_comment** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column=-1 **)** |const|
如果 ``line`` ``column`` 在一条注释中，则返回分隔符索引。如果没有提供 ``column``\ ，且整个 ``line`` 是一条注释，则将返回分隔符索引。否则返回 ``-1``\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_in_string:
.. rst-class:: classref-method
:ref:`int<class_int>` **is_in_string** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column=-1 **)** |const|
如果 ``line`` ``column`` 在一条字符串中，则返回分隔符索引。如果没有提供 ``column``\ ，且整个 ``line`` 是一个字符串，则将返回分隔符索引。否则返回 ``-1``\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_bookmarked:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_bookmarked** **(** :ref:`int<class_int>` line **)** |const|
返回指定索引处的行是否添加了书签。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_breakpointed:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_breakpointed** **(** :ref:`int<class_int>` line **)** |const|
返回指定索引处的行是否有断点。
.. 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** **(** :ref:`int<class_int>` line **)** |const|
返回指定索引处的行是否是代码区块末尾。
.. 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** **(** :ref:`int<class_int>` line **)** |const|
返回指定索引处的行是否是代码区块开始。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_executing:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_executing** **(** :ref:`int<class_int>` line **)** |const|
返回指定索引处的行是否标记为正在执行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_folded:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_folded** **(** :ref:`int<class_int>` line **)** |const|
返回指定索引处的行是否折叠。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_remove_comment_delimiter:
.. rst-class:: classref-method
void **remove_comment_delimiter** **(** :ref:`String<class_String>` start_key **)**
移除带有 ``start_key`` 的注释分隔符。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_remove_string_delimiter:
.. rst-class:: classref-method
void **remove_string_delimiter** **(** :ref:`String<class_String>` start_key **)**
移除带有 ``start_key`` 的字符串分隔符。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_request_code_completion:
.. rst-class:: classref-method
void **request_code_completion** **(** :ref:`bool<class_bool>` force=false **)**
发出 :ref:`code_completion_requested<class_CodeEdit_signal_code_completion_requested>`\ ，如果 ``force`` 为真将绕过所有检查。否则，将检查光标是否在一个词中或在一个前缀的前面。如果当前所有选项都是文件路径、节点路径或信号类型，将忽略该请求。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_completion_selected_index:
.. rst-class:: classref-method
void **set_code_completion_selected_index** **(** :ref:`int<class_int>` index **)**
设置当前选定的补全选项。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_hint:
.. rst-class:: classref-method
void **set_code_hint** **(** :ref:`String<class_String>` code_hint **)**
设置代码提示文本。传递一个空字符串来清除。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_hint_draw_below:
.. rst-class:: classref-method
void **set_code_hint_draw_below** **(** :ref:`bool<class_bool>` draw_below **)**
设置代码提示是否应绘制在文本下方。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_region_tags:
.. rst-class:: classref-method
void **set_code_region_tags** **(** :ref:`String<class_String>` start="region", :ref:`String<class_String>` end="endregion" **)**
设置代码区块的开始和结束标签（不含注释分隔符）。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_line_as_bookmarked:
.. rst-class:: classref-method
void **set_line_as_bookmarked** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` bookmarked **)**
将该行设置为书签。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_line_as_breakpoint:
.. rst-class:: classref-method
void **set_line_as_breakpoint** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` breakpointed **)**
将该行设置为断点。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_line_as_executing:
.. rst-class:: classref-method
void **set_line_as_executing** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` 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** **(** :ref:`bool<class_bool>` valid **)**
将 :ref:`symbol_validate<class_CodeEdit_signal_symbol_validate>` 发出的符号设置为有效查找。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_toggle_foldable_line:
.. rst-class:: classref-method
void **toggle_foldable_line** **(** :ref:`int<class_int>` line **)**
在给定行切换代码块的折叠。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_unfold_all_lines:
.. rst-class:: classref-method
void **unfold_all_lines** **(** **)**
展开所有行，无论是否被折叠。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_unfold_line:
.. rst-class:: classref-method
void **unfold_line** **(** :ref:`int<class_int>` line **)**
展开之前被折叠的所有行。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_unindent_lines:
.. rst-class:: classref-method
void **unindent_lines** **(** **)**
解除所选行的缩进，或者在没有选择的情况下，将光标行缩进一个。与触发“ui_text_unindent ”动作相同。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_update_code_completion_options:
.. rst-class:: classref-method
void **update_code_completion_options** **(** :ref:`bool<class_bool>` force **)**
提交所有用 :ref:`add_code_completion_option<class_CodeEdit_method_add_code_completion_option>` 添加的补全选项。如果 ``force`` 是 ``true``\ ，将尝试强制弹出自动补全菜单 。
\ **注意：**\ 这将取代所有当前的候补选项。
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
主题属性说明
------------
.. _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:`Color<class_Color>`\ ，用于标记了书签的行。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ 。
.. 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:`Color<class_Color>`\ ，次要参考线将应用 50% 的 Alpha。
.. 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:`Color<class_Color>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_constant_completion_lines:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **completion_lines** = ``7``
同时在代码补全弹出窗口中显示的最大选项数。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_constant_completion_max_width:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **completion_max_width** = ``50``
代码补全弹出窗口中选项的最大宽度。超过此长度的选项将被截断。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_constant_completion_scroll_width:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **completion_scroll_width** = ``6``
代码补全弹出窗口中滚动条的宽度。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_bookmark:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **bookmark**
设置书签行的自定义 :ref:`Texture2D<class_Texture2D>`\ ，会在书签栏中绘制。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_breakpoint:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **breakpoint**
设置断点行的自定义 :ref:`Texture2D<class_Texture2D>`\ ，会在断点栏中绘制。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_can_fold:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **can_fold**
设置可折叠行的自定义 :ref:`Texture2D<class_Texture2D>`\ ，会在折叠行栏中绘制。
.. 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:`Texture2D<class_Texture2D>`\ ，以在代码区块可以折叠时在行折叠栏中绘制。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_executing_line:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **executing_line**
执行行的图标，会在执行栏中绘制。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_folded:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folded**
设置一个自定义 :ref:`Texture2D<class_Texture2D>`\ ，以在行被折叠且可以展开时，在行折叠边栏中绘制。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_folded_code_region:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folded_code_region**
设置一个自定义 :ref:`Texture2D<class_Texture2D>`\ ，以在代码区块被折叠且可以展开时，在行折叠边栏中绘制。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_folded_eol_icon:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folded_eol_icon**
设置要绘制在折叠行末尾的一个自定义 :ref:`Texture2D<class_Texture2D>`\ 。
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_style_completion:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **completion**
用于代码补全弹窗的 :ref:`StyleBox<class_StyleBox>`\ 。
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
.. |const| replace:: :abbr:`const (本方法没有副作用。不会修改该实例的任何成员变量。)`
.. |vararg| replace:: :abbr:`vararg (本方法除了在此处描述的参数外，还能够继续接受任意数量的参数。)`
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
.. |static| replace:: :abbr:`static (调用本方法无需实例，所以可以直接使用类名调用。)`
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效操作符。)`
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列标志构成的位掩码整数。)`
Reference in New Issue View Git Blame Copy Permalink