mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
classref: Sync with latest 4.0-alpha
This commit is contained in:
Rémi Verschelde
@@ -18,56 +18,56 @@ Description
|
||||
|
||||
CodeEdit is a specialised :ref:`TextEdit<class_TextEdit>` designed for editing plain text code files. It contains a bunch of features commonly found in code editors such as line numbers, line folding, code completion, indent management and string / comment management.
|
||||
|
||||
**Note:** By default ``CodeEdit`` always use left-to-right text direction to correctly display source code.
|
||||
\ **Note:** By default ``CodeEdit`` always use left-to-right text direction to correctly display source code.
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|
||||
| :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`` *(parent override)* |
|
||||
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|
||||
| :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`` *(parent override)* |
|
||||
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
|
||||
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
||||
| :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>`) |
|
||||
+------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
|
||||
|
||||
Methods
|
||||
-------
|
||||
@@ -195,93 +195,95 @@ Methods
|
||||
Theme Properties
|
||||
----------------
|
||||
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`background_color<class_CodeEdit_theme_color_background_color>` | ``Color(0, 0, 0, 0)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`bookmark<class_CodeEdit_theme_icon_bookmark>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :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:`Texture2D<class_Texture2D>` | :ref:`breakpoint<class_CodeEdit_theme_icon_breakpoint>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`breakpoint_color<class_CodeEdit_theme_color_breakpoint_color>` | ``Color(0.9, 0.29, 0.3, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`can_fold<class_CodeEdit_theme_icon_can_fold>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`caret_background_color<class_CodeEdit_theme_color_caret_background_color>` | ``Color(0, 0, 0, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`caret_color<class_CodeEdit_theme_color_caret_color>` | ``Color(0.88, 0.88, 0.88, 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:`StyleBox<class_StyleBox>` | :ref:`completion<class_CodeEdit_theme_style_completion>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :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_font_color<class_CodeEdit_theme_color_completion_font_color>` | ``Color(0.67, 0.67, 0.67, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :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:`Color<class_Color>` | :ref:`completion_scroll_color<class_CodeEdit_theme_color_completion_scroll_color>` | ``Color(1, 1, 1, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`completion_scroll_width<class_CodeEdit_theme_constant_completion_scroll_width>` | ``3`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :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:`current_line_color<class_CodeEdit_theme_color_current_line_color>` | ``Color(0.25, 0.25, 0.26, 0.8)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`executing_line<class_CodeEdit_theme_icon_executing_line>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`executing_line_color<class_CodeEdit_theme_color_executing_line_color>` | ``Color(0.98, 0.89, 0.27, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CodeEdit_theme_style_focus>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`folded<class_CodeEdit_theme_icon_folded>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`folded_eol_icon<class_CodeEdit_theme_icon_folded_eol_icon>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`font<class_CodeEdit_theme_font_font>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_color<class_CodeEdit_theme_color_font_color>` | ``Color(0.88, 0.88, 0.88, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_CodeEdit_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_readonly_color<class_CodeEdit_theme_color_font_readonly_color>` | ``Color(0.88, 0.88, 0.88, 0.5)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_selected_color<class_CodeEdit_theme_color_font_selected_color>` | ``Color(0, 0, 0, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`font_size<class_CodeEdit_theme_font_size_font_size>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :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:`line_spacing<class_CodeEdit_theme_constant_line_spacing>` | ``4`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CodeEdit_theme_style_normal>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`outline_size<class_CodeEdit_theme_constant_outline_size>` | ``0`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`read_only<class_CodeEdit_theme_style_read_only>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`search_result_border_color<class_CodeEdit_theme_color_search_result_border_color>` | ``Color(0.3, 0.3, 0.3, 0.4)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`search_result_color<class_CodeEdit_theme_color_search_result_color>` | ``Color(0.3, 0.3, 0.3, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`selection_color<class_CodeEdit_theme_color_selection_color>` | ``Color(0.49, 0.49, 0.49, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`space<class_CodeEdit_theme_icon_space>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`tab<class_CodeEdit_theme_icon_tab>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`word_highlighted_color<class_CodeEdit_theme_color_word_highlighted_color>` | ``Color(0.8, 0.9, 0.9, 0.15)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------+
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`background_color<class_CodeEdit_theme_color_background_color>` | ``Color(0, 0, 0, 0)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :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:`caret_background_color<class_CodeEdit_theme_color_caret_background_color>` | ``Color(0, 0, 0, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`caret_color<class_CodeEdit_theme_color_caret_color>` | ``Color(0.875, 0.875, 0.875, 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_font_color<class_CodeEdit_theme_color_completion_font_color>` | ``Color(0.67, 0.67, 0.67, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`completion_scroll_color<class_CodeEdit_theme_color_completion_scroll_color>` | ``Color(1, 1, 1, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :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:`current_line_color<class_CodeEdit_theme_color_current_line_color>` | ``Color(0.25, 0.25, 0.26, 0.8)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :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:`font_color<class_CodeEdit_theme_color_font_color>` | ``Color(0.875, 0.875, 0.875, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_outline_color<class_CodeEdit_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_placeholder_color<class_CodeEdit_theme_color_font_placeholder_color>` | ``Color(0.875, 0.875, 0.875, 0.6)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_readonly_color<class_CodeEdit_theme_color_font_readonly_color>` | ``Color(0.875, 0.875, 0.875, 0.5)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`font_selected_color<class_CodeEdit_theme_color_font_selected_color>` | ``Color(0, 0, 0, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :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:`Color<class_Color>` | :ref:`search_result_border_color<class_CodeEdit_theme_color_search_result_border_color>` | ``Color(0.3, 0.3, 0.3, 0.4)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`search_result_color<class_CodeEdit_theme_color_search_result_color>` | ``Color(0.3, 0.3, 0.3, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`selection_color<class_CodeEdit_theme_color_selection_color>` | ``Color(0.5, 0.5, 0.5, 1)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Color<class_Color>` | :ref:`word_highlighted_color<class_CodeEdit_theme_color_word_highlighted_color>` | ``Color(0.8, 0.9, 0.9, 0.15)`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :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>` | ``3`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`line_spacing<class_CodeEdit_theme_constant_line_spacing>` | ``4`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`outline_size<class_CodeEdit_theme_constant_outline_size>` | ``0`` |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Font<class_Font>` | :ref:`font<class_CodeEdit_theme_font_font>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`int<class_int>` | :ref:`font_size<class_CodeEdit_theme_font_size_font_size>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :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:`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_eol_icon<class_CodeEdit_theme_icon_folded_eol_icon>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`space<class_CodeEdit_theme_icon_space>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`Texture2D<class_Texture2D>` | :ref:`tab<class_CodeEdit_theme_icon_tab>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`completion<class_CodeEdit_theme_style_completion>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`focus<class_CodeEdit_theme_style_focus>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_CodeEdit_theme_style_normal>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
| :ref:`StyleBox<class_StyleBox>` | :ref:`read_only<class_CodeEdit_theme_style_read_only>` | |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------+-------------------------------------+
|
||||
|
||||
Signals
|
||||
-------
|
||||
@@ -294,9 +296,9 @@ Emitted when a breakpoint is added or removed from a line. If the line is moved
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_signal_request_code_completion:
|
||||
.. _class_CodeEdit_signal_code_completion_requested:
|
||||
|
||||
- **request_code_completion** **(** **)**
|
||||
- **code_completion_requested** **(** **)**
|
||||
|
||||
Emitted when the user requests code completion.
|
||||
|
||||
@@ -402,13 +404,13 @@ Highlight mismatching brace pairs.
|
||||
|
||||
- :ref:`Dictionary<class_Dictionary>` **auto_brace_completion_pairs**
|
||||
|
||||
+-----------+------------------------------------------------------+
|
||||
| *Default* | ``{"\"": "\"","'": "'","(": ")","[": "]","{": "}"}`` |
|
||||
+-----------+------------------------------------------------------+
|
||||
| *Setter* | set_auto_brace_completion_pairs(value) |
|
||||
+-----------+------------------------------------------------------+
|
||||
| *Getter* | get_auto_brace_completion_pairs() |
|
||||
+-----------+------------------------------------------------------+
|
||||
+-----------+------------------------------------------------------------+
|
||||
| *Default* | ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` |
|
||||
+-----------+------------------------------------------------------------+
|
||||
| *Setter* | set_auto_brace_completion_pairs(value) |
|
||||
+-----------+------------------------------------------------------------+
|
||||
| *Getter* | get_auto_brace_completion_pairs() |
|
||||
+-----------+------------------------------------------------------------+
|
||||
|
||||
Sets the brace pairs to be autocompleted.
|
||||
|
||||
@@ -729,7 +731,7 @@ Both the start and end keys must be symbols. Only the start key has to be unique
|
||||
|
||||
Submits an item to the queue of potential candidates for the autocomplete menu. Call :ref:`update_code_completion_options<class_CodeEdit_method_update_code_completion_options>` to update the list.
|
||||
|
||||
**Note:** This list will replace all current candidates.
|
||||
\ **Note:** This list will replace all current candidates.
|
||||
|
||||
----
|
||||
|
||||
@@ -883,17 +885,17 @@ Gets all breakpointed lines.
|
||||
|
||||
Gets the completion option at ``index``. The return :ref:`Dictionary<class_Dictionary>` has the following key-values:
|
||||
|
||||
``kind``: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`
|
||||
\ ``kind``: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`\
|
||||
|
||||
``display_text``: Text that is shown on the autocomplete menu.
|
||||
\ ``display_text``: Text that is shown on the autocomplete menu.
|
||||
|
||||
``insert_text``: Text that is to be inserted when this item is selected.
|
||||
\ ``insert_text``: Text that is to be inserted when this item is selected.
|
||||
|
||||
``font_color``: Color of the text on the autocomplete menu.
|
||||
\ ``font_color``: Color of the text on the autocomplete menu.
|
||||
|
||||
``icon``: Icon to draw on the autocomplete menu.
|
||||
\ ``icon``: Icon to draw on the autocomplete menu.
|
||||
|
||||
``default_value``: Value of the symbol.
|
||||
\ ``default_value``: Value of the symbol.
|
||||
|
||||
----
|
||||
|
||||
@@ -957,7 +959,7 @@ Gets all executing lines.
|
||||
|
||||
- :ref:`int[]<class_int>` **get_folded_lines** **(** **)** |const|
|
||||
|
||||
Return all lines that are current folded.
|
||||
Returns all lines that are current folded.
|
||||
|
||||
----
|
||||
|
||||
@@ -1021,7 +1023,7 @@ Indents selected lines, or in the case of no selection the caret line by one.
|
||||
|
||||
- :ref:`int<class_int>` **is_in_comment** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column=-1 **)** |const|
|
||||
|
||||
Return delimiter index if ``line`` ``column`` is in a comment. If ``column`` is not provided, will return delimiter index if the entire ``line`` is a comment. Otherwise ``-1``.
|
||||
Returns delimiter index if ``line`` ``column`` is in a comment. If ``column`` is not provided, will return delimiter index if the entire ``line`` is a comment. Otherwise ``-1``.
|
||||
|
||||
----
|
||||
|
||||
@@ -1029,7 +1031,7 @@ Return delimiter index if ``line`` ``column`` is in a comment. If ``column`` is
|
||||
|
||||
- :ref:`int<class_int>` **is_in_string** **(** :ref:`int<class_int>` line, :ref:`int<class_int>` column=-1 **)** |const|
|
||||
|
||||
Return the delimiter index if ``line`` ``column`` is in a string. If ``column`` is not provided, will return the delimiter index if the entire ``line`` is a string. Otherwise ``-1``.
|
||||
Returns the delimiter index if ``line`` ``column`` is in a string. If ``column`` is not provided, will return the delimiter index if the entire ``line`` is a string. Otherwise ``-1``.
|
||||
|
||||
----
|
||||
|
||||
@@ -1085,7 +1087,7 @@ Removes the string delimiter with ``start_key``.
|
||||
|
||||
- void **request_code_completion** **(** :ref:`bool<class_bool>` force=false **)**
|
||||
|
||||
Emits :ref:`request_code_completion<class_CodeEdit_signal_request_code_completion>`, if ``force`` is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal.
|
||||
Emits :ref:`code_completion_requested<class_CodeEdit_signal_code_completion_requested>`, if ``force`` is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal.
|
||||
|
||||
----
|
||||
|
||||
@@ -1183,7 +1185,7 @@ Unindents selected lines, or in the case of no selection the caret line by one.
|
||||
|
||||
Submits all completion options added with :ref:`add_code_completion_option<class_CodeEdit_method_add_code_completion_option>`. Will try to force the autoccomplete menu to popup, if ``force`` is ``true``.
|
||||
|
||||
**Note:** This will replace all current candidates.
|
||||
\ **Note:** This will replace all current candidates.
|
||||
|
||||
Theme Property Descriptions
|
||||
---------------------------
|
||||
@@ -1200,14 +1202,6 @@ Sets the background :ref:`Color<class_Color>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_bookmark:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **bookmark**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the bookmark gutter for bookmarked lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_bookmark_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **bookmark_color**
|
||||
@@ -1232,14 +1226,6 @@ Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the bookmark gutter f
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_breakpoint:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **breakpoint**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the breakpoint gutter for breakpointed lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_breakpoint_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **breakpoint_color**
|
||||
@@ -1252,14 +1238,6 @@ Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the breakpoint gutter
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_can_fold:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **can_fold**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line can be folded.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_caret_background_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **caret_background_color**
|
||||
@@ -1276,9 +1254,9 @@ Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutt
|
||||
|
||||
- :ref:`Color<class_Color>` **caret_color**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | ``Color(0.88, 0.88, 0.88, 1)`` |
|
||||
+-----------+--------------------------------+
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | ``Color(0.875, 0.875, 0.875, 1)`` |
|
||||
+-----------+-----------------------------------+
|
||||
|
||||
:ref:`Color<class_Color>` of the caret.
|
||||
|
||||
@@ -1296,14 +1274,6 @@ Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutt
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_style_completion:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **completion**
|
||||
|
||||
:ref:`StyleBox<class_StyleBox>` for the code completion popup.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_completion_background_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **completion_background_color**
|
||||
@@ -1340,30 +1310,6 @@ Font :ref:`Color<class_Color>` for the code completion popup.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_completion_lines:
|
||||
|
||||
- :ref:`int<class_int>` **completion_lines**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``7`` |
|
||||
+-----------+-------+
|
||||
|
||||
Max number of options to display in the code completion popup at any one time.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_completion_max_width:
|
||||
|
||||
- :ref:`int<class_int>` **completion_max_width**
|
||||
|
||||
+-----------+--------+
|
||||
| *Default* | ``50`` |
|
||||
+-----------+--------+
|
||||
|
||||
Max width of options in the code completion popup. Options longer then this will be cut off.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_completion_scroll_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **completion_scroll_color**
|
||||
@@ -1376,18 +1322,6 @@ Max width of options in the code completion popup. Options longer then this will
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_completion_scroll_width:
|
||||
|
||||
- :ref:`int<class_int>` **completion_scroll_width**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``3`` |
|
||||
+-----------+-------+
|
||||
|
||||
Width of the scrollbar in the code completion popup.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_completion_selected_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **completion_selected_color**
|
||||
@@ -1412,14 +1346,6 @@ Background :ref:`Color<class_Color>` of the line containing the caret.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_executing_line:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **executing_line**
|
||||
|
||||
Icon to draw in the executing gutter for executing lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_executing_line_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **executing_line_color**
|
||||
@@ -1432,45 +1358,13 @@ Icon to draw in the executing gutter for executing lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_style_focus:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **focus**
|
||||
|
||||
Sets the :ref:`StyleBox<class_StyleBox>` when in focus.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_folded:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **folded**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line is folded and can be unfolded.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_folded_eol_icon:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **folded_eol_icon**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw at the end of a folded line.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_font_font:
|
||||
|
||||
- :ref:`Font<class_Font>` **font**
|
||||
|
||||
Sets the default :ref:`Font<class_Font>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_font_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_color**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | ``Color(0.88, 0.88, 0.88, 1)`` |
|
||||
+-----------+--------------------------------+
|
||||
+-----------+-----------------------------------+
|
||||
| *Default* | ``Color(0.875, 0.875, 0.875, 1)`` |
|
||||
+-----------+-----------------------------------+
|
||||
|
||||
Sets the font :ref:`Color<class_Color>`.
|
||||
|
||||
@@ -1488,13 +1382,25 @@ The tint of text outline of the ``CodeEdit``.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_font_placeholder_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_placeholder_color**
|
||||
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | ``Color(0.875, 0.875, 0.875, 0.6)`` |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
Font color for :ref:`TextEdit.placeholder_text<class_TextEdit_property_placeholder_text>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_font_readonly_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **font_readonly_color**
|
||||
|
||||
+-----------+----------------------------------+
|
||||
| *Default* | ``Color(0.88, 0.88, 0.88, 0.5)`` |
|
||||
+-----------+----------------------------------+
|
||||
+-----------+-------------------------------------+
|
||||
| *Default* | ``Color(0.875, 0.875, 0.875, 0.5)`` |
|
||||
+-----------+-------------------------------------+
|
||||
|
||||
Sets the font :ref:`Color<class_Color>` when :ref:`TextEdit.editable<class_TextEdit_property_editable>` is disabled.
|
||||
|
||||
@@ -1512,14 +1418,6 @@ Sets the :ref:`Color<class_Color>` of the selected text. :ref:`TextEdit.override
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_font_size_font_size:
|
||||
|
||||
- :ref:`int<class_int>` **font_size**
|
||||
|
||||
Sets default font size.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_line_length_guideline_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **line_length_guideline_color**
|
||||
@@ -1544,46 +1442,6 @@ Sets the :ref:`Color<class_Color>` of line numbers.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_line_spacing:
|
||||
|
||||
- :ref:`int<class_int>` **line_spacing**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``4`` |
|
||||
+-----------+-------+
|
||||
|
||||
Sets the spacing between the lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_style_normal:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **normal**
|
||||
|
||||
Sets the :ref:`StyleBox<class_StyleBox>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_outline_size:
|
||||
|
||||
- :ref:`int<class_int>` **outline_size**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
The size of the text outline.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_style_read_only:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **read_only**
|
||||
|
||||
Sets the :ref:`StyleBox<class_StyleBox>` when :ref:`TextEdit.editable<class_TextEdit_property_editable>` is disabled.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_search_result_border_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **search_result_border_color**
|
||||
@@ -1612,14 +1470,150 @@ Sets the :ref:`StyleBox<class_StyleBox>` when :ref:`TextEdit.editable<class_Text
|
||||
|
||||
- :ref:`Color<class_Color>` **selection_color**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | ``Color(0.49, 0.49, 0.49, 1)`` |
|
||||
+-----------+--------------------------------+
|
||||
+-----------+-----------------------------+
|
||||
| *Default* | ``Color(0.5, 0.5, 0.5, 1)`` |
|
||||
+-----------+-----------------------------+
|
||||
|
||||
Sets the highlight :ref:`Color<class_Color>` of text selections.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_word_highlighted_color:
|
||||
|
||||
- :ref:`Color<class_Color>` **word_highlighted_color**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | ``Color(0.8, 0.9, 0.9, 0.15)`` |
|
||||
+-----------+--------------------------------+
|
||||
|
||||
Sets the highlight :ref:`Color<class_Color>` of multiple occurrences. :ref:`TextEdit.highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>` has to be enabled.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_completion_lines:
|
||||
|
||||
- :ref:`int<class_int>` **completion_lines**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``7`` |
|
||||
+-----------+-------+
|
||||
|
||||
Max number of options to display in the code completion popup at any one time.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_completion_max_width:
|
||||
|
||||
- :ref:`int<class_int>` **completion_max_width**
|
||||
|
||||
+-----------+--------+
|
||||
| *Default* | ``50`` |
|
||||
+-----------+--------+
|
||||
|
||||
Max width of options in the code completion popup. Options longer then this will be cut off.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_completion_scroll_width:
|
||||
|
||||
- :ref:`int<class_int>` **completion_scroll_width**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``3`` |
|
||||
+-----------+-------+
|
||||
|
||||
Width of the scrollbar in the code completion popup.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_line_spacing:
|
||||
|
||||
- :ref:`int<class_int>` **line_spacing**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``4`` |
|
||||
+-----------+-------+
|
||||
|
||||
Sets the spacing between the lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_constant_outline_size:
|
||||
|
||||
- :ref:`int<class_int>` **outline_size**
|
||||
|
||||
+-----------+-------+
|
||||
| *Default* | ``0`` |
|
||||
+-----------+-------+
|
||||
|
||||
The size of the text outline.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_font_font:
|
||||
|
||||
- :ref:`Font<class_Font>` **font**
|
||||
|
||||
Sets the default :ref:`Font<class_Font>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_font_size_font_size:
|
||||
|
||||
- :ref:`int<class_int>` **font_size**
|
||||
|
||||
Sets default font size.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_bookmark:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **bookmark**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the bookmark gutter for bookmarked lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_breakpoint:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **breakpoint**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the breakpoint gutter for breakpointed lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_can_fold:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **can_fold**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line can be folded.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_executing_line:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **executing_line**
|
||||
|
||||
Icon to draw in the executing gutter for executing lines.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_folded:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **folded**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line is folded and can be unfolded.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_folded_eol_icon:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **folded_eol_icon**
|
||||
|
||||
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw at the end of a folded line.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_icon_space:
|
||||
|
||||
- :ref:`Texture2D<class_Texture2D>` **space**
|
||||
@@ -1636,15 +1630,35 @@ Sets a custom :ref:`Texture2D<class_Texture2D>` for tab text characters.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_color_word_highlighted_color:
|
||||
.. _class_CodeEdit_theme_style_completion:
|
||||
|
||||
- :ref:`Color<class_Color>` **word_highlighted_color**
|
||||
- :ref:`StyleBox<class_StyleBox>` **completion**
|
||||
|
||||
+-----------+--------------------------------+
|
||||
| *Default* | ``Color(0.8, 0.9, 0.9, 0.15)`` |
|
||||
+-----------+--------------------------------+
|
||||
:ref:`StyleBox<class_StyleBox>` for the code completion popup.
|
||||
|
||||
Sets the highlight :ref:`Color<class_Color>` of multiple occurrences. :ref:`TextEdit.highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>` has to be enabled.
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_style_focus:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **focus**
|
||||
|
||||
Sets the :ref:`StyleBox<class_StyleBox>` when in focus. The ``focus`` :ref:`StyleBox<class_StyleBox>` is displayed *over* the base :ref:`StyleBox<class_StyleBox>`, so a partially transparent :ref:`StyleBox<class_StyleBox>` should be used to ensure the base :ref:`StyleBox<class_StyleBox>` remains visible. A :ref:`StyleBox<class_StyleBox>` that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a :ref:`StyleBoxEmpty<class_StyleBoxEmpty>` resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_style_normal:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **normal**
|
||||
|
||||
Sets the :ref:`StyleBox<class_StyleBox>`.
|
||||
|
||||
----
|
||||
|
||||
.. _class_CodeEdit_theme_style_read_only:
|
||||
|
||||
- :ref:`StyleBox<class_StyleBox>` **read_only**
|
||||
|
||||
Sets the :ref:`StyleBox<class_StyleBox>` when :ref:`TextEdit.editable<class_TextEdit_property_editable>` is disabled.
|
||||
|
||||
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
||||
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
||||
|
||||
Reference in New Issue
Block a user