class_codeedit.rst 156 KB

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