class_codeedit.rst 148 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CodeEdit.xml.
  6. .. _class_CodeEdit:
  7. CodeEdit
  8. ========
  9. **Inherits:** :ref:`TextEdit<class_TextEdit>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. A multiline text editor designed for editing code.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. CodeEdit is a specialized :ref:`TextEdit<class_TextEdit>` designed for editing plain text code files. It has many features commonly found in code editors such as line numbers, line folding, code completion, indent management, and string/comment management.
  15. \ **Note:** Regardless of locale, **CodeEdit** will by default always use left-to-right text direction to correctly display source code.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`auto_brace_completion_enabled<class_CodeEdit_property_auto_brace_completion_enabled>` | ``false`` |
  23. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`auto_brace_completion_highlight_matching<class_CodeEdit_property_auto_brace_completion_highlight_matching>` | ``false`` |
  25. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  26. | :ref:`Dictionary<class_Dictionary>` | :ref:`auto_brace_completion_pairs<class_CodeEdit_property_auto_brace_completion_pairs>` | ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` |
  27. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  28. | :ref:`bool<class_bool>` | :ref:`code_completion_enabled<class_CodeEdit_property_code_completion_enabled>` | ``false`` |
  29. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  30. | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`code_completion_prefixes<class_CodeEdit_property_code_completion_prefixes>` | ``[]`` |
  31. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  32. | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`delimiter_comments<class_CodeEdit_property_delimiter_comments>` | ``[]`` |
  33. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  34. | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`delimiter_strings<class_CodeEdit_property_delimiter_strings>` | ``["' '", "\" \""]`` |
  35. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`gutters_draw_bookmarks<class_CodeEdit_property_gutters_draw_bookmarks>` | ``false`` |
  37. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  38. | :ref:`bool<class_bool>` | :ref:`gutters_draw_breakpoints_gutter<class_CodeEdit_property_gutters_draw_breakpoints_gutter>` | ``false`` |
  39. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  40. | :ref:`bool<class_bool>` | :ref:`gutters_draw_executing_lines<class_CodeEdit_property_gutters_draw_executing_lines>` | ``false`` |
  41. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  42. | :ref:`bool<class_bool>` | :ref:`gutters_draw_fold_gutter<class_CodeEdit_property_gutters_draw_fold_gutter>` | ``false`` |
  43. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  44. | :ref:`bool<class_bool>` | :ref:`gutters_draw_line_numbers<class_CodeEdit_property_gutters_draw_line_numbers>` | ``false`` |
  45. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  46. | :ref:`bool<class_bool>` | :ref:`gutters_zero_pad_line_numbers<class_CodeEdit_property_gutters_zero_pad_line_numbers>` | ``false`` |
  47. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  48. | :ref:`bool<class_bool>` | :ref:`indent_automatic<class_CodeEdit_property_indent_automatic>` | ``false`` |
  49. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  50. | :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] | :ref:`indent_automatic_prefixes<class_CodeEdit_property_indent_automatic_prefixes>` | ``[":", "{", "[", "("]`` |
  51. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  52. | :ref:`int<class_int>` | :ref:`indent_size<class_CodeEdit_property_indent_size>` | ``4`` |
  53. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>` | ``false`` |
  55. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  56. | :ref:`LayoutDirection<enum_Control_LayoutDirection>` | layout_direction | ``2`` (overrides :ref:`Control<class_Control_property_layout_direction>`) |
  57. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  58. | :ref:`bool<class_bool>` | :ref:`line_folding<class_CodeEdit_property_line_folding>` | ``false`` |
  59. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  60. | :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] | :ref:`line_length_guidelines<class_CodeEdit_property_line_length_guidelines>` | ``[]`` |
  61. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  62. | :ref:`bool<class_bool>` | :ref:`symbol_lookup_on_click<class_CodeEdit_property_symbol_lookup_on_click>` | ``false`` |
  63. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  64. | :ref:`TextDirection<enum_Control_TextDirection>` | text_direction | ``1`` (overrides :ref:`TextEdit<class_TextEdit_property_text_direction>`) |
  65. +----------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------+
  66. .. rst-class:: classref-reftable-group
  67. Methods
  68. -------
  69. .. table::
  70. :widths: auto
  71. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | |void| | :ref:`_confirm_code_completion<class_CodeEdit_private_method__confirm_code_completion>`\ (\ replace\: :ref:`bool<class_bool>`\ ) |virtual| |
  73. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :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| |
  75. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | |void| | :ref:`_request_code_completion<class_CodeEdit_private_method__request_code_completion>`\ (\ force\: :ref:`bool<class_bool>`\ ) |virtual| |
  77. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | |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>`\ ) |
  79. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | |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\ ) |
  81. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | |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\ ) |
  83. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | |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\ ) |
  85. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`bool<class_bool>` | :ref:`can_fold_line<class_CodeEdit_method_can_fold_line>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
  87. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | |void| | :ref:`cancel_code_completion<class_CodeEdit_method_cancel_code_completion>`\ (\ ) |
  89. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | |void| | :ref:`clear_bookmarked_lines<class_CodeEdit_method_clear_bookmarked_lines>`\ (\ ) |
  91. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | |void| | :ref:`clear_breakpointed_lines<class_CodeEdit_method_clear_breakpointed_lines>`\ (\ ) |
  93. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | |void| | :ref:`clear_comment_delimiters<class_CodeEdit_method_clear_comment_delimiters>`\ (\ ) |
  95. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | |void| | :ref:`clear_executing_lines<class_CodeEdit_method_clear_executing_lines>`\ (\ ) |
  97. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | |void| | :ref:`clear_string_delimiters<class_CodeEdit_method_clear_string_delimiters>`\ (\ ) |
  99. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | |void| | :ref:`confirm_code_completion<class_CodeEdit_method_confirm_code_completion>`\ (\ replace\: :ref:`bool<class_bool>` = false\ ) |
  101. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | |void| | :ref:`convert_indent<class_CodeEdit_method_convert_indent>`\ (\ from_line\: :ref:`int<class_int>` = -1, to_line\: :ref:`int<class_int>` = -1\ ) |
  103. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | |void| | :ref:`create_code_region<class_CodeEdit_method_create_code_region>`\ (\ ) |
  105. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | |void| | :ref:`delete_lines<class_CodeEdit_method_delete_lines>`\ (\ ) |
  107. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | |void| | :ref:`do_indent<class_CodeEdit_method_do_indent>`\ (\ ) |
  109. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | |void| | :ref:`duplicate_lines<class_CodeEdit_method_duplicate_lines>`\ (\ ) |
  111. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | |void| | :ref:`duplicate_selection<class_CodeEdit_method_duplicate_selection>`\ (\ ) |
  113. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | |void| | :ref:`fold_all_lines<class_CodeEdit_method_fold_all_lines>`\ (\ ) |
  115. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | |void| | :ref:`fold_line<class_CodeEdit_method_fold_line>`\ (\ line\: :ref:`int<class_int>`\ ) |
  117. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | :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| |
  119. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_bookmarked_lines<class_CodeEdit_method_get_bookmarked_lines>`\ (\ ) |const| |
  121. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_breakpointed_lines<class_CodeEdit_method_get_breakpointed_lines>`\ (\ ) |const| |
  123. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`Dictionary<class_Dictionary>` | :ref:`get_code_completion_option<class_CodeEdit_method_get_code_completion_option>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  125. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`get_code_completion_options<class_CodeEdit_method_get_code_completion_options>`\ (\ ) |const| |
  127. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`int<class_int>` | :ref:`get_code_completion_selected_index<class_CodeEdit_method_get_code_completion_selected_index>`\ (\ ) |const| |
  129. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`String<class_String>` | :ref:`get_code_region_end_tag<class_CodeEdit_method_get_code_region_end_tag>`\ (\ ) |const| |
  131. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`String<class_String>` | :ref:`get_code_region_start_tag<class_CodeEdit_method_get_code_region_start_tag>`\ (\ ) |const| |
  133. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`String<class_String>` | :ref:`get_delimiter_end_key<class_CodeEdit_method_get_delimiter_end_key>`\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| |
  135. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :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| |
  137. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`String<class_String>` | :ref:`get_delimiter_start_key<class_CodeEdit_method_get_delimiter_start_key>`\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| |
  139. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :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| |
  141. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`get_executing_lines<class_CodeEdit_method_get_executing_lines>`\ (\ ) |const| |
  143. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] | :ref:`get_folded_lines<class_CodeEdit_method_get_folded_lines>`\ (\ ) |const| |
  145. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | :ref:`String<class_String>` | :ref:`get_text_for_code_completion<class_CodeEdit_method_get_text_for_code_completion>`\ (\ ) |const| |
  147. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | :ref:`String<class_String>` | :ref:`get_text_for_symbol_lookup<class_CodeEdit_method_get_text_for_symbol_lookup>`\ (\ ) |const| |
  149. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | :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| |
  151. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | :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| |
  153. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | :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| |
  155. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | :ref:`bool<class_bool>` | :ref:`has_comment_delimiter<class_CodeEdit_method_has_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |const| |
  157. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | :ref:`bool<class_bool>` | :ref:`has_string_delimiter<class_CodeEdit_method_has_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |const| |
  159. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | |void| | :ref:`indent_lines<class_CodeEdit_method_indent_lines>`\ (\ ) |
  161. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | :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| |
  163. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | :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| |
  165. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | :ref:`bool<class_bool>` | :ref:`is_line_bookmarked<class_CodeEdit_method_is_line_bookmarked>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
  167. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | :ref:`bool<class_bool>` | :ref:`is_line_breakpointed<class_CodeEdit_method_is_line_breakpointed>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
  169. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | :ref:`bool<class_bool>` | :ref:`is_line_code_region_end<class_CodeEdit_method_is_line_code_region_end>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
  171. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | :ref:`bool<class_bool>` | :ref:`is_line_code_region_start<class_CodeEdit_method_is_line_code_region_start>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
  173. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | :ref:`bool<class_bool>` | :ref:`is_line_executing<class_CodeEdit_method_is_line_executing>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
  175. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | :ref:`bool<class_bool>` | :ref:`is_line_folded<class_CodeEdit_method_is_line_folded>`\ (\ line\: :ref:`int<class_int>`\ ) |const| |
  177. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | |void| | :ref:`move_lines_down<class_CodeEdit_method_move_lines_down>`\ (\ ) |
  179. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | |void| | :ref:`move_lines_up<class_CodeEdit_method_move_lines_up>`\ (\ ) |
  181. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | |void| | :ref:`remove_comment_delimiter<class_CodeEdit_method_remove_comment_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |
  183. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | |void| | :ref:`remove_string_delimiter<class_CodeEdit_method_remove_string_delimiter>`\ (\ start_key\: :ref:`String<class_String>`\ ) |
  185. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | |void| | :ref:`request_code_completion<class_CodeEdit_method_request_code_completion>`\ (\ force\: :ref:`bool<class_bool>` = false\ ) |
  187. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | |void| | :ref:`set_code_completion_selected_index<class_CodeEdit_method_set_code_completion_selected_index>`\ (\ index\: :ref:`int<class_int>`\ ) |
  189. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | |void| | :ref:`set_code_hint<class_CodeEdit_method_set_code_hint>`\ (\ code_hint\: :ref:`String<class_String>`\ ) |
  191. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | |void| | :ref:`set_code_hint_draw_below<class_CodeEdit_method_set_code_hint_draw_below>`\ (\ draw_below\: :ref:`bool<class_bool>`\ ) |
  193. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | |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"\ ) |
  195. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | |void| | :ref:`set_line_as_bookmarked<class_CodeEdit_method_set_line_as_bookmarked>`\ (\ line\: :ref:`int<class_int>`, bookmarked\: :ref:`bool<class_bool>`\ ) |
  197. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | |void| | :ref:`set_line_as_breakpoint<class_CodeEdit_method_set_line_as_breakpoint>`\ (\ line\: :ref:`int<class_int>`, breakpointed\: :ref:`bool<class_bool>`\ ) |
  199. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | |void| | :ref:`set_line_as_executing<class_CodeEdit_method_set_line_as_executing>`\ (\ line\: :ref:`int<class_int>`, executing\: :ref:`bool<class_bool>`\ ) |
  201. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | |void| | :ref:`set_symbol_lookup_word_as_valid<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`\ (\ valid\: :ref:`bool<class_bool>`\ ) |
  203. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | |void| | :ref:`toggle_foldable_line<class_CodeEdit_method_toggle_foldable_line>`\ (\ line\: :ref:`int<class_int>`\ ) |
  205. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | |void| | :ref:`toggle_foldable_lines_at_carets<class_CodeEdit_method_toggle_foldable_lines_at_carets>`\ (\ ) |
  207. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | |void| | :ref:`unfold_all_lines<class_CodeEdit_method_unfold_all_lines>`\ (\ ) |
  209. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | |void| | :ref:`unfold_line<class_CodeEdit_method_unfold_line>`\ (\ line\: :ref:`int<class_int>`\ ) |
  211. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | |void| | :ref:`unindent_lines<class_CodeEdit_method_unindent_lines>`\ (\ ) |
  213. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | |void| | :ref:`update_code_completion_options<class_CodeEdit_method_update_code_completion_options>`\ (\ force\: :ref:`bool<class_bool>`\ ) |
  215. +------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. .. rst-class:: classref-reftable-group
  217. Theme Properties
  218. ----------------
  219. .. table::
  220. :widths: auto
  221. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  222. | :ref:`Color<class_Color>` | :ref:`bookmark_color<class_CodeEdit_theme_color_bookmark_color>` | ``Color(0.5, 0.64, 1, 0.8)`` |
  223. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  224. | :ref:`Color<class_Color>` | :ref:`brace_mismatch_color<class_CodeEdit_theme_color_brace_mismatch_color>` | ``Color(1, 0.2, 0.2, 1)`` |
  225. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  226. | :ref:`Color<class_Color>` | :ref:`breakpoint_color<class_CodeEdit_theme_color_breakpoint_color>` | ``Color(0.9, 0.29, 0.3, 1)`` |
  227. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  228. | :ref:`Color<class_Color>` | :ref:`code_folding_color<class_CodeEdit_theme_color_code_folding_color>` | ``Color(0.8, 0.8, 0.8, 0.8)`` |
  229. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  230. | :ref:`Color<class_Color>` | :ref:`completion_background_color<class_CodeEdit_theme_color_completion_background_color>` | ``Color(0.17, 0.16, 0.2, 1)`` |
  231. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  232. | :ref:`Color<class_Color>` | :ref:`completion_existing_color<class_CodeEdit_theme_color_completion_existing_color>` | ``Color(0.87, 0.87, 0.87, 0.13)`` |
  233. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  234. | :ref:`Color<class_Color>` | :ref:`completion_scroll_color<class_CodeEdit_theme_color_completion_scroll_color>` | ``Color(1, 1, 1, 0.29)`` |
  235. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  236. | :ref:`Color<class_Color>` | :ref:`completion_scroll_hovered_color<class_CodeEdit_theme_color_completion_scroll_hovered_color>` | ``Color(1, 1, 1, 0.4)`` |
  237. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  238. | :ref:`Color<class_Color>` | :ref:`completion_selected_color<class_CodeEdit_theme_color_completion_selected_color>` | ``Color(0.26, 0.26, 0.27, 1)`` |
  239. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  240. | :ref:`Color<class_Color>` | :ref:`executing_line_color<class_CodeEdit_theme_color_executing_line_color>` | ``Color(0.98, 0.89, 0.27, 1)`` |
  241. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  242. | :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)`` |
  243. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  244. | :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)`` |
  245. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  246. | :ref:`Color<class_Color>` | :ref:`line_number_color<class_CodeEdit_theme_color_line_number_color>` | ``Color(0.67, 0.67, 0.67, 0.4)`` |
  247. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  248. | :ref:`int<class_int>` | :ref:`completion_lines<class_CodeEdit_theme_constant_completion_lines>` | ``7`` |
  249. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  250. | :ref:`int<class_int>` | :ref:`completion_max_width<class_CodeEdit_theme_constant_completion_max_width>` | ``50`` |
  251. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  252. | :ref:`int<class_int>` | :ref:`completion_scroll_width<class_CodeEdit_theme_constant_completion_scroll_width>` | ``6`` |
  253. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  254. | :ref:`Texture2D<class_Texture2D>` | :ref:`bookmark<class_CodeEdit_theme_icon_bookmark>` | |
  255. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  256. | :ref:`Texture2D<class_Texture2D>` | :ref:`breakpoint<class_CodeEdit_theme_icon_breakpoint>` | |
  257. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  258. | :ref:`Texture2D<class_Texture2D>` | :ref:`can_fold<class_CodeEdit_theme_icon_can_fold>` | |
  259. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  260. | :ref:`Texture2D<class_Texture2D>` | :ref:`can_fold_code_region<class_CodeEdit_theme_icon_can_fold_code_region>` | |
  261. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  262. | :ref:`Texture2D<class_Texture2D>` | :ref:`completion_color_bg<class_CodeEdit_theme_icon_completion_color_bg>` | |
  263. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  264. | :ref:`Texture2D<class_Texture2D>` | :ref:`executing_line<class_CodeEdit_theme_icon_executing_line>` | |
  265. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  266. | :ref:`Texture2D<class_Texture2D>` | :ref:`folded<class_CodeEdit_theme_icon_folded>` | |
  267. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  268. | :ref:`Texture2D<class_Texture2D>` | :ref:`folded_code_region<class_CodeEdit_theme_icon_folded_code_region>` | |
  269. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  270. | :ref:`Texture2D<class_Texture2D>` | :ref:`folded_eol_icon<class_CodeEdit_theme_icon_folded_eol_icon>` | |
  271. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  272. | :ref:`StyleBox<class_StyleBox>` | :ref:`completion<class_CodeEdit_theme_style_completion>` | |
  273. +-----------------------------------+----------------------------------------------------------------------------------------------------+-----------------------------------+
  274. .. rst-class:: classref-section-separator
  275. ----
  276. .. rst-class:: classref-descriptions-group
  277. Signals
  278. -------
  279. .. _class_CodeEdit_signal_breakpoint_toggled:
  280. .. rst-class:: classref-signal
  281. **breakpoint_toggled**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_breakpoint_toggled>`
  282. Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line.
  283. .. rst-class:: classref-item-separator
  284. ----
  285. .. _class_CodeEdit_signal_code_completion_requested:
  286. .. rst-class:: classref-signal
  287. **code_completion_requested**\ (\ ) :ref:`🔗<class_CodeEdit_signal_code_completion_requested>`
  288. Emitted when the user requests code completion.
  289. .. rst-class:: classref-item-separator
  290. ----
  291. .. _class_CodeEdit_signal_symbol_lookup:
  292. .. rst-class:: classref-signal
  293. **symbol_lookup**\ (\ symbol\: :ref:`String<class_String>`, line\: :ref:`int<class_int>`, column\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_lookup>`
  294. Emitted when the user has clicked on a valid symbol.
  295. .. rst-class:: classref-item-separator
  296. ----
  297. .. _class_CodeEdit_signal_symbol_validate:
  298. .. rst-class:: classref-signal
  299. **symbol_validate**\ (\ symbol\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_signal_symbol_validate>`
  300. Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling :ref:`set_symbol_lookup_word_as_valid<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`.
  301. .. rst-class:: classref-section-separator
  302. ----
  303. .. rst-class:: classref-descriptions-group
  304. Enumerations
  305. ------------
  306. .. _enum_CodeEdit_CodeCompletionKind:
  307. .. rst-class:: classref-enumeration
  308. enum **CodeCompletionKind**: :ref:`🔗<enum_CodeEdit_CodeCompletionKind>`
  309. .. _class_CodeEdit_constant_KIND_CLASS:
  310. .. rst-class:: classref-enumeration-constant
  311. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CLASS** = ``0``
  312. Marks the option as a class.
  313. .. _class_CodeEdit_constant_KIND_FUNCTION:
  314. .. rst-class:: classref-enumeration-constant
  315. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FUNCTION** = ``1``
  316. Marks the option as a function.
  317. .. _class_CodeEdit_constant_KIND_SIGNAL:
  318. .. rst-class:: classref-enumeration-constant
  319. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_SIGNAL** = ``2``
  320. Marks the option as a Godot signal.
  321. .. _class_CodeEdit_constant_KIND_VARIABLE:
  322. .. rst-class:: classref-enumeration-constant
  323. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_VARIABLE** = ``3``
  324. Marks the option as a variable.
  325. .. _class_CodeEdit_constant_KIND_MEMBER:
  326. .. rst-class:: classref-enumeration-constant
  327. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_MEMBER** = ``4``
  328. Marks the option as a member.
  329. .. _class_CodeEdit_constant_KIND_ENUM:
  330. .. rst-class:: classref-enumeration-constant
  331. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_ENUM** = ``5``
  332. Marks the option as an enum entry.
  333. .. _class_CodeEdit_constant_KIND_CONSTANT:
  334. .. rst-class:: classref-enumeration-constant
  335. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_CONSTANT** = ``6``
  336. Marks the option as a constant.
  337. .. _class_CodeEdit_constant_KIND_NODE_PATH:
  338. .. rst-class:: classref-enumeration-constant
  339. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_NODE_PATH** = ``7``
  340. Marks the option as a Godot node path.
  341. .. _class_CodeEdit_constant_KIND_FILE_PATH:
  342. .. rst-class:: classref-enumeration-constant
  343. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_FILE_PATH** = ``8``
  344. Marks the option as a file path.
  345. .. _class_CodeEdit_constant_KIND_PLAIN_TEXT:
  346. .. rst-class:: classref-enumeration-constant
  347. :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>` **KIND_PLAIN_TEXT** = ``9``
  348. Marks the option as unclassified or plain text.
  349. .. rst-class:: classref-item-separator
  350. ----
  351. .. _enum_CodeEdit_CodeCompletionLocation:
  352. .. rst-class:: classref-enumeration
  353. enum **CodeCompletionLocation**: :ref:`🔗<enum_CodeEdit_CodeCompletionLocation>`
  354. .. _class_CodeEdit_constant_LOCATION_LOCAL:
  355. .. rst-class:: classref-enumeration-constant
  356. :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_LOCAL** = ``0``
  357. The option is local to the location of the code completion query - e.g. a local variable. Subsequent value of location represent options from the outer class, the exact value represent how far they are (in terms of inner classes).
  358. .. _class_CodeEdit_constant_LOCATION_PARENT_MASK:
  359. .. rst-class:: classref-enumeration-constant
  360. :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_PARENT_MASK** = ``256``
  361. The option is from the containing class or a parent class, relative to the location of the code completion query. Perform a bitwise OR with the class depth (e.g. ``0`` for the local class, ``1`` for the parent, ``2`` for the grandparent, etc.) to store the depth of an option in the class or a parent class.
  362. .. _class_CodeEdit_constant_LOCATION_OTHER_USER_CODE:
  363. .. rst-class:: classref-enumeration-constant
  364. :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER_USER_CODE** = ``512``
  365. The option is from user code which is not local and not in a derived class (e.g. Autoload Singletons).
  366. .. _class_CodeEdit_constant_LOCATION_OTHER:
  367. .. rst-class:: classref-enumeration-constant
  368. :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` **LOCATION_OTHER** = ``1024``
  369. The option is from other engine code, not covered by the other enum constants - e.g. built-in classes.
  370. .. rst-class:: classref-section-separator
  371. ----
  372. .. rst-class:: classref-descriptions-group
  373. Property Descriptions
  374. ---------------------
  375. .. _class_CodeEdit_property_auto_brace_completion_enabled:
  376. .. rst-class:: classref-property
  377. :ref:`bool<class_bool>` **auto_brace_completion_enabled** = ``false`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_enabled>`
  378. .. rst-class:: classref-property-setget
  379. - |void| **set_auto_brace_completion_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  380. - :ref:`bool<class_bool>` **is_auto_brace_completion_enabled**\ (\ )
  381. Sets whether brace pairs should be autocompleted.
  382. .. rst-class:: classref-item-separator
  383. ----
  384. .. _class_CodeEdit_property_auto_brace_completion_highlight_matching:
  385. .. rst-class:: classref-property
  386. :ref:`bool<class_bool>` **auto_brace_completion_highlight_matching** = ``false`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_highlight_matching>`
  387. .. rst-class:: classref-property-setget
  388. - |void| **set_highlight_matching_braces_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  389. - :ref:`bool<class_bool>` **is_highlight_matching_braces_enabled**\ (\ )
  390. Highlight mismatching brace pairs.
  391. .. rst-class:: classref-item-separator
  392. ----
  393. .. _class_CodeEdit_property_auto_brace_completion_pairs:
  394. .. rst-class:: classref-property
  395. :ref:`Dictionary<class_Dictionary>` **auto_brace_completion_pairs** = ``{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }`` :ref:`🔗<class_CodeEdit_property_auto_brace_completion_pairs>`
  396. .. rst-class:: classref-property-setget
  397. - |void| **set_auto_brace_completion_pairs**\ (\ value\: :ref:`Dictionary<class_Dictionary>`\ )
  398. - :ref:`Dictionary<class_Dictionary>` **get_auto_brace_completion_pairs**\ (\ )
  399. Sets the brace pairs to be autocompleted.
  400. .. rst-class:: classref-item-separator
  401. ----
  402. .. _class_CodeEdit_property_code_completion_enabled:
  403. .. rst-class:: classref-property
  404. :ref:`bool<class_bool>` **code_completion_enabled** = ``false`` :ref:`🔗<class_CodeEdit_property_code_completion_enabled>`
  405. .. rst-class:: classref-property-setget
  406. - |void| **set_code_completion_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  407. - :ref:`bool<class_bool>` **is_code_completion_enabled**\ (\ )
  408. Sets whether code completion is allowed.
  409. .. rst-class:: classref-item-separator
  410. ----
  411. .. _class_CodeEdit_property_code_completion_prefixes:
  412. .. rst-class:: classref-property
  413. :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **code_completion_prefixes** = ``[]`` :ref:`🔗<class_CodeEdit_property_code_completion_prefixes>`
  414. .. rst-class:: classref-property-setget
  415. - |void| **set_code_completion_prefixes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
  416. - :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_code_completion_prefixes**\ (\ )
  417. Sets prefixes that will trigger code completion.
  418. .. rst-class:: classref-item-separator
  419. ----
  420. .. _class_CodeEdit_property_delimiter_comments:
  421. .. rst-class:: classref-property
  422. :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **delimiter_comments** = ``[]`` :ref:`🔗<class_CodeEdit_property_delimiter_comments>`
  423. .. rst-class:: classref-property-setget
  424. - |void| **set_comment_delimiters**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
  425. - :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_comment_delimiters**\ (\ )
  426. Sets the comment delimiters. All existing comment delimiters will be removed.
  427. .. rst-class:: classref-item-separator
  428. ----
  429. .. _class_CodeEdit_property_delimiter_strings:
  430. .. rst-class:: classref-property
  431. :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **delimiter_strings** = ``["' '", "\" \""]`` :ref:`🔗<class_CodeEdit_property_delimiter_strings>`
  432. .. rst-class:: classref-property-setget
  433. - |void| **set_string_delimiters**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
  434. - :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_string_delimiters**\ (\ )
  435. Sets the string delimiters. All existing string delimiters will be removed.
  436. .. rst-class:: classref-item-separator
  437. ----
  438. .. _class_CodeEdit_property_gutters_draw_bookmarks:
  439. .. rst-class:: classref-property
  440. :ref:`bool<class_bool>` **gutters_draw_bookmarks** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_bookmarks>`
  441. .. rst-class:: classref-property-setget
  442. - |void| **set_draw_bookmarks_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
  443. - :ref:`bool<class_bool>` **is_drawing_bookmarks_gutter**\ (\ )
  444. Sets if bookmarked should be drawn in the gutter. This gutter is shared with breakpoints and executing lines.
  445. .. rst-class:: classref-item-separator
  446. ----
  447. .. _class_CodeEdit_property_gutters_draw_breakpoints_gutter:
  448. .. rst-class:: classref-property
  449. :ref:`bool<class_bool>` **gutters_draw_breakpoints_gutter** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_breakpoints_gutter>`
  450. .. rst-class:: classref-property-setget
  451. - |void| **set_draw_breakpoints_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
  452. - :ref:`bool<class_bool>` **is_drawing_breakpoints_gutter**\ (\ )
  453. Sets if breakpoints should be drawn in the gutter. This gutter is shared with bookmarks and executing lines.
  454. .. rst-class:: classref-item-separator
  455. ----
  456. .. _class_CodeEdit_property_gutters_draw_executing_lines:
  457. .. rst-class:: classref-property
  458. :ref:`bool<class_bool>` **gutters_draw_executing_lines** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_executing_lines>`
  459. .. rst-class:: classref-property-setget
  460. - |void| **set_draw_executing_lines_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
  461. - :ref:`bool<class_bool>` **is_drawing_executing_lines_gutter**\ (\ )
  462. Sets if executing lines should be marked in the gutter. This gutter is shared with breakpoints and bookmarks lines.
  463. .. rst-class:: classref-item-separator
  464. ----
  465. .. _class_CodeEdit_property_gutters_draw_fold_gutter:
  466. .. rst-class:: classref-property
  467. :ref:`bool<class_bool>` **gutters_draw_fold_gutter** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_fold_gutter>`
  468. .. rst-class:: classref-property-setget
  469. - |void| **set_draw_fold_gutter**\ (\ value\: :ref:`bool<class_bool>`\ )
  470. - :ref:`bool<class_bool>` **is_drawing_fold_gutter**\ (\ )
  471. Sets if foldable lines icons should be drawn in the gutter.
  472. .. rst-class:: classref-item-separator
  473. ----
  474. .. _class_CodeEdit_property_gutters_draw_line_numbers:
  475. .. rst-class:: classref-property
  476. :ref:`bool<class_bool>` **gutters_draw_line_numbers** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_draw_line_numbers>`
  477. .. rst-class:: classref-property-setget
  478. - |void| **set_draw_line_numbers**\ (\ value\: :ref:`bool<class_bool>`\ )
  479. - :ref:`bool<class_bool>` **is_draw_line_numbers_enabled**\ (\ )
  480. Sets if line numbers should be drawn in the gutter.
  481. .. rst-class:: classref-item-separator
  482. ----
  483. .. _class_CodeEdit_property_gutters_zero_pad_line_numbers:
  484. .. rst-class:: classref-property
  485. :ref:`bool<class_bool>` **gutters_zero_pad_line_numbers** = ``false`` :ref:`🔗<class_CodeEdit_property_gutters_zero_pad_line_numbers>`
  486. .. rst-class:: classref-property-setget
  487. - |void| **set_line_numbers_zero_padded**\ (\ value\: :ref:`bool<class_bool>`\ )
  488. - :ref:`bool<class_bool>` **is_line_numbers_zero_padded**\ (\ )
  489. Sets if line numbers drawn in the gutter are zero padded.
  490. .. rst-class:: classref-item-separator
  491. ----
  492. .. _class_CodeEdit_property_indent_automatic:
  493. .. rst-class:: classref-property
  494. :ref:`bool<class_bool>` **indent_automatic** = ``false`` :ref:`🔗<class_CodeEdit_property_indent_automatic>`
  495. .. rst-class:: classref-property-setget
  496. - |void| **set_auto_indent_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  497. - :ref:`bool<class_bool>` **is_auto_indent_enabled**\ (\ )
  498. Sets whether automatic indent are enabled, this will add an extra indent if a prefix or brace is found.
  499. .. rst-class:: classref-item-separator
  500. ----
  501. .. _class_CodeEdit_property_indent_automatic_prefixes:
  502. .. rst-class:: classref-property
  503. :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **indent_automatic_prefixes** = ``[":", "{", "[", "("]`` :ref:`🔗<class_CodeEdit_property_indent_automatic_prefixes>`
  504. .. rst-class:: classref-property-setget
  505. - |void| **set_auto_indent_prefixes**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`String<class_String>`\]\ )
  506. - :ref:`Array<class_Array>`\[:ref:`String<class_String>`\] **get_auto_indent_prefixes**\ (\ )
  507. Prefixes to trigger an automatic indent.
  508. .. rst-class:: classref-item-separator
  509. ----
  510. .. _class_CodeEdit_property_indent_size:
  511. .. rst-class:: classref-property
  512. :ref:`int<class_int>` **indent_size** = ``4`` :ref:`🔗<class_CodeEdit_property_indent_size>`
  513. .. rst-class:: classref-property-setget
  514. - |void| **set_indent_size**\ (\ value\: :ref:`int<class_int>`\ )
  515. - :ref:`int<class_int>` **get_indent_size**\ (\ )
  516. 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.
  517. .. rst-class:: classref-item-separator
  518. ----
  519. .. _class_CodeEdit_property_indent_use_spaces:
  520. .. rst-class:: classref-property
  521. :ref:`bool<class_bool>` **indent_use_spaces** = ``false`` :ref:`🔗<class_CodeEdit_property_indent_use_spaces>`
  522. .. rst-class:: classref-property-setget
  523. - |void| **set_indent_using_spaces**\ (\ value\: :ref:`bool<class_bool>`\ )
  524. - :ref:`bool<class_bool>` **is_indent_using_spaces**\ (\ )
  525. Use spaces instead of tabs for indentation.
  526. .. rst-class:: classref-item-separator
  527. ----
  528. .. _class_CodeEdit_property_line_folding:
  529. .. rst-class:: classref-property
  530. :ref:`bool<class_bool>` **line_folding** = ``false`` :ref:`🔗<class_CodeEdit_property_line_folding>`
  531. .. rst-class:: classref-property-setget
  532. - |void| **set_line_folding_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  533. - :ref:`bool<class_bool>` **is_line_folding_enabled**\ (\ )
  534. Sets whether line folding is allowed.
  535. .. rst-class:: classref-item-separator
  536. ----
  537. .. _class_CodeEdit_property_line_length_guidelines:
  538. .. rst-class:: classref-property
  539. :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **line_length_guidelines** = ``[]`` :ref:`🔗<class_CodeEdit_property_line_length_guidelines>`
  540. .. rst-class:: classref-property-setget
  541. - |void| **set_line_length_guidelines**\ (\ value\: :ref:`Array<class_Array>`\[:ref:`int<class_int>`\]\ )
  542. - :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **get_line_length_guidelines**\ (\ )
  543. Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently.
  544. .. rst-class:: classref-item-separator
  545. ----
  546. .. _class_CodeEdit_property_symbol_lookup_on_click:
  547. .. rst-class:: classref-property
  548. :ref:`bool<class_bool>` **symbol_lookup_on_click** = ``false`` :ref:`🔗<class_CodeEdit_property_symbol_lookup_on_click>`
  549. .. rst-class:: classref-property-setget
  550. - |void| **set_symbol_lookup_on_click_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
  551. - :ref:`bool<class_bool>` **is_symbol_lookup_on_click_enabled**\ (\ )
  552. 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.
  553. .. rst-class:: classref-section-separator
  554. ----
  555. .. rst-class:: classref-descriptions-group
  556. Method Descriptions
  557. -------------------
  558. .. _class_CodeEdit_private_method__confirm_code_completion:
  559. .. rst-class:: classref-method
  560. |void| **_confirm_code_completion**\ (\ replace\: :ref:`bool<class_bool>`\ ) |virtual| :ref:`🔗<class_CodeEdit_private_method__confirm_code_completion>`
  561. Override this method to define how the selected entry should be inserted. If ``replace`` is ``true``, any existing text should be replaced.
  562. .. rst-class:: classref-item-separator
  563. ----
  564. .. _class_CodeEdit_private_method__filter_code_completion_candidates:
  565. .. rst-class:: classref-method
  566. :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>`
  567. Override this method to define what items in ``candidates`` should be displayed.
  568. Both ``candidates`` and the return is a :ref:`Array<class_Array>` of :ref:`Dictionary<class_Dictionary>`, see :ref:`get_code_completion_option<class_CodeEdit_method_get_code_completion_option>` for :ref:`Dictionary<class_Dictionary>` content.
  569. .. rst-class:: classref-item-separator
  570. ----
  571. .. _class_CodeEdit_private_method__request_code_completion:
  572. .. rst-class:: classref-method
  573. |void| **_request_code_completion**\ (\ force\: :ref:`bool<class_bool>`\ ) |virtual| :ref:`🔗<class_CodeEdit_private_method__request_code_completion>`
  574. Override this method to define what happens when the user requests code completion. If ``force`` is ``true``, any checks should be bypassed.
  575. .. rst-class:: classref-item-separator
  576. ----
  577. .. _class_CodeEdit_method_add_auto_brace_completion_pair:
  578. .. rst-class:: classref-method
  579. |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>`
  580. Adds a brace pair.
  581. Both the start and end keys must be symbols. Only the start key has to be unique.
  582. .. rst-class:: classref-item-separator
  583. ----
  584. .. _class_CodeEdit_method_add_code_completion_option:
  585. .. rst-class:: classref-method
  586. |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>`
  587. Submits an item to the queue of potential candidates for the autocomplete menu. Call :ref:`update_code_completion_options<class_CodeEdit_method_update_code_completion_options>` to update the list.
  588. \ ``location`` indicates location of the option relative to the location of the code completion query. See :ref:`CodeCompletionLocation<enum_CodeEdit_CodeCompletionLocation>` for how to set this value.
  589. \ **Note:** This list will replace all current candidates.
  590. .. rst-class:: classref-item-separator
  591. ----
  592. .. _class_CodeEdit_method_add_comment_delimiter:
  593. .. rst-class:: classref-method
  594. |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>`
  595. 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.
  596. 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.
  597. .. rst-class:: classref-item-separator
  598. ----
  599. .. _class_CodeEdit_method_add_string_delimiter:
  600. .. rst-class:: classref-method
  601. |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>`
  602. 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.
  603. 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.
  604. .. rst-class:: classref-item-separator
  605. ----
  606. .. _class_CodeEdit_method_can_fold_line:
  607. .. rst-class:: classref-method
  608. :ref:`bool<class_bool>` **can_fold_line**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_can_fold_line>`
  609. Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block.
  610. .. rst-class:: classref-item-separator
  611. ----
  612. .. _class_CodeEdit_method_cancel_code_completion:
  613. .. rst-class:: classref-method
  614. |void| **cancel_code_completion**\ (\ ) :ref:`🔗<class_CodeEdit_method_cancel_code_completion>`
  615. Cancels the autocomplete menu.
  616. .. rst-class:: classref-item-separator
  617. ----
  618. .. _class_CodeEdit_method_clear_bookmarked_lines:
  619. .. rst-class:: classref-method
  620. |void| **clear_bookmarked_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_bookmarked_lines>`
  621. Clears all bookmarked lines.
  622. .. rst-class:: classref-item-separator
  623. ----
  624. .. _class_CodeEdit_method_clear_breakpointed_lines:
  625. .. rst-class:: classref-method
  626. |void| **clear_breakpointed_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_breakpointed_lines>`
  627. Clears all breakpointed lines.
  628. .. rst-class:: classref-item-separator
  629. ----
  630. .. _class_CodeEdit_method_clear_comment_delimiters:
  631. .. rst-class:: classref-method
  632. |void| **clear_comment_delimiters**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_comment_delimiters>`
  633. Removes all comment delimiters.
  634. .. rst-class:: classref-item-separator
  635. ----
  636. .. _class_CodeEdit_method_clear_executing_lines:
  637. .. rst-class:: classref-method
  638. |void| **clear_executing_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_executing_lines>`
  639. Clears all executed lines.
  640. .. rst-class:: classref-item-separator
  641. ----
  642. .. _class_CodeEdit_method_clear_string_delimiters:
  643. .. rst-class:: classref-method
  644. |void| **clear_string_delimiters**\ (\ ) :ref:`🔗<class_CodeEdit_method_clear_string_delimiters>`
  645. Removes all string delimiters.
  646. .. rst-class:: classref-item-separator
  647. ----
  648. .. _class_CodeEdit_method_confirm_code_completion:
  649. .. rst-class:: classref-method
  650. |void| **confirm_code_completion**\ (\ replace\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_confirm_code_completion>`
  651. Inserts the selected entry into the text. If ``replace`` is ``true``, any existing text is replaced rather than merged.
  652. .. rst-class:: classref-item-separator
  653. ----
  654. .. _class_CodeEdit_method_convert_indent:
  655. .. rst-class:: classref-method
  656. |void| **convert_indent**\ (\ from_line\: :ref:`int<class_int>` = -1, to_line\: :ref:`int<class_int>` = -1\ ) :ref:`🔗<class_CodeEdit_method_convert_indent>`
  657. Converts the indents of lines between ``from_line`` and ``to_line`` to tabs or spaces as set by :ref:`indent_use_spaces<class_CodeEdit_property_indent_use_spaces>`.
  658. Values of ``-1`` convert the entire text.
  659. .. rst-class:: classref-item-separator
  660. ----
  661. .. _class_CodeEdit_method_create_code_region:
  662. .. rst-class:: classref-method
  663. |void| **create_code_region**\ (\ ) :ref:`🔗<class_CodeEdit_method_create_code_region>`
  664. 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>`).
  665. A code region is a part of code that is highlighted when folded and can help organize your script.
  666. Code region start and end tags can be customized (see :ref:`set_code_region_tags<class_CodeEdit_method_set_code_region_tags>`).
  667. 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``)
  668. .. rst-class:: classref-item-separator
  669. ----
  670. .. _class_CodeEdit_method_delete_lines:
  671. .. rst-class:: classref-method
  672. |void| **delete_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_delete_lines>`
  673. Deletes all lines that are selected or have a caret on them.
  674. .. rst-class:: classref-item-separator
  675. ----
  676. .. _class_CodeEdit_method_do_indent:
  677. .. rst-class:: classref-method
  678. |void| **do_indent**\ (\ ) :ref:`🔗<class_CodeEdit_method_do_indent>`
  679. Perform an indent as if the user activated the "ui_text_indent" action.
  680. .. rst-class:: classref-item-separator
  681. ----
  682. .. _class_CodeEdit_method_duplicate_lines:
  683. .. rst-class:: classref-method
  684. |void| **duplicate_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_duplicate_lines>`
  685. Duplicates all lines currently selected with any caret. Duplicates the entire line beneath the current one no matter where the caret is within the line.
  686. .. rst-class:: classref-item-separator
  687. ----
  688. .. _class_CodeEdit_method_duplicate_selection:
  689. .. rst-class:: classref-method
  690. |void| **duplicate_selection**\ (\ ) :ref:`🔗<class_CodeEdit_method_duplicate_selection>`
  691. Duplicates all selected text and duplicates all lines with a caret on them.
  692. .. rst-class:: classref-item-separator
  693. ----
  694. .. _class_CodeEdit_method_fold_all_lines:
  695. .. rst-class:: classref-method
  696. |void| **fold_all_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_fold_all_lines>`
  697. Folds all lines that are possible to be folded (see :ref:`can_fold_line<class_CodeEdit_method_can_fold_line>`).
  698. .. rst-class:: classref-item-separator
  699. ----
  700. .. _class_CodeEdit_method_fold_line:
  701. .. rst-class:: classref-method
  702. |void| **fold_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_fold_line>`
  703. Folds the given line, if possible (see :ref:`can_fold_line<class_CodeEdit_method_can_fold_line>`).
  704. .. rst-class:: classref-item-separator
  705. ----
  706. .. _class_CodeEdit_method_get_auto_brace_completion_close_key:
  707. .. rst-class:: classref-method
  708. :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>`
  709. Gets the matching auto brace close key for ``open_key``.
  710. .. rst-class:: classref-item-separator
  711. ----
  712. .. _class_CodeEdit_method_get_bookmarked_lines:
  713. .. rst-class:: classref-method
  714. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_bookmarked_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_bookmarked_lines>`
  715. Gets all bookmarked lines.
  716. .. rst-class:: classref-item-separator
  717. ----
  718. .. _class_CodeEdit_method_get_breakpointed_lines:
  719. .. rst-class:: classref-method
  720. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_breakpointed_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_breakpointed_lines>`
  721. Gets all breakpointed lines.
  722. .. rst-class:: classref-item-separator
  723. ----
  724. .. _class_CodeEdit_method_get_code_completion_option:
  725. .. rst-class:: classref-method
  726. :ref:`Dictionary<class_Dictionary>` **get_code_completion_option**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_option>`
  727. Gets the completion option at ``index``. The return :ref:`Dictionary<class_Dictionary>` has the following key-values:
  728. \ ``kind``: :ref:`CodeCompletionKind<enum_CodeEdit_CodeCompletionKind>`\
  729. \ ``display_text``: Text that is shown on the autocomplete menu.
  730. \ ``insert_text``: Text that is to be inserted when this item is selected.
  731. \ ``font_color``: Color of the text on the autocomplete menu.
  732. \ ``icon``: Icon to draw on the autocomplete menu.
  733. \ ``default_value``: Value of the symbol.
  734. .. rst-class:: classref-item-separator
  735. ----
  736. .. _class_CodeEdit_method_get_code_completion_options:
  737. .. rst-class:: classref-method
  738. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **get_code_completion_options**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_options>`
  739. Gets all completion options, see :ref:`get_code_completion_option<class_CodeEdit_method_get_code_completion_option>` for return content.
  740. .. rst-class:: classref-item-separator
  741. ----
  742. .. _class_CodeEdit_method_get_code_completion_selected_index:
  743. .. rst-class:: classref-method
  744. :ref:`int<class_int>` **get_code_completion_selected_index**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_completion_selected_index>`
  745. Gets the index of the current selected completion option.
  746. .. rst-class:: classref-item-separator
  747. ----
  748. .. _class_CodeEdit_method_get_code_region_end_tag:
  749. .. rst-class:: classref-method
  750. :ref:`String<class_String>` **get_code_region_end_tag**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_region_end_tag>`
  751. Returns the code region end tag (without comment delimiter).
  752. .. rst-class:: classref-item-separator
  753. ----
  754. .. _class_CodeEdit_method_get_code_region_start_tag:
  755. .. rst-class:: classref-method
  756. :ref:`String<class_String>` **get_code_region_start_tag**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_code_region_start_tag>`
  757. Returns the code region start tag (without comment delimiter).
  758. .. rst-class:: classref-item-separator
  759. ----
  760. .. _class_CodeEdit_method_get_delimiter_end_key:
  761. .. rst-class:: classref-method
  762. :ref:`String<class_String>` **get_delimiter_end_key**\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_end_key>`
  763. Gets the end key for a string or comment region index.
  764. .. rst-class:: classref-item-separator
  765. ----
  766. .. _class_CodeEdit_method_get_delimiter_end_position:
  767. .. rst-class:: classref-method
  768. :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>`
  769. 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``.
  770. .. rst-class:: classref-item-separator
  771. ----
  772. .. _class_CodeEdit_method_get_delimiter_start_key:
  773. .. rst-class:: classref-method
  774. :ref:`String<class_String>` **get_delimiter_start_key**\ (\ delimiter_index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_get_delimiter_start_key>`
  775. Gets the start key for a string or comment region index.
  776. .. rst-class:: classref-item-separator
  777. ----
  778. .. _class_CodeEdit_method_get_delimiter_start_position:
  779. .. rst-class:: classref-method
  780. :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>`
  781. If ``line`` ``column`` is in a string or comment, returns the start position of the region. If not or no start could be found, both :ref:`Vector2<class_Vector2>` values will be ``-1``.
  782. .. rst-class:: classref-item-separator
  783. ----
  784. .. _class_CodeEdit_method_get_executing_lines:
  785. .. rst-class:: classref-method
  786. :ref:`PackedInt32Array<class_PackedInt32Array>` **get_executing_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_executing_lines>`
  787. Gets all executing lines.
  788. .. rst-class:: classref-item-separator
  789. ----
  790. .. _class_CodeEdit_method_get_folded_lines:
  791. .. rst-class:: classref-method
  792. :ref:`Array<class_Array>`\[:ref:`int<class_int>`\] **get_folded_lines**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_folded_lines>`
  793. Returns all lines that are current folded.
  794. .. rst-class:: classref-item-separator
  795. ----
  796. .. _class_CodeEdit_method_get_text_for_code_completion:
  797. .. rst-class:: classref-method
  798. :ref:`String<class_String>` **get_text_for_code_completion**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_for_code_completion>`
  799. Returns the full text with char ``0xFFFF`` at the caret location.
  800. .. rst-class:: classref-item-separator
  801. ----
  802. .. _class_CodeEdit_method_get_text_for_symbol_lookup:
  803. .. rst-class:: classref-method
  804. :ref:`String<class_String>` **get_text_for_symbol_lookup**\ (\ ) |const| :ref:`🔗<class_CodeEdit_method_get_text_for_symbol_lookup>`
  805. Returns the full text with char ``0xFFFF`` at the cursor location.
  806. .. rst-class:: classref-item-separator
  807. ----
  808. .. _class_CodeEdit_method_get_text_with_cursor_char:
  809. .. rst-class:: classref-method
  810. :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>`
  811. Returns the full text with char ``0xFFFF`` at the specified location.
  812. .. rst-class:: classref-item-separator
  813. ----
  814. .. _class_CodeEdit_method_has_auto_brace_completion_close_key:
  815. .. rst-class:: classref-method
  816. :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>`
  817. Returns ``true`` if close key ``close_key`` exists.
  818. .. rst-class:: classref-item-separator
  819. ----
  820. .. _class_CodeEdit_method_has_auto_brace_completion_open_key:
  821. .. rst-class:: classref-method
  822. :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>`
  823. Returns ``true`` if open key ``open_key`` exists.
  824. .. rst-class:: classref-item-separator
  825. ----
  826. .. _class_CodeEdit_method_has_comment_delimiter:
  827. .. rst-class:: classref-method
  828. :ref:`bool<class_bool>` **has_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_comment_delimiter>`
  829. Returns ``true`` if comment ``start_key`` exists.
  830. .. rst-class:: classref-item-separator
  831. ----
  832. .. _class_CodeEdit_method_has_string_delimiter:
  833. .. rst-class:: classref-method
  834. :ref:`bool<class_bool>` **has_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_CodeEdit_method_has_string_delimiter>`
  835. Returns ``true`` if string ``start_key`` exists.
  836. .. rst-class:: classref-item-separator
  837. ----
  838. .. _class_CodeEdit_method_indent_lines:
  839. .. rst-class:: classref-method
  840. |void| **indent_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_indent_lines>`
  841. Indents selected lines, or in the case of no selection the caret line by one.
  842. .. rst-class:: classref-item-separator
  843. ----
  844. .. _class_CodeEdit_method_is_in_comment:
  845. .. rst-class:: classref-method
  846. :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>`
  847. 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``.
  848. .. rst-class:: classref-item-separator
  849. ----
  850. .. _class_CodeEdit_method_is_in_string:
  851. .. rst-class:: classref-method
  852. :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>`
  853. 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``.
  854. .. rst-class:: classref-item-separator
  855. ----
  856. .. _class_CodeEdit_method_is_line_bookmarked:
  857. .. rst-class:: classref-method
  858. :ref:`bool<class_bool>` **is_line_bookmarked**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_bookmarked>`
  859. Returns whether the line at the specified index is bookmarked or not.
  860. .. rst-class:: classref-item-separator
  861. ----
  862. .. _class_CodeEdit_method_is_line_breakpointed:
  863. .. rst-class:: classref-method
  864. :ref:`bool<class_bool>` **is_line_breakpointed**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_breakpointed>`
  865. Returns whether the line at the specified index is breakpointed or not.
  866. .. rst-class:: classref-item-separator
  867. ----
  868. .. _class_CodeEdit_method_is_line_code_region_end:
  869. .. rst-class:: classref-method
  870. :ref:`bool<class_bool>` **is_line_code_region_end**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_code_region_end>`
  871. Returns whether the line at the specified index is a code region end.
  872. .. rst-class:: classref-item-separator
  873. ----
  874. .. _class_CodeEdit_method_is_line_code_region_start:
  875. .. rst-class:: classref-method
  876. :ref:`bool<class_bool>` **is_line_code_region_start**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_code_region_start>`
  877. Returns whether the line at the specified index is a code region start.
  878. .. rst-class:: classref-item-separator
  879. ----
  880. .. _class_CodeEdit_method_is_line_executing:
  881. .. rst-class:: classref-method
  882. :ref:`bool<class_bool>` **is_line_executing**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_executing>`
  883. Returns whether the line at the specified index is marked as executing or not.
  884. .. rst-class:: classref-item-separator
  885. ----
  886. .. _class_CodeEdit_method_is_line_folded:
  887. .. rst-class:: classref-method
  888. :ref:`bool<class_bool>` **is_line_folded**\ (\ line\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CodeEdit_method_is_line_folded>`
  889. Returns whether the line at the specified index is folded or not.
  890. .. rst-class:: classref-item-separator
  891. ----
  892. .. _class_CodeEdit_method_move_lines_down:
  893. .. rst-class:: classref-method
  894. |void| **move_lines_down**\ (\ ) :ref:`🔗<class_CodeEdit_method_move_lines_down>`
  895. Moves all lines down that are selected or have a caret on them.
  896. .. rst-class:: classref-item-separator
  897. ----
  898. .. _class_CodeEdit_method_move_lines_up:
  899. .. rst-class:: classref-method
  900. |void| **move_lines_up**\ (\ ) :ref:`🔗<class_CodeEdit_method_move_lines_up>`
  901. Moves all lines up that are selected or have a caret on them.
  902. .. rst-class:: classref-item-separator
  903. ----
  904. .. _class_CodeEdit_method_remove_comment_delimiter:
  905. .. rst-class:: classref-method
  906. |void| **remove_comment_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_remove_comment_delimiter>`
  907. Removes the comment delimiter with ``start_key``.
  908. .. rst-class:: classref-item-separator
  909. ----
  910. .. _class_CodeEdit_method_remove_string_delimiter:
  911. .. rst-class:: classref-method
  912. |void| **remove_string_delimiter**\ (\ start_key\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_remove_string_delimiter>`
  913. Removes the string delimiter with ``start_key``.
  914. .. rst-class:: classref-item-separator
  915. ----
  916. .. _class_CodeEdit_method_request_code_completion:
  917. .. rst-class:: classref-method
  918. |void| **request_code_completion**\ (\ force\: :ref:`bool<class_bool>` = false\ ) :ref:`🔗<class_CodeEdit_method_request_code_completion>`
  919. 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.
  920. .. rst-class:: classref-item-separator
  921. ----
  922. .. _class_CodeEdit_method_set_code_completion_selected_index:
  923. .. rst-class:: classref-method
  924. |void| **set_code_completion_selected_index**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_completion_selected_index>`
  925. Sets the current selected completion option.
  926. .. rst-class:: classref-item-separator
  927. ----
  928. .. _class_CodeEdit_method_set_code_hint:
  929. .. rst-class:: classref-method
  930. |void| **set_code_hint**\ (\ code_hint\: :ref:`String<class_String>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_hint>`
  931. Sets the code hint text. Pass an empty string to clear.
  932. .. rst-class:: classref-item-separator
  933. ----
  934. .. _class_CodeEdit_method_set_code_hint_draw_below:
  935. .. rst-class:: classref-method
  936. |void| **set_code_hint_draw_below**\ (\ draw_below\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_code_hint_draw_below>`
  937. Sets if the code hint should draw below the text.
  938. .. rst-class:: classref-item-separator
  939. ----
  940. .. _class_CodeEdit_method_set_code_region_tags:
  941. .. rst-class:: classref-method
  942. |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>`
  943. Sets the code region start and end tags (without comment delimiter).
  944. .. rst-class:: classref-item-separator
  945. ----
  946. .. _class_CodeEdit_method_set_line_as_bookmarked:
  947. .. rst-class:: classref-method
  948. |void| **set_line_as_bookmarked**\ (\ line\: :ref:`int<class_int>`, bookmarked\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_bookmarked>`
  949. Sets the line as bookmarked.
  950. .. rst-class:: classref-item-separator
  951. ----
  952. .. _class_CodeEdit_method_set_line_as_breakpoint:
  953. .. rst-class:: classref-method
  954. |void| **set_line_as_breakpoint**\ (\ line\: :ref:`int<class_int>`, breakpointed\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_breakpoint>`
  955. Sets the line as breakpointed.
  956. .. rst-class:: classref-item-separator
  957. ----
  958. .. _class_CodeEdit_method_set_line_as_executing:
  959. .. rst-class:: classref-method
  960. |void| **set_line_as_executing**\ (\ line\: :ref:`int<class_int>`, executing\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_line_as_executing>`
  961. Sets the line as executing.
  962. .. rst-class:: classref-item-separator
  963. ----
  964. .. _class_CodeEdit_method_set_symbol_lookup_word_as_valid:
  965. .. rst-class:: classref-method
  966. |void| **set_symbol_lookup_word_as_valid**\ (\ valid\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_set_symbol_lookup_word_as_valid>`
  967. Sets the symbol emitted by :ref:`symbol_validate<class_CodeEdit_signal_symbol_validate>` as a valid lookup.
  968. .. rst-class:: classref-item-separator
  969. ----
  970. .. _class_CodeEdit_method_toggle_foldable_line:
  971. .. rst-class:: classref-method
  972. |void| **toggle_foldable_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_toggle_foldable_line>`
  973. Toggle the folding of the code block at the given line.
  974. .. rst-class:: classref-item-separator
  975. ----
  976. .. _class_CodeEdit_method_toggle_foldable_lines_at_carets:
  977. .. rst-class:: classref-method
  978. |void| **toggle_foldable_lines_at_carets**\ (\ ) :ref:`🔗<class_CodeEdit_method_toggle_foldable_lines_at_carets>`
  979. Toggle the folding of the code block on all lines with a caret on them.
  980. .. rst-class:: classref-item-separator
  981. ----
  982. .. _class_CodeEdit_method_unfold_all_lines:
  983. .. rst-class:: classref-method
  984. |void| **unfold_all_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_unfold_all_lines>`
  985. Unfolds all lines, folded or not.
  986. .. rst-class:: classref-item-separator
  987. ----
  988. .. _class_CodeEdit_method_unfold_line:
  989. .. rst-class:: classref-method
  990. |void| **unfold_line**\ (\ line\: :ref:`int<class_int>`\ ) :ref:`🔗<class_CodeEdit_method_unfold_line>`
  991. Unfolds all lines that were previously folded.
  992. .. rst-class:: classref-item-separator
  993. ----
  994. .. _class_CodeEdit_method_unindent_lines:
  995. .. rst-class:: classref-method
  996. |void| **unindent_lines**\ (\ ) :ref:`🔗<class_CodeEdit_method_unindent_lines>`
  997. Unindents selected lines, or in the case of no selection the caret line by one. Same as performing "ui_text_unindent" action.
  998. .. rst-class:: classref-item-separator
  999. ----
  1000. .. _class_CodeEdit_method_update_code_completion_options:
  1001. .. rst-class:: classref-method
  1002. |void| **update_code_completion_options**\ (\ force\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CodeEdit_method_update_code_completion_options>`
  1003. 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``.
  1004. \ **Note:** This will replace all current candidates.
  1005. .. rst-class:: classref-section-separator
  1006. ----
  1007. .. rst-class:: classref-descriptions-group
  1008. Theme Property Descriptions
  1009. ---------------------------
  1010. .. _class_CodeEdit_theme_color_bookmark_color:
  1011. .. rst-class:: classref-themeproperty
  1012. :ref:`Color<class_Color>` **bookmark_color** = ``Color(0.5, 0.64, 1, 0.8)`` :ref:`🔗<class_CodeEdit_theme_color_bookmark_color>`
  1013. :ref:`Color<class_Color>` of the bookmark icon for bookmarked lines.
  1014. .. rst-class:: classref-item-separator
  1015. ----
  1016. .. _class_CodeEdit_theme_color_brace_mismatch_color:
  1017. .. rst-class:: classref-themeproperty
  1018. :ref:`Color<class_Color>` **brace_mismatch_color** = ``Color(1, 0.2, 0.2, 1)`` :ref:`🔗<class_CodeEdit_theme_color_brace_mismatch_color>`
  1019. :ref:`Color<class_Color>` of the text to highlight mismatched braces.
  1020. .. rst-class:: classref-item-separator
  1021. ----
  1022. .. _class_CodeEdit_theme_color_breakpoint_color:
  1023. .. rst-class:: classref-themeproperty
  1024. :ref:`Color<class_Color>` **breakpoint_color** = ``Color(0.9, 0.29, 0.3, 1)`` :ref:`🔗<class_CodeEdit_theme_color_breakpoint_color>`
  1025. :ref:`Color<class_Color>` of the breakpoint icon for bookmarked lines.
  1026. .. rst-class:: classref-item-separator
  1027. ----
  1028. .. _class_CodeEdit_theme_color_code_folding_color:
  1029. .. rst-class:: classref-themeproperty
  1030. :ref:`Color<class_Color>` **code_folding_color** = ``Color(0.8, 0.8, 0.8, 0.8)`` :ref:`🔗<class_CodeEdit_theme_color_code_folding_color>`
  1031. :ref:`Color<class_Color>` for all icons related to line folding.
  1032. .. rst-class:: classref-item-separator
  1033. ----
  1034. .. _class_CodeEdit_theme_color_completion_background_color:
  1035. .. rst-class:: classref-themeproperty
  1036. :ref:`Color<class_Color>` **completion_background_color** = ``Color(0.17, 0.16, 0.2, 1)`` :ref:`🔗<class_CodeEdit_theme_color_completion_background_color>`
  1037. Sets the background :ref:`Color<class_Color>` for the code completion popup.
  1038. .. rst-class:: classref-item-separator
  1039. ----
  1040. .. _class_CodeEdit_theme_color_completion_existing_color:
  1041. .. rst-class:: classref-themeproperty
  1042. :ref:`Color<class_Color>` **completion_existing_color** = ``Color(0.87, 0.87, 0.87, 0.13)`` :ref:`🔗<class_CodeEdit_theme_color_completion_existing_color>`
  1043. Background highlight :ref:`Color<class_Color>` for matching text in code completion options.
  1044. .. rst-class:: classref-item-separator
  1045. ----
  1046. .. _class_CodeEdit_theme_color_completion_scroll_color:
  1047. .. rst-class:: classref-themeproperty
  1048. :ref:`Color<class_Color>` **completion_scroll_color** = ``Color(1, 1, 1, 0.29)`` :ref:`🔗<class_CodeEdit_theme_color_completion_scroll_color>`
  1049. :ref:`Color<class_Color>` of the scrollbar in the code completion popup.
  1050. .. rst-class:: classref-item-separator
  1051. ----
  1052. .. _class_CodeEdit_theme_color_completion_scroll_hovered_color:
  1053. .. rst-class:: classref-themeproperty
  1054. :ref:`Color<class_Color>` **completion_scroll_hovered_color** = ``Color(1, 1, 1, 0.4)`` :ref:`🔗<class_CodeEdit_theme_color_completion_scroll_hovered_color>`
  1055. :ref:`Color<class_Color>` of the scrollbar in the code completion popup when hovered.
  1056. .. rst-class:: classref-item-separator
  1057. ----
  1058. .. _class_CodeEdit_theme_color_completion_selected_color:
  1059. .. rst-class:: classref-themeproperty
  1060. :ref:`Color<class_Color>` **completion_selected_color** = ``Color(0.26, 0.26, 0.27, 1)`` :ref:`🔗<class_CodeEdit_theme_color_completion_selected_color>`
  1061. Background highlight :ref:`Color<class_Color>` for the current selected option item in the code completion popup.
  1062. .. rst-class:: classref-item-separator
  1063. ----
  1064. .. _class_CodeEdit_theme_color_executing_line_color:
  1065. .. rst-class:: classref-themeproperty
  1066. :ref:`Color<class_Color>` **executing_line_color** = ``Color(0.98, 0.89, 0.27, 1)`` :ref:`🔗<class_CodeEdit_theme_color_executing_line_color>`
  1067. :ref:`Color<class_Color>` of the executing icon for executing lines.
  1068. .. rst-class:: classref-item-separator
  1069. ----
  1070. .. _class_CodeEdit_theme_color_folded_code_region_color:
  1071. .. rst-class:: classref-themeproperty
  1072. :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>`
  1073. :ref:`Color<class_Color>` of background line highlight for folded code region.
  1074. .. rst-class:: classref-item-separator
  1075. ----
  1076. .. _class_CodeEdit_theme_color_line_length_guideline_color:
  1077. .. rst-class:: classref-themeproperty
  1078. :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>`
  1079. :ref:`Color<class_Color>` of the main line length guideline, secondary guidelines will have 50% alpha applied.
  1080. .. rst-class:: classref-item-separator
  1081. ----
  1082. .. _class_CodeEdit_theme_color_line_number_color:
  1083. .. rst-class:: classref-themeproperty
  1084. :ref:`Color<class_Color>` **line_number_color** = ``Color(0.67, 0.67, 0.67, 0.4)`` :ref:`🔗<class_CodeEdit_theme_color_line_number_color>`
  1085. Sets the :ref:`Color<class_Color>` of line numbers.
  1086. .. rst-class:: classref-item-separator
  1087. ----
  1088. .. _class_CodeEdit_theme_constant_completion_lines:
  1089. .. rst-class:: classref-themeproperty
  1090. :ref:`int<class_int>` **completion_lines** = ``7`` :ref:`🔗<class_CodeEdit_theme_constant_completion_lines>`
  1091. Max number of options to display in the code completion popup at any one time.
  1092. .. rst-class:: classref-item-separator
  1093. ----
  1094. .. _class_CodeEdit_theme_constant_completion_max_width:
  1095. .. rst-class:: classref-themeproperty
  1096. :ref:`int<class_int>` **completion_max_width** = ``50`` :ref:`🔗<class_CodeEdit_theme_constant_completion_max_width>`
  1097. Max width of options in the code completion popup. Options longer than this will be cut off.
  1098. .. rst-class:: classref-item-separator
  1099. ----
  1100. .. _class_CodeEdit_theme_constant_completion_scroll_width:
  1101. .. rst-class:: classref-themeproperty
  1102. :ref:`int<class_int>` **completion_scroll_width** = ``6`` :ref:`🔗<class_CodeEdit_theme_constant_completion_scroll_width>`
  1103. Width of the scrollbar in the code completion popup.
  1104. .. rst-class:: classref-item-separator
  1105. ----
  1106. .. _class_CodeEdit_theme_icon_bookmark:
  1107. .. rst-class:: classref-themeproperty
  1108. :ref:`Texture2D<class_Texture2D>` **bookmark** :ref:`🔗<class_CodeEdit_theme_icon_bookmark>`
  1109. Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the bookmark gutter for bookmarked lines.
  1110. .. rst-class:: classref-item-separator
  1111. ----
  1112. .. _class_CodeEdit_theme_icon_breakpoint:
  1113. .. rst-class:: classref-themeproperty
  1114. :ref:`Texture2D<class_Texture2D>` **breakpoint** :ref:`🔗<class_CodeEdit_theme_icon_breakpoint>`
  1115. Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the breakpoint gutter for breakpointed lines.
  1116. .. rst-class:: classref-item-separator
  1117. ----
  1118. .. _class_CodeEdit_theme_icon_can_fold:
  1119. .. rst-class:: classref-themeproperty
  1120. :ref:`Texture2D<class_Texture2D>` **can_fold** :ref:`🔗<class_CodeEdit_theme_icon_can_fold>`
  1121. Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line can be folded.
  1122. .. rst-class:: classref-item-separator
  1123. ----
  1124. .. _class_CodeEdit_theme_icon_can_fold_code_region:
  1125. .. rst-class:: classref-themeproperty
  1126. :ref:`Texture2D<class_Texture2D>` **can_fold_code_region** :ref:`🔗<class_CodeEdit_theme_icon_can_fold_code_region>`
  1127. Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a code region can be folded.
  1128. .. rst-class:: classref-item-separator
  1129. ----
  1130. .. _class_CodeEdit_theme_icon_completion_color_bg:
  1131. .. rst-class:: classref-themeproperty
  1132. :ref:`Texture2D<class_Texture2D>` **completion_color_bg** :ref:`🔗<class_CodeEdit_theme_icon_completion_color_bg>`
  1133. Background panel for the color preview box in autocompletion (visible when the color is translucent).
  1134. .. rst-class:: classref-item-separator
  1135. ----
  1136. .. _class_CodeEdit_theme_icon_executing_line:
  1137. .. rst-class:: classref-themeproperty
  1138. :ref:`Texture2D<class_Texture2D>` **executing_line** :ref:`🔗<class_CodeEdit_theme_icon_executing_line>`
  1139. Icon to draw in the executing gutter for executing lines.
  1140. .. rst-class:: classref-item-separator
  1141. ----
  1142. .. _class_CodeEdit_theme_icon_folded:
  1143. .. rst-class:: classref-themeproperty
  1144. :ref:`Texture2D<class_Texture2D>` **folded** :ref:`🔗<class_CodeEdit_theme_icon_folded>`
  1145. Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a line is folded and can be unfolded.
  1146. .. rst-class:: classref-item-separator
  1147. ----
  1148. .. _class_CodeEdit_theme_icon_folded_code_region:
  1149. .. rst-class:: classref-themeproperty
  1150. :ref:`Texture2D<class_Texture2D>` **folded_code_region** :ref:`🔗<class_CodeEdit_theme_icon_folded_code_region>`
  1151. Sets a custom :ref:`Texture2D<class_Texture2D>` to draw in the line folding gutter when a code region is folded and can be unfolded.
  1152. .. rst-class:: classref-item-separator
  1153. ----
  1154. .. _class_CodeEdit_theme_icon_folded_eol_icon:
  1155. .. rst-class:: classref-themeproperty
  1156. :ref:`Texture2D<class_Texture2D>` **folded_eol_icon** :ref:`🔗<class_CodeEdit_theme_icon_folded_eol_icon>`
  1157. Sets a custom :ref:`Texture2D<class_Texture2D>` to draw at the end of a folded line.
  1158. .. rst-class:: classref-item-separator
  1159. ----
  1160. .. _class_CodeEdit_theme_style_completion:
  1161. .. rst-class:: classref-themeproperty
  1162. :ref:`StyleBox<class_StyleBox>` **completion** :ref:`🔗<class_CodeEdit_theme_style_completion>`
  1163. :ref:`StyleBox<class_StyleBox>` for the code completion popup.
  1164. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1165. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1166. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1167. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1168. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1169. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  1170. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  1171. .. |void| replace:: :abbr:`void (No return value.)`