Files
godot-docs-l10n/classes/fr/class_codeedit.rst
Rémi Verschelde c3f2364c10 Sync classref with 4.6 branch
Lots of translations invalidated (fuzzied) as we just synced Weblate.
2025-12-19 16:39:51 +01:00

2109 lines
159 KiB
ReStructuredText
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

:github_url: hide
.. _class_CodeEdit:
CodeEdit
========
**Hérite de:** :ref:`TextEdit<class_TextEdit>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
Un éditeur de texte multi-ligne conçu pour l'édition de code.
.. rst-class:: classref-introduction-group
Description
-----------
CodeEdit est un :ref:`TextEdit<class_TextEdit>` spécialisé, conçu pour l'édition de fichiers de code bruts. Il a de nombreuses fonctionnalités communément trouvées dans les éditeurs de code tels que les numéros de ligne, le repliage de ligne, la complétion du code, la gestion de l'indentation et la gestion des chaînes/commentaires.
\ **Note :** Peu importe la langue, **CodeEdit** utilisera par défaut toujours une direction du texte de gauche à droite pour afficher correctement le code source.
.. rst-class:: classref-reftable-group
Propriétés
--------------------
.. table::
:widths: auto
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`auto_brace_completion_enabled<class_CodeEdit_property_auto_brace_completion_enabled>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`auto_brace_completion_highlight_matching<class_CodeEdit_property_auto_brace_completion_highlight_matching>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>` | ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`code_completion_enabled<class_CodeEdit_property_code_completion_enabled>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`code_completion_prefixes<class_CodeEdit_property_code_completion_prefixes>` | ``[]`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`delimiter_comments<class_CodeEdit_property_delimiter_comments>` | ``[]`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`delimiter_strings<class_CodeEdit_property_delimiter_strings>` | ``["' '", "\" \""]`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gutters_draw_bookmarks<class_CodeEdit_property_gutters_draw_bookmarks>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gutters_draw_breakpoints_gutter<class_CodeEdit_property_gutters_draw_breakpoints_gutter>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gutters_draw_executing_lines<class_CodeEdit_property_gutters_draw_executing_lines>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gutters_draw_fold_gutter<class_CodeEdit_property_gutters_draw_fold_gutter>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gutters_draw_line_numbers<class_CodeEdit_property_gutters_draw_line_numbers>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`gutters_line_numbers_min_digits<class_CodeEdit_property_gutters_line_numbers_min_digits>` | ``3`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`gutters_zero_pad_line_numbers<class_CodeEdit_property_gutters_zero_pad_line_numbers>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`indent_automatic<class_CodeEdit_property_indent_automatic>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`indent_automatic_prefixes<class_CodeEdit_property_indent_automatic_prefixes>` | ``[":", "{", "[", "("]`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`indent_size<class_CodeEdit_property_indent_size>` | ``4`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`LayoutDirection<enum_Control_LayoutDirection>` | layout_direction | ``2`` (overrides :ref:`Control<class_Control_property_layout_direction>`) |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`line_folding<class_CodeEdit_property_line_folding>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] | :ref:`line_length_guidelines<class_CodeEdit_property_line_length_guidelines>` | ``[]`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`symbol_lookup_on_click<class_CodeEdit_property_symbol_lookup_on_click>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`symbol_tooltip_on_hover<class_CodeEdit_property_symbol_tooltip_on_hover>` | ``false`` |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
| :ref:`TextDirection<enum_Control_TextDirection>` | text_direction | ``1`` (overrides :ref:`TextEdit<class_TextEdit_property_text_direction>`) |
+----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Méthodes
----------------
.. table::
:widths: auto
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_confirm_code_completion<class_CodeEdit_private_method__confirm_code_completion>`\ (\ replace\: :ref:`bool<class_bool>`\ ) |virtual| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`_filter_code_completion_candidates<class_CodeEdit_private_method__filter_code_completion_candidates>`\ (\ candidates\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) |virtual| |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`_request_code_completion<class_CodeEdit_private_method__request_code_completion>`\ (\ force\: :ref:`bool<class_bool>`\ ) |virtual| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_auto_brace_completion_pair<class_CodeEdit_method_add_auto_brace_completion_pair>`\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_code_completion_option<class_CodeEdit_method_add_code_completion_option>`\ (\ type\: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`, display_text\: :ref:`String<class_String>`, insert_text\: :ref:`String<class_String>`, text_color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), icon\: :ref:`Resource<class_Resource>` = null, value\: :ref:`Variant<class_Variant>` = null, location\: :ref:`int<class_int>` = 1024\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_comment_delimiter<class_CodeEdit_method_add_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`add_string_delimiter<class_CodeEdit_method_add_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`can_fold_line<class_CodeEdit_method_can_fold_line>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`cancel_code_completion<class_CodeEdit_method_cancel_code_completion>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_bookmarked_lines<class_CodeEdit_method_clear_bookmarked_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_breakpointed_lines<class_CodeEdit_method_clear_breakpointed_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_comment_delimiters<class_CodeEdit_method_clear_comment_delimiters>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_executing_lines<class_CodeEdit_method_clear_executing_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`clear_string_delimiters<class_CodeEdit_method_clear_string_delimiters>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`confirm_code_completion<class_CodeEdit_method_confirm_code_completion>`\ (\ replace\: :ref:`bool<class_bool>` = false\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`convert_indent<class_CodeEdit_method_convert_indent>`\ (\ from_line\: :ref:`int<class_int>` = -1, to_line\: :ref:`int<class_int>` = -1\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`create_code_region<class_CodeEdit_method_create_code_region>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`delete_lines<class_CodeEdit_method_delete_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`do_indent<class_CodeEdit_method_do_indent>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`duplicate_lines<class_CodeEdit_method_duplicate_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`duplicate_selection<class_CodeEdit_method_duplicate_selection>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`fold_all_lines<class_CodeEdit_method_fold_all_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`fold_line<class_CodeEdit_method_fold_line>`\ (\ line\: :ref:`int<class_int>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_auto_brace_completion_close_key<class_CodeEdit_method_get_auto_brace_completion_close_key>`\ (\ open_key\: :ref:`String<class_String>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_bookmarked_lines<class_CodeEdit_method_get_bookmarked_lines>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_breakpointed_lines<class_CodeEdit_method_get_breakpointed_lines>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Dictionary<class_Dictionary>` | :ref:`get_code_completion_option<class_CodeEdit_method_get_code_completion_option>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`get_code_completion_options<class_CodeEdit_method_get_code_completion_options>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_code_completion_selected_index<class_CodeEdit_method_get_code_completion_selected_index>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_code_region_end_tag<class_CodeEdit_method_get_code_region_end_tag>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_code_region_start_tag<class_CodeEdit_method_get_code_region_start_tag>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_delimiter_end_key<class_CodeEdit_method_get_delimiter_end_key>`\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_delimiter_end_position<class_CodeEdit_method_get_delimiter_end_position>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_delimiter_start_key<class_CodeEdit_method_get_delimiter_start_key>`\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`get_delimiter_start_position<class_CodeEdit_method_get_delimiter_start_position>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_executing_lines<class_CodeEdit_method_get_executing_lines>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] | :ref:`get_folded_lines<class_CodeEdit_method_get_folded_lines>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_text_for_code_completion<class_CodeEdit_method_get_text_for_code_completion>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_text_for_symbol_lookup<class_CodeEdit_method_get_text_for_symbol_lookup>`\ (\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_text_with_cursor_char<class_CodeEdit_method_get_text_with_cursor_char>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_auto_brace_completion_close_key<class_CodeEdit_method_has_auto_brace_completion_close_key>`\ (\ close_key\: :ref:`String<class_String>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_auto_brace_completion_open_key<class_CodeEdit_method_has_auto_brace_completion_open_key>`\ (\ open_key\: :ref:`String<class_String>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_comment_delimiter<class_CodeEdit_method_has_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_string_delimiter<class_CodeEdit_method_has_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`indent_lines<class_CodeEdit_method_indent_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_in_comment<class_CodeEdit_method_is_in_comment>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`is_in_string<class_CodeEdit_method_is_in_string>`\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_bookmarked<class_CodeEdit_method_is_line_bookmarked>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_breakpointed<class_CodeEdit_method_is_line_breakpointed>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_code_region_end<class_CodeEdit_method_is_line_code_region_end>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_code_region_start<class_CodeEdit_method_is_line_code_region_start>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_executing<class_CodeEdit_method_is_line_executing>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_line_folded<class_CodeEdit_method_is_line_folded>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`move_lines_down<class_CodeEdit_method_move_lines_down>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`move_lines_up<class_CodeEdit_method_move_lines_up>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_comment_delimiter<class_CodeEdit_method_remove_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`remove_string_delimiter<class_CodeEdit_method_remove_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`request_code_completion<class_CodeEdit_method_request_code_completion>`\ (\ force\: :ref:`bool<class_bool>` = false\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_code_completion_selected_index<class_CodeEdit_method_set_code_completion_selected_index>`\ (\ index\: :ref:`int<class_int>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_code_hint<class_CodeEdit_method_set_code_hint>`\ (\ code_hint\: :ref:`String<class_String>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_code_hint_draw_below<class_CodeEdit_method_set_code_hint_draw_below>`\ (\ draw_below\: :ref:`bool<class_bool>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_code_region_tags<class_CodeEdit_method_set_code_region_tags>`\ (\ start\: :ref:`String<class_String>` = "region", end\: :ref:`String<class_String>` = "endregion"\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_line_as_bookmarked<class_CodeEdit_method_set_line_as_bookmarked>`\ (\ line\: :ref:`int<class_int>`, bookmarked\: :ref:`bool<class_bool>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_line_as_breakpoint<class_CodeEdit_method_set_line_as_breakpoint>`\ (\ line\: :ref:`int<class_int>`, breakpointed\: :ref:`bool<class_bool>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_line_as_executing<class_CodeEdit_method_set_line_as_executing>`\ (\ line\: :ref:`int<class_int>`, executing\: :ref:`bool<class_bool>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_symbol_lookup_word_as_valid<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`\ (\ valid\: :ref:`bool<class_bool>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`toggle_foldable_line<class_CodeEdit_method_toggle_foldable_line>`\ (\ line\: :ref:`int<class_int>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`toggle_foldable_lines_at_carets<class_CodeEdit_method_toggle_foldable_lines_at_carets>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`unfold_all_lines<class_CodeEdit_method_unfold_all_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`unfold_line<class_CodeEdit_method_unfold_line>`\ (\ line\: :ref:`int<class_int>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`unindent_lines<class_CodeEdit_method_unindent_lines>`\ (\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`update_code_completion_options<class_CodeEdit_method_update_code_completion_options>`\ (\ force\: :ref:`bool<class_bool>`\ ) |
+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
Propriétés du thème
--------------------------------------
.. table::
:widths: auto
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`bookmark_color<class_CodeEdit_theme_color_bookmark_color>` | ``Color(0.5, 0.64, 1, 0.8)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`brace_mismatch_color<class_CodeEdit_theme_color_brace_mismatch_color>` | ``Color(1, 0.2, 0.2, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`breakpoint_color<class_CodeEdit_theme_color_breakpoint_color>` | ``Color(0.9, 0.29, 0.3, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`code_folding_color<class_CodeEdit_theme_color_code_folding_color>` | ``Color(0.8, 0.8, 0.8, 0.8)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`completion_background_color<class_CodeEdit_theme_color_completion_background_color>` | ``Color(0.17, 0.16, 0.2, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`completion_existing_color<class_CodeEdit_theme_color_completion_existing_color>` | ``Color(0.87, 0.87, 0.87, 0.13)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`completion_scroll_color<class_CodeEdit_theme_color_completion_scroll_color>` | ``Color(1, 1, 1, 0.29)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`completion_scroll_hovered_color<class_CodeEdit_theme_color_completion_scroll_hovered_color>` | ``Color(1, 1, 1, 0.4)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`completion_selected_color<class_CodeEdit_theme_color_completion_selected_color>` | ``Color(0.26, 0.26, 0.27, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`executing_line_color<class_CodeEdit_theme_color_executing_line_color>` | ``Color(0.98, 0.89, 0.27, 1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`folded_code_region_color<class_CodeEdit_theme_color_folded_code_region_color>` | ``Color(0.68, 0.46, 0.77, 0.2)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`line_length_guideline_color<class_CodeEdit_theme_color_line_length_guideline_color>` | ``Color(0.3, 0.5, 0.8, 0.1)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Color<class_Color>` | :ref:`line_number_color<class_CodeEdit_theme_color_line_number_color>` | ``Color(0.67, 0.67, 0.67, 0.4)`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`completion_lines<class_CodeEdit_theme_constant_completion_lines>` | ``7`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`completion_max_width<class_CodeEdit_theme_constant_completion_max_width>` | ``50`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`int<class_int>` | :ref:`completion_scroll_width<class_CodeEdit_theme_constant_completion_scroll_width>` | ``6`` |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`bookmark<class_CodeEdit_theme_icon_bookmark>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`breakpoint<class_CodeEdit_theme_icon_breakpoint>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`can_fold<class_CodeEdit_theme_icon_can_fold>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`can_fold_code_region<class_CodeEdit_theme_icon_can_fold_code_region>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`completion_color_bg<class_CodeEdit_theme_icon_completion_color_bg>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`executing_line<class_CodeEdit_theme_icon_executing_line>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folded<class_CodeEdit_theme_icon_folded>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folded_code_region<class_CodeEdit_theme_icon_folded_code_region>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`Texture2D<class_Texture2D>` | :ref:`folded_eol_icon<class_CodeEdit_theme_icon_folded_eol_icon>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`completion<class_CodeEdit_theme_style_completion>` | |
+-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Signaux
--------------
.. _class_CodeEdit_signal_breakpoint_toggled:
.. rst-class:: classref-signal
**breakpoint_toggled**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_breakpoint_toggled>`
Émis lorsqu'un point d'arrêt est ajouté ou retiré d'une ligne. Si la ligne est retirée via un retour arrière, un signal est émis à l'ancienne ligne.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_signal_code_completion_requested:
.. rst-class:: classref-signal
**code_completion_requested**\ (\ ) :ref:`🔗<class_CodeEdit_signal_code_completion_requested>`
Émis lorsque l'utilisateur demande la complétion du code. Ce signal ne sera pas envoyé si :ref:`_request_code_completion()<class_CodeEdit_private_method__request_code_completion>` est redéfini ou :ref:`code_completion_enabled<class_CodeEdit_property_code_completion_enabled>` vaut ``false``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_signal_symbol_hovered:
.. rst-class:: classref-signal
**symbol_hovered**\ (\ symbol\: :ref:`String<class_String>`, line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_hovered>`
Émis lorsque l'utilisateur survole un symbole. Contrairement à :ref:`Control.mouse_entered<class_Control_signal_mouse_entered>`, ce signal n'est pas émis immédiatement, mais lorsque le curseur est sur le symbole pendant :ref:`ProjectSettings.gui/timers/tooltip_delay_sec<class_ProjectSettings_property_gui/timers/tooltip_delay_sec>` secondes.
\ **Note :** :ref:`symbol_tooltip_on_hover<class_CodeEdit_property_symbol_tooltip_on_hover>` doit valoir ``true`` pour que ce signal soit émis.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_signal_symbol_lookup:
.. rst-class:: classref-signal
**symbol_lookup**\ (\ symbol\: :ref:`String<class_String>`, line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_lookup>`
Émis lorsque l'utilisateur a cliqué sur un symbole valide.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_signal_symbol_validate:
.. rst-class:: classref-signal
**symbol_validate**\ (\ symbol\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_validate>`
Émis lorsque l'utilisateur survole un symbole. Le symbole doit être valide et avoir reçu une réponse, en appelant :ref:`set_symbol_lookup_word_as_valid()<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`.
\ **Note : ** :ref:`symbol_lookup_on_click<class_CodeEdit_property_symbol_lookup_on_click>` doit valoir ``true`` pour que ce signal soit émis.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Énumérations
------------------------
.. _enum_CodeEdit_CodeCompletionKind:
.. rst-class:: classref-enumeration
enum **CodeCompletionKind**: :ref:`🔗<enum_CodeEdit_CodeCompletionKind>`
.. _class_CodeEdit_constant_KIND_CLASS:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CLASS** = ``0``
Marque l'option comme une classe.
.. _class_CodeEdit_constant_KIND_FUNCTION:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FUNCTION** = ``1``
Marque l'option comme une fonction.
.. _class_CodeEdit_constant_KIND_SIGNAL:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_SIGNAL** = ``2``
Marque l'option comme un signal Godot.
.. _class_CodeEdit_constant_KIND_VARIABLE:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_VARIABLE** = ``3``
Marque l'option comme une variable.
.. _class_CodeEdit_constant_KIND_MEMBER:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_MEMBER** = ``4``
Marque l'option comme un membre.
.. _class_CodeEdit_constant_KIND_ENUM:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_ENUM** = ``5``
Marque l'option comme entrée d'énum.
.. _class_CodeEdit_constant_KIND_CONSTANT:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CONSTANT** = ``6``
Marque l'option comme une constante.
.. _class_CodeEdit_constant_KIND_NODE_PATH:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_NODE_PATH** = ``7``
Marque l'option comme un chemin de nœud Godot.
.. _class_CodeEdit_constant_KIND_FILE_PATH:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FILE_PATH** = ``8``
Marque l'option comme un chemin de fichier.
.. _class_CodeEdit_constant_KIND_PLAIN_TEXT:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_PLAIN_TEXT** = ``9``
Marque l'option comme du texte brut ou non classifié.
.. rst-class:: classref-item-separator
----
.. _enum_CodeEdit_CodeCompletionLocation:
.. rst-class:: classref-enumeration
enum **CodeCompletionLocation**: :ref:`🔗<enum_CodeEdit_CodeCompletionLocation>`
.. _class_CodeEdit_constant_LOCATION_LOCAL:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_LOCAL** = ``0``
L'option est locale à l'emplacement de la requête de complétion de code - p.ex. une variable locale. La valeur subséquente de l'emplacement représente les options de la classe externe, la valeur exacte représente la distance (en termes de classes intérieures).
.. _class_CodeEdit_constant_LOCATION_PARENT_MASK:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_PARENT_MASK** = ``256``
L'option provient de la classe contenante ou d'une classe parente, par rapport à l'emplacement de la requête de complétion du code. Effectue un bitwise OU avec la profondeur de la classe (par exemple ``0`` pour la classe locale, ``1`` pour le parent, ``2`` pour le grand-parent, etc.) pour stocker la profondeur d'une option dans la classe ou dans la classe parente.
.. _class_CodeEdit_constant_LOCATION_OTHER_USER_CODE:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER_USER_CODE** = ``512``
L'option provient du code de l'utilisateur qui n'est pas local et pas dans une classe dérivée (p. ex., Singletons à chargement automatique).
.. _class_CodeEdit_constant_LOCATION_OTHER:
.. rst-class:: classref-enumeration-constant
:ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER** = ``1024``
L'option provient d'un autre code du moteur, non couvert par les autres constantes d'énumération - par ex. de classes intégrées.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des propriétés
------------------------------------------------------
.. _class_CodeEdit_property_auto_brace_completion_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **auto_brace_completion_enabled** = ``false`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_auto_brace_completion_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_auto_brace_completion_enabled**\ (\ )
If ``true``, uses :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>` to automatically insert the closing brace when the opening brace is inserted by typing or autocompletion. Also automatically removes the closing brace when using backspace on the opening brace.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_auto_brace_completion_highlight_matching:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **auto_brace_completion_highlight_matching** = ``false`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_highlight_matching>`
.. rst-class:: classref-property-setget
- |void| **set_highlight_matching_braces_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_highlight_matching_braces_enabled**\ (\ )
If ``true``, highlights brace pairs when the caret is on either one, using :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>`. If matching, the pairs will be underlined. If a brace is unmatched, it is colored with :ref:`brace_mismatch_color<class_CodeEdit_theme_color_brace_mismatch_color>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_auto_brace_completion_pairs:
.. rst-class:: classref-property
:ref:`Dictionary<class_Dictionary>` **auto_brace_completion_pairs** = ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_pairs>`
.. rst-class:: classref-property-setget
- |void| **set_auto_brace_completion_pairs**\ (\ value\: :ref:`Dictionary<class_Dictionary>`\ )
- :ref:`Dictionary<class_Dictionary>` **get_auto_brace_completion_pairs**\ (\ )
Sets the brace pairs to be autocompleted. For each entry in the dictionary, the key is the opening brace and the value is the closing brace that matches it. A brace is a :ref:`String<class_String>` made of symbols. See :ref:`auto_brace_completion_enabled<class_CodeEdit_property_auto_brace_completion_enabled>` and :ref:`auto_brace_completion_highlight_matching<class_CodeEdit_property_auto_brace_completion_highlight_matching>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_code_completion_enabled:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **code_completion_enabled** = ``false`` :ref:`🔗<class_CodeEdit_property_code_completion_enabled>`
.. rst-class:: classref-property-setget
- |void| **set_code_completion_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_code_completion_enabled**\ (\ )
Si ``true``, l'action :ref:`ProjectSettings.input/ui_text_completion_query<class_ProjectSettings_property_input/ui_text_completion_query>` demande la complétion du code. Pour la gérer, voir :ref:`_request_code_completion()<class_CodeEdit_private_method__request_code_completion>` ou :ref:`code_completion_requested<class_CodeEdit_signal_code_completion_requested>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_code_completion_prefixes:
.. rst-class:: classref-property
:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **code_completion_prefixes** = ``[]`` :ref:`🔗<class_CodeEdit_property_code_completion_prefixes>`
.. rst-class:: classref-property-setget
- |void| **set_code_completion_prefixes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_code_completion_prefixes**\ (\ )
Définit les préfixes qui déclencheront la complétion du code.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_delimiter_comments:
.. rst-class:: classref-property
:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **delimiter_comments** = ``[]`` :ref:`🔗<class_CodeEdit_property_delimiter_comments>`
.. rst-class:: classref-property-setget
- |void| **set_comment_delimiters**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_comment_delimiters**\ (\ )
Définit les délimiteurs de commentaire. Tous les délimiteurs de commentaire existants seront supprimés.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_delimiter_strings:
.. rst-class:: classref-property
:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **delimiter_strings** = ``["' '", "\" \""]`` :ref:`🔗<class_CodeEdit_property_delimiter_strings>`
.. rst-class:: classref-property-setget
- |void| **set_string_delimiters**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_string_delimiters**\ (\ )
Définit les délimiteurs de chaîne. Tous les délimiteurs de chaîne existants seront supprimés.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_draw_bookmarks:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gutters_draw_bookmarks** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_bookmarks>`
.. rst-class:: classref-property-setget
- |void| **set_draw_bookmarks_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_drawing_bookmarks_gutter**\ (\ )
If ``true``, bookmarks are drawn in the gutter. This gutter is shared with breakpoints and executing lines. See :ref:`set_line_as_bookmarked()<class_CodeEdit_method_set_line_as_bookmarked>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_draw_breakpoints_gutter:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gutters_draw_breakpoints_gutter** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_breakpoints_gutter>`
.. rst-class:: classref-property-setget
- |void| **set_draw_breakpoints_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_drawing_breakpoints_gutter**\ (\ )
If ``true``, breakpoints are drawn in the gutter. This gutter is shared with bookmarks and executing lines. Clicking the gutter will toggle the breakpoint for the line, see :ref:`set_line_as_breakpoint()<class_CodeEdit_method_set_line_as_breakpoint>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_draw_executing_lines:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gutters_draw_executing_lines** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_executing_lines>`
.. rst-class:: classref-property-setget
- |void| **set_draw_executing_lines_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_drawing_executing_lines_gutter**\ (\ )
If ``true``, executing lines are marked in the gutter. This gutter is shared with breakpoints and bookmarks. See :ref:`set_line_as_executing()<class_CodeEdit_method_set_line_as_executing>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_draw_fold_gutter:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gutters_draw_fold_gutter** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_fold_gutter>`
.. rst-class:: classref-property-setget
- |void| **set_draw_fold_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_drawing_fold_gutter**\ (\ )
If ``true``, the fold gutter is drawn. In this gutter, the :ref:`can_fold_code_region<class_CodeEdit_theme_icon_can_fold_code_region>` icon is drawn for each foldable line (see :ref:`can_fold_line()<class_CodeEdit_method_can_fold_line>`) and the :ref:`folded_code_region<class_CodeEdit_theme_icon_folded_code_region>` icon is drawn for each folded line (see :ref:`is_line_folded()<class_CodeEdit_method_is_line_folded>`). These icons can be clicked to toggle the fold state, see :ref:`toggle_foldable_line()<class_CodeEdit_method_toggle_foldable_line>`. :ref:`line_folding<class_CodeEdit_property_line_folding>` must be ``true`` to show icons.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_draw_line_numbers:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gutters_draw_line_numbers** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_line_numbers>`
.. rst-class:: classref-property-setget
- |void| **set_draw_line_numbers**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_draw_line_numbers_enabled**\ (\ )
If ``true``, the line number gutter is drawn. Line numbers start at ``1`` and are incremented for each line of text. Clicking and dragging in the line number gutter will select entire lines of text.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_line_numbers_min_digits:
.. rst-class:: classref-property
:ref:`int<class_int>` **gutters_line_numbers_min_digits** = ``3`` :ref:`🔗<class_CodeEdit_property_gutters_line_numbers_min_digits>`
.. rst-class:: classref-property-setget
- |void| **set_line_numbers_min_digits**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_line_numbers_min_digits**\ (\ )
The minimum width in digits reserved for the line number gutter.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_gutters_zero_pad_line_numbers:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **gutters_zero_pad_line_numbers** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_zero_pad_line_numbers>`
.. rst-class:: classref-property-setget
- |void| **set_line_numbers_zero_padded**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_line_numbers_zero_padded**\ (\ )
If ``true``, line numbers drawn in the gutter are zero padded based on the total line count. Requires :ref:`gutters_draw_line_numbers<class_CodeEdit_property_gutters_draw_line_numbers>` to be set to ``true``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_automatic:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **indent_automatic** = ``false`` :ref:`🔗<class_CodeEdit_property_indent_automatic>`
.. rst-class:: classref-property-setget
- |void| **set_auto_indent_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_auto_indent_enabled**\ (\ )
If ``true``, an extra indent is automatically inserted when a new line is added and a prefix in :ref:`indent_automatic_prefixes<class_CodeEdit_property_indent_automatic_prefixes>` is found. If a brace pair opening key is found, the matching closing brace will be moved to another new line (see :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>`).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_automatic_prefixes:
.. rst-class:: classref-property
:ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **indent_automatic_prefixes** = ``[":", "{", "[", "("]`` :ref:`🔗<class_CodeEdit_property_indent_automatic_prefixes>`
.. rst-class:: classref-property-setget
- |void| **set_auto_indent_prefixes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_auto_indent_prefixes**\ (\ )
Prefixes to trigger an automatic indent. Used when :ref:`indent_automatic<class_CodeEdit_property_indent_automatic>` is set to ``true``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_size:
.. rst-class:: classref-property
:ref:`int<class_int>` **indent_size** = ``4`` :ref:`🔗<class_CodeEdit_property_indent_size>`
.. rst-class:: classref-property-setget
- |void| **set_indent_size**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_indent_size**\ (\ )
Size of the tabulation indent (one :kbd:`Tab` press) in characters. If :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>` is enabled the number of spaces to use.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_indent_use_spaces:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **indent_use_spaces** = ``false`` :ref:`🔗<class_CodeEdit_property_indent_use_spaces>`
.. rst-class:: classref-property-setget
- |void| **set_indent_using_spaces**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_indent_using_spaces**\ (\ )
Utiliser des espaces au lieu des tabulations pour l'indentation.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_line_folding:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **line_folding** = ``false`` :ref:`🔗<class_CodeEdit_property_line_folding>`
.. rst-class:: classref-property-setget
- |void| **set_line_folding_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_line_folding_enabled**\ (\ )
Si ``true``, les lignes peuvent être repliées. Sinon, les méthodes de repli de ligne comme :ref:`fold_line()<class_CodeEdit_method_fold_line>` ne fonctionneront pas et :ref:`can_fold_line()<class_CodeEdit_method_can_fold_line>` renverra toujours ``false``. Voir :ref:`gutters_draw_fold_gutter<class_CodeEdit_property_gutters_draw_fold_gutter>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_line_length_guidelines:
.. rst-class:: classref-property
:ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **line_length_guidelines** = ``[]`` :ref:`🔗<class_CodeEdit_property_line_length_guidelines>`
.. rst-class:: classref-property-setget
- |void| **set_line_length_guidelines**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`int<class_int>`\]\ )
- :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **get_line_length_guidelines**\ (\ )
Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is drawn more prominently.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_symbol_lookup_on_click:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **symbol_lookup_on_click** = ``false`` :ref:`🔗<class_CodeEdit_property_symbol_lookup_on_click>`
.. rst-class:: classref-property-setget
- |void| **set_symbol_lookup_on_click_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_symbol_lookup_on_click_enabled**\ (\ )
Set when a validated word from :ref:`symbol_validate<class_CodeEdit_signal_symbol_validate>` is clicked, the :ref:`symbol_lookup<class_CodeEdit_signal_symbol_lookup>` should be emitted.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_property_symbol_tooltip_on_hover:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **symbol_tooltip_on_hover** = ``false`` :ref:`🔗<class_CodeEdit_property_symbol_tooltip_on_hover>`
.. rst-class:: classref-property-setget
- |void| **set_symbol_tooltip_on_hover_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **is_symbol_tooltip_on_hover_enabled**\ (\ )
Si ``true``, le signal :ref:`symbol_hovered<class_CodeEdit_signal_symbol_hovered>` est émis lors du sur-volage d'un mot.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des méthodes
--------------------------------------------------
.. _class_CodeEdit_private_method__confirm_code_completion:
.. rst-class:: classref-method
|void| **_confirm_code_completion**\ (\ replace\: :ref:`bool<class_bool>`\ ) |virtual| :ref:`🔗<class_CodeEdit_private_method__confirm_code_completion>`
Redéfinissez cette méthode pour définir comment l'entrée sélectionnée devrait être insérée. Si ``replace`` vaut ``true``, tout texte existant devrait être remplacé.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_private_method__filter_code_completion_candidates:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **_filter_code_completion_candidates**\ (\ candidates\: :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\]\ ) |virtual| |const| :ref:`🔗<class_CodeEdit_private_method__filter_code_completion_candidates>`
Redéfinissez cette méthode pour définir quels éléments dans ``candidates`` devraient être affichés.
\ ``candidates`` et le valeur renvoyée sont un :ref:`Array<class_Array>` de :ref:`Dictionary<class_Dictionary>`, voir :ref:`get_code_completion_option()<class_CodeEdit_method_get_code_completion_option>` pour le contenu du :ref:`Dictionary<class_Dictionary>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_private_method__request_code_completion:
.. rst-class:: classref-method
|void| **_request_code_completion**\ (\ force\: :ref:`bool<class_bool>`\ ) |virtual| :ref:`🔗<class_CodeEdit_private_method__request_code_completion>`
Redéfinissez cette méthode pour définir ce qui se passe lorsque l'utilisateur demande la complétion du code. Si ``force`` vaut ``true``, toute vérification devrait être contournée.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_auto_brace_completion_pair:
.. rst-class:: classref-method
|void| **add_auto_brace_completion_pair**\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_add_auto_brace_completion_pair>`
Ajoute une paire d'accolades.
Les clés de démarrage et de fin doivent être des symboles. Seule la clé de départ doit être unique.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_code_completion_option:
.. rst-class:: classref-method
|void| **add_code_completion_option**\ (\ type\: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`, display_text\: :ref:`String<class_String>`, insert_text\: :ref:`String<class_String>`, text_color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), icon\: :ref:`Resource<class_Resource>` = null, value\: :ref:`Variant<class_Variant>` = null, location\: :ref:`int<class_int>` = 1024\ ) :ref:`🔗<class_CodeEdit_method_add_code_completion_option>`
Soumet un élément à la liste des potentiels candidats pour le menu d'autocomplétion. Appelez :ref:`update_code_completion_options()<class_CodeEdit_method_update_code_completion_options>` pour mettre à jour cette liste.
\ ``location`` indique la position de l'option par rapport à la position de la requête de complétion du code. Voir :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` pour des informations sur comment définir cette valeur.
\ **Remarque :** Cette liste remplacera tous les candidats actuels.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_comment_delimiter:
.. rst-class:: classref-method
|void| **add_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_add_comment_delimiter>`
Adds a comment delimiter from ``start_key`` to ``end_key``. Both keys should be symbols, and ``start_key`` must not be shared with other delimiters.
If ``line_only`` is ``true`` or ``end_key`` is an empty :ref:`String<class_String>`, the region does not carry over to the next line.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_add_string_delimiter:
.. rst-class:: classref-method
|void| **add_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`, end_key\: :ref:`String<class_String>`, line_only\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_add_string_delimiter>`
Defines a string delimiter from ``start_key`` to ``end_key``. Both keys should be symbols, and ``start_key`` must not be shared with other delimiters.
If ``line_only`` is ``true`` or ``end_key`` is an empty :ref:`String<class_String>`, the region does not carry over to the next line.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_can_fold_line:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **can_fold_line**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_can_fold_line>`
Renvoie ``true`` si la ligne donnée est repliable. Une ligne est repliable si elle est le début d'une région de code valide (voir :ref:`get_code_region_start_tag()<class_CodeEdit_method_get_code_region_start_tag>`), si elle est le début d'un bloc de commentaire ou de chaîne, ou si la prochaine ligne non-vide est plus indentée (voir :ref:`TextEdit.get_indent_level()<class_TextEdit_method_get_indent_level>`).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_cancel_code_completion:
.. rst-class:: classref-method
|void| **cancel_code_completion**\ (\ ) :ref:`🔗<class_CodeEdit_method_cancel_code_completion>`
Annule le menu d'autocomplétion.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_bookmarked_lines:
.. rst-class:: classref-method
|void| **clear_bookmarked_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_bookmarked_lines>`
Efface toutes les lignes marquées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_breakpointed_lines:
.. rst-class:: classref-method
|void| **clear_breakpointed_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_breakpointed_lines>`
Efface toute les lignes avec un point d'arrêt.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_comment_delimiters:
.. rst-class:: classref-method
|void| **clear_comment_delimiters**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_comment_delimiters>`
Supprime tous les délimiteurs de commentaires.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_executing_lines:
.. rst-class:: classref-method
|void| **clear_executing_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_executing_lines>`
Efface toutes les lignes exécutées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_clear_string_delimiters:
.. rst-class:: classref-method
|void| **clear_string_delimiters**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_string_delimiters>`
Supprime tous les délimiteurs de chaîne.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_confirm_code_completion:
.. rst-class:: classref-method
|void| **confirm_code_completion**\ (\ replace\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_confirm_code_completion>`
Insère l'entrée sélectionnée dans le texte. Si ``replace`` vaut ``true``, tout texte existant est remplacé plutôt que fusionné.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_convert_indent:
.. rst-class:: classref-method
|void| **convert_indent**\ (\ from_line\: :ref:`int<class_int>` = -1, to_line\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_CodeEdit_method_convert_indent>`
Convertit les indentations des lignes entre la ligne ``from_line`` et la ligne ``to_line`` en tabulations ou espaces tels que définis par :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`.
Des valeurs de ``-1`` convertissent le texte entier.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_create_code_region:
.. rst-class:: classref-method
|void| **create_code_region**\ (\ ) :ref:`🔗<class_CodeEdit_method_create_code_region>`
Creates a new code region with the selection. At least one single line comment delimiter have to be defined (see :ref:`add_comment_delimiter()<class_CodeEdit_method_add_comment_delimiter>`).
A code region is a part of code that is highlighted when folded and can help organize your script.
Code region start and end tags can be customized (see :ref:`set_code_region_tags()<class_CodeEdit_method_set_code_region_tags>`).
Code regions are delimited using start and end tags (respectively ``region`` and ``endregion`` by default) preceded by one line comment delimiter. (eg. ``#region`` and ``#endregion``)
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_delete_lines:
.. rst-class:: classref-method
|void| **delete_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_delete_lines>`
Supprime toutes les lignes qui sont sélectionnées ou qui ont un curseur sur elles.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_do_indent:
.. rst-class:: classref-method
|void| **do_indent**\ (\ ) :ref:`🔗<class_CodeEdit_method_do_indent>`
S'il n'y a pas de sélection, de l'indentation est insérée au curseur. Sinon, les lignes sélectionnées sont indentées comme avec :ref:`indent_lines()<class_CodeEdit_method_indent_lines>`. Équivalent à l'action :ref:`ProjectSettings.input/ui_text_indent<class_ProjectSettings_property_input/ui_text_indent>`. Les caractères d'indentation utilisés dépendent de :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>` et :ref:`indent_size<class_CodeEdit_property_indent_size>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_duplicate_lines:
.. rst-class:: classref-method
|void| **duplicate_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_duplicate_lines>`
Duplique toutes les lignes actuellement sélectionnées avec n'importe quel curseur. Duplique la ligne entière sous le curseur actuel, peu importe où le curseur se trouve dans la ligne.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_duplicate_selection:
.. rst-class:: classref-method
|void| **duplicate_selection**\ (\ ) :ref:`🔗<class_CodeEdit_method_duplicate_selection>`
Duplique tous le texte sélectionné et duplique toutes les lignes avec un curseur sur elles.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_fold_all_lines:
.. rst-class:: classref-method
|void| **fold_all_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_fold_all_lines>`
Réduit toutes les lignes qui peuvent être réduites (voir :ref:`can_fold_line()<class_CodeEdit_method_can_fold_line>`).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_fold_line:
.. rst-class:: classref-method
|void| **fold_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_fold_line>`
Réduit la ligne donnée, si possible (voir :ref:`can_fold_line()<class_CodeEdit_method_can_fold_line>`).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_auto_brace_completion_close_key:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_auto_brace_completion_close_key**\ (\ open_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_auto_brace_completion_close_key>`
Gets the matching auto brace close key for ``open_key``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_bookmarked_lines:
.. rst-class:: classref-method
:ref:`PackedInt32Array<class_PackedInt32Array>` **get_bookmarked_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_bookmarked_lines>`
Gets all bookmarked lines.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_breakpointed_lines:
.. rst-class:: classref-method
:ref:`PackedInt32Array<class_PackedInt32Array>` **get_breakpointed_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_breakpointed_lines>`
Obtient toutes les lignes avec un point d'arrêt.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_code_completion_option:
.. rst-class:: classref-method
:ref:`Dictionary<class_Dictionary>` **get_code_completion_option**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_option>`
Obtient l'option de complétion à l'index ``index``. Le :ref:`Dictionary<class_Dictionary>` renvoyé a les clés-valeurs suivantes :
\ ``kind``\  : :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`\
\ ``display_text``\  : Texte qui est affiché dans le menu d'autocomplétion.
\ ``insert_text``\  : Texte à insérer lors de la sélection de cet élément.
\ ``font_color``\  : Couleur du texte dans le menu d'autocomplétion.
\ ``icon``\  : Icône à dessiner dans le menu d'autocomplétion.
\ ``default_value``\  : Valeur du symbole.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_code_completion_options:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_code_completion_options**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_options>`
Obtient toutes les options de complétion, voir :ref:`get_code_completion_option()<class_CodeEdit_method_get_code_completion_option>` pour le contenu du résultat.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_code_completion_selected_index:
.. rst-class:: classref-method
:ref:`int<class_int>` **get_code_completion_selected_index**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_selected_index>`
Obtient l'index de l'option de complétion sélectionnée actuelle.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_code_region_end_tag:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_code_region_end_tag**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_region_end_tag>`
Renvoie la balise de fin de région de code (sans délimiteur de commentaire).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_code_region_start_tag:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_code_region_start_tag**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_region_start_tag>`
Renvoie la balise de début de région de code (sans délimiteur de commentaire).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_delimiter_end_key:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_delimiter_end_key**\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_end_key>`
Obtient la clé de fin pour un index de chaîne ou région de commentaire.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_delimiter_end_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_delimiter_end_position**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_end_position>`
If ``line`` ``column`` is in a string or comment, returns the end position of the region. If not or no end could be found, both :ref:`Vector2<class_Vector2>` values will be ``-1``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_delimiter_start_key:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_delimiter_start_key**\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_start_key>`
Obtient la clé de départ pour un index de chaîne ou de région de commentaire.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_delimiter_start_position:
.. rst-class:: classref-method
:ref:`Vector2<class_Vector2>` **get_delimiter_start_position**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_start_position>`
Si ``line`` ``column`` est dans une chaîne ou un commentaire, renvoie la position de départ de la région. Sinon ou si aucun départ n'a été trouvé, les deux valeurs du :ref:`Vector2<class_Vector2>` vaudront ``-1``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_executing_lines:
.. rst-class:: classref-method
:ref:`PackedInt32Array<class_PackedInt32Array>` **get_executing_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_executing_lines>`
Gets all executing lines.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_folded_lines:
.. rst-class:: classref-method
:ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **get_folded_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_folded_lines>`
Renvoie toutes les lignes qui sont actuellement repliées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_text_for_code_completion:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_text_for_code_completion**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_for_code_completion>`
Renvoie le texte complet avec le caractère ``0xFFFF`` à l'emplacement du caret.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_text_for_symbol_lookup:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_text_for_symbol_lookup**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_for_symbol_lookup>`
Renvoie le texte complet avec le caractère ``0xFFFF`` à l'emplacement du curseur.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_get_text_with_cursor_char:
.. rst-class:: classref-method
:ref:`String<class_String>` **get_text_with_cursor_char**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_with_cursor_char>`
Renvoie le texte complet avec le caractère ``0xFFFF`` à l'emplacement spécifié.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_has_auto_brace_completion_close_key:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_auto_brace_completion_close_key**\ (\ close_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_auto_brace_completion_close_key>`
Renvoie ``true`` si la clé de fermeture ``close_key`` existe.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_has_auto_brace_completion_open_key:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_auto_brace_completion_open_key**\ (\ open_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_auto_brace_completion_open_key>`
Renvoie ``true`` si la clé d'ouverture ``open_key`` existe.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_has_comment_delimiter:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_comment_delimiter>`
Renvoie ``true`` si le commentaire ``start_key`` existe.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_has_string_delimiter:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **has_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_string_delimiter>`
Renvoie ``true`` si la chaîne de caractères ``start_key`` existe.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_indent_lines:
.. rst-class:: classref-method
|void| **indent_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_indent_lines>`
Indente toutes les lignes qui sont sélectionnées ou qui ont un curseur sur elles. Utilise des espaces ou une tabulation en fonction de :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`. Voir :ref:`unindent_lines()<class_CodeEdit_method_unindent_lines>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_in_comment:
.. rst-class:: classref-method
:ref:`int<class_int>` **is_in_comment**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_CodeEdit_method_is_in_comment>`
Returns delimiter index if ``line`` ``column`` is in a comment. If ``column`` is not provided, will return delimiter index if the entire ``line`` is a comment. Otherwise ``-1``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_in_string:
.. rst-class:: classref-method
:ref:`int<class_int>` **is_in_string**\ (\ line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_CodeEdit_method_is_in_string>`
Returns the delimiter index if ``line`` ``column`` is in a string. If ``column`` is not provided, will return the delimiter index if the entire ``line`` is a string. Otherwise ``-1``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_bookmarked:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_bookmarked**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_bookmarked>`
Renvoie ``true`` si la ligne donnée est marquée. Voir :ref:`set_line_as_bookmarked()<class_CodeEdit_method_set_line_as_bookmarked>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_breakpointed:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_breakpointed**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_breakpointed>`
Renvoie ``true`` si la ligne donnée a un point d'arrêt. Voir :ref:`set_line_as_breakpoint()<class_CodeEdit_method_set_line_as_breakpoint>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_code_region_end:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_code_region_end**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_code_region_end>`
Renvoie ``true`` si la ligne donnée est une fin de région de code. Voir :ref:`set_code_region_tags()<class_CodeEdit_method_set_code_region_tags>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_code_region_start:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_code_region_start**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_code_region_start>`
Renvoie ``true`` si la ligne donnée est un début de région de code. Voir :ref:`set_code_region_tags()<class_CodeEdit_method_set_code_region_tags>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_executing:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_executing**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_executing>`
Renvoie ``true`` si la ligne donnée est marquée comme en cours d'exécution. Voir :ref:`set_line_as_executing()<class_CodeEdit_method_set_line_as_executing>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_is_line_folded:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_line_folded**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_folded>`
Renvoie ``true`` si la ligne donnée est repliée. Voir :ref:`fold_line()<class_CodeEdit_method_fold_line>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_move_lines_down:
.. rst-class:: classref-method
|void| **move_lines_down**\ (\ ) :ref:`🔗<class_CodeEdit_method_move_lines_down>`
Moves all lines down that are selected or have a caret on them.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_move_lines_up:
.. rst-class:: classref-method
|void| **move_lines_up**\ (\ ) :ref:`🔗<class_CodeEdit_method_move_lines_up>`
Moves all lines up that are selected or have a caret on them.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_remove_comment_delimiter:
.. rst-class:: classref-method
|void| **remove_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_remove_comment_delimiter>`
Retire le délimiteur de commentaire avec la clé ``start_key``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_remove_string_delimiter:
.. rst-class:: classref-method
|void| **remove_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_remove_string_delimiter>`
Retire le délimiteur de chaîne avec la clé ``start_key``.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_request_code_completion:
.. rst-class:: classref-method
|void| **request_code_completion**\ (\ force\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_request_code_completion>`
Emits :ref:`code_completion_requested<class_CodeEdit_signal_code_completion_requested>`, if ``force`` is ``true`` will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path, or signal.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_completion_selected_index:
.. rst-class:: classref-method
|void| **set_code_completion_selected_index**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_completion_selected_index>`
Sets the current selected completion option.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_hint:
.. rst-class:: classref-method
|void| **set_code_hint**\ (\ code_hint\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_hint>`
Sets the code hint text. Pass an empty string to clear.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_hint_draw_below:
.. rst-class:: classref-method
|void| **set_code_hint_draw_below**\ (\ draw_below\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_hint_draw_below>`
If ``true``, the code hint will draw below the main caret. If ``false``, the code hint will draw above the main caret. See :ref:`set_code_hint()<class_CodeEdit_method_set_code_hint>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_code_region_tags:
.. rst-class:: classref-method
|void| **set_code_region_tags**\ (\ start\: :ref:`String<class_String>` = "region", end\: :ref:`String<class_String>` = "endregion"\ ) :ref:`🔗<class_CodeEdit_method_set_code_region_tags>`
Sets the code region start and end tags (without comment delimiter).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_line_as_bookmarked:
.. rst-class:: classref-method
|void| **set_line_as_bookmarked**\ (\ line\: :ref:`int<class_int>`, bookmarked\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_bookmarked>`
Sets the given line as bookmarked. If ``true`` and :ref:`gutters_draw_bookmarks<class_CodeEdit_property_gutters_draw_bookmarks>` is ``true``, draws the :ref:`bookmark<class_CodeEdit_theme_icon_bookmark>` icon in the gutter for this line. See :ref:`get_bookmarked_lines()<class_CodeEdit_method_get_bookmarked_lines>` and :ref:`is_line_bookmarked()<class_CodeEdit_method_is_line_bookmarked>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_line_as_breakpoint:
.. rst-class:: classref-method
|void| **set_line_as_breakpoint**\ (\ line\: :ref:`int<class_int>`, breakpointed\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_breakpoint>`
Sets the given line as a breakpoint. If ``true`` and :ref:`gutters_draw_breakpoints_gutter<class_CodeEdit_property_gutters_draw_breakpoints_gutter>` is ``true``, draws the :ref:`breakpoint<class_CodeEdit_theme_icon_breakpoint>` icon in the gutter for this line. See :ref:`get_breakpointed_lines()<class_CodeEdit_method_get_breakpointed_lines>` and :ref:`is_line_breakpointed()<class_CodeEdit_method_is_line_breakpointed>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_line_as_executing:
.. rst-class:: classref-method
|void| **set_line_as_executing**\ (\ line\: :ref:`int<class_int>`, executing\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_executing>`
Sets the given line as executing. If ``true`` and :ref:`gutters_draw_executing_lines<class_CodeEdit_property_gutters_draw_executing_lines>` is ``true``, draws the :ref:`executing_line<class_CodeEdit_theme_icon_executing_line>` icon in the gutter for this line. See :ref:`get_executing_lines()<class_CodeEdit_method_get_executing_lines>` and :ref:`is_line_executing()<class_CodeEdit_method_is_line_executing>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_set_symbol_lookup_word_as_valid:
.. rst-class:: classref-method
|void| **set_symbol_lookup_word_as_valid**\ (\ valid\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`
Définit le symbole émis par :ref:`symbol_validate<class_CodeEdit_signal_symbol_validate>` comme un symbole de recherche valide.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_toggle_foldable_line:
.. rst-class:: classref-method
|void| **toggle_foldable_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_toggle_foldable_line>`
Réduit le bloc de code à la ligne donnée.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_toggle_foldable_lines_at_carets:
.. rst-class:: classref-method
|void| **toggle_foldable_lines_at_carets**\ (\ ) :ref:`🔗<class_CodeEdit_method_toggle_foldable_lines_at_carets>`
Toggle the folding of the code block on all lines with a caret on them.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_unfold_all_lines:
.. rst-class:: classref-method
|void| **unfold_all_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_unfold_all_lines>`
Déplie toutes les lignes qui sont repliées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_unfold_line:
.. rst-class:: classref-method
|void| **unfold_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_unfold_line>`
Déplie la ligne donnée si elle est repliée ou si elle est cachée sous une ligne repliée.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_unindent_lines:
.. rst-class:: classref-method
|void| **unindent_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_unindent_lines>`
Unindents all lines that are selected or have a caret on them. Uses spaces or a tab depending on :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`. Equivalent to the :ref:`ProjectSettings.input/ui_text_dedent<class_ProjectSettings_property_input/ui_text_dedent>` action. See :ref:`indent_lines()<class_CodeEdit_method_indent_lines>`.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_method_update_code_completion_options:
.. rst-class:: classref-method
|void| **update_code_completion_options**\ (\ force\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_update_code_completion_options>`
Submits all completion options added with :ref:`add_code_completion_option()<class_CodeEdit_method_add_code_completion_option>`. Will try to force the autocomplete menu to popup, if ``force`` is ``true``.
\ **Note:** This will replace all current candidates.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descriptions des propriétés du thème
------------------------------------------------------------------------
.. _class_CodeEdit_theme_color_bookmark_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **bookmark_color** = ``Color(0.5, 0.64, 1, 0.8)`` :ref:`🔗<class_CodeEdit_theme_color_bookmark_color>`
:ref:`Color<class_Color>` de l'icône de marquage pour les lignes marquées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_brace_mismatch_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **brace_mismatch_color** = ``Color(1, 0.2, 0.2, 1)`` :ref:`🔗<class_CodeEdit_theme_color_brace_mismatch_color>`
:ref:`Color<class_Color>` of the text to highlight mismatched braces.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_breakpoint_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **breakpoint_color** = ``Color(0.9, 0.29, 0.3, 1)`` :ref:`🔗<class_CodeEdit_theme_color_breakpoint_color>`
:ref:`Color<class_Color>` de l'icône de point d'arrêt pour les lignes marquées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_code_folding_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **code_folding_color** = ``Color(0.8, 0.8, 0.8, 0.8)`` :ref:`🔗<class_CodeEdit_theme_color_code_folding_color>`
:ref:`Color<class_Color>` for all icons related to line folding.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_completion_background_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **completion_background_color** = ``Color(0.17, 0.16, 0.2, 1)`` :ref:`🔗<class_CodeEdit_theme_color_completion_background_color>`
Définit la :ref:`Color<class_Color>` d'arrière-plan pour la popup de complétion du code.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_completion_existing_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **completion_existing_color** = ``Color(0.87, 0.87, 0.87, 0.13)`` :ref:`🔗<class_CodeEdit_theme_color_completion_existing_color>`
Background highlight :ref:`Color<class_Color>` for matching text in code completion options.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_completion_scroll_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **completion_scroll_color** = ``Color(1, 1, 1, 0.29)`` :ref:`🔗<class_CodeEdit_theme_color_completion_scroll_color>`
:ref:`Color<class_Color>` of the scrollbar in the code completion popup.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_completion_scroll_hovered_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **completion_scroll_hovered_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗<class_CodeEdit_theme_color_completion_scroll_hovered_color>`
:ref:`Color<class_Color>` of the scrollbar in the code completion popup when hovered.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_completion_selected_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **completion_selected_color** = ``Color(0.26, 0.26, 0.27, 1)`` :ref:`🔗<class_CodeEdit_theme_color_completion_selected_color>`
Background highlight :ref:`Color<class_Color>` for the current selected option item in the code completion popup.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_executing_line_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **executing_line_color** = ``Color(0.98, 0.89, 0.27, 1)`` :ref:`🔗<class_CodeEdit_theme_color_executing_line_color>`
:ref:`Color<class_Color>` of the executing icon for executing lines.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_folded_code_region_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **folded_code_region_color** = ``Color(0.68, 0.46, 0.77, 0.2)`` :ref:`🔗<class_CodeEdit_theme_color_folded_code_region_color>`
:ref:`Color<class_Color>` of background line highlight for folded code region.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_line_length_guideline_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **line_length_guideline_color** = ``Color(0.3, 0.5, 0.8, 0.1)`` :ref:`🔗<class_CodeEdit_theme_color_line_length_guideline_color>`
:ref:`Color<class_Color>` of the main line length guideline, secondary guidelines will have 50% alpha applied.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_color_line_number_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **line_number_color** = ``Color(0.67, 0.67, 0.67, 0.4)`` :ref:`🔗<class_CodeEdit_theme_color_line_number_color>`
Définit la :ref:`Color<class_Color>` des numéros de ligne.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_constant_completion_lines:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **completion_lines** = ``7`` :ref:`🔗<class_CodeEdit_theme_constant_completion_lines>`
Max number of options to display in the code completion popup at any one time.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_constant_completion_max_width:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **completion_max_width** = ``50`` :ref:`🔗<class_CodeEdit_theme_constant_completion_max_width>`
Largeur maximale des options dans le popup de complétion de code. Les options plus longues que cela seront coupées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_constant_completion_scroll_width:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **completion_scroll_width** = ``6`` :ref:`🔗<class_CodeEdit_theme_constant_completion_scroll_width>`
Largeur de la barre de défilement dans le popup de complétion de code.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_bookmark:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **bookmark** :ref:`🔗<class_CodeEdit_theme_icon_bookmark>`
Définit une :ref:`Texture2D<class_Texture2D>` personnalisée pour dessiner le bandeau de marquage pour les lignes marquées.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_breakpoint:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **breakpoint** :ref:`🔗<class_CodeEdit_theme_icon_breakpoint>`
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the breakpoint gutter for breakpointed lines.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_can_fold:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **can_fold** :ref:`🔗<class_CodeEdit_theme_icon_can_fold>`
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line can be folded.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_can_fold_code_region:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **can_fold_code_region** :ref:`🔗<class_CodeEdit_theme_icon_can_fold_code_region>`
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a code region can be folded.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_completion_color_bg:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **completion_color_bg** :ref:`🔗<class_CodeEdit_theme_icon_completion_color_bg>`
Background panel for the color preview box in autocompletion (visible when the color is translucent).
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_executing_line:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **executing_line** :ref:`🔗<class_CodeEdit_theme_icon_executing_line>`
Icon to draw in the executing gutter for executing lines.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_folded:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folded** :ref:`🔗<class_CodeEdit_theme_icon_folded>`
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line is folded and can be unfolded.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_folded_code_region:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folded_code_region** :ref:`🔗<class_CodeEdit_theme_icon_folded_code_region>`
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a code region is folded and can be unfolded.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_icon_folded_eol_icon:
.. rst-class:: classref-themeproperty
:ref:`Texture2D<class_Texture2D>` **folded_eol_icon** :ref:`🔗<class_CodeEdit_theme_icon_folded_eol_icon>`
Sets a custom :ref:`Texture2D<class_Texture2D>` to draw at the end of a folded line.
.. rst-class:: classref-item-separator
----
.. _class_CodeEdit_theme_style_completion:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **completion** :ref:`🔗<class_CodeEdit_theme_style_completion>`
:ref:`StyleBox<class_StyleBox>` pour la popup de complétion de code.
.. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)`
.. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)`
.. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)`
.. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)`
.. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)`
.. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)`
.. |void| replace:: :abbr:`void (Aucune valeur de retour.)`