class_textedit.rst 67 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the TextEdit.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_TextEdit:
  6. TextEdit
  7. ========
  8. **Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. Multiline text editing control.
  10. Description
  11. -----------
  12. TextEdit is meant for editing large, multiline text. It also has facilities for editing code, such as syntax highlighting support and multiple levels of undo/redo.
  13. Properties
  14. ----------
  15. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  16. | :ref:`bool<class_bool>` | :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>` | ``false`` |
  17. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`caret_blink<class_TextEdit_property_caret_blink>` | ``false`` |
  19. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  20. | :ref:`float<class_float>` | :ref:`caret_blink_speed<class_TextEdit_property_caret_blink_speed>` | ``0.65`` |
  21. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  22. | :ref:`bool<class_bool>` | :ref:`caret_block_mode<class_TextEdit_property_caret_block_mode>` | ``false`` |
  23. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  24. | :ref:`bool<class_bool>` | :ref:`caret_moving_by_right_click<class_TextEdit_property_caret_moving_by_right_click>` | ``true`` |
  25. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  26. | :ref:`bool<class_bool>` | :ref:`context_menu_enabled<class_TextEdit_property_context_menu_enabled>` | ``true`` |
  27. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  28. | :ref:`bool<class_bool>` | :ref:`draw_spaces<class_TextEdit_property_draw_spaces>` | ``false`` |
  29. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  30. | :ref:`bool<class_bool>` | :ref:`draw_tabs<class_TextEdit_property_draw_tabs>` | ``false`` |
  31. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  32. | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` *(parent override)* |
  33. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  34. | :ref:`bool<class_bool>` | :ref:`fold_gutter<class_TextEdit_property_fold_gutter>` | ``false`` |
  35. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`hiding_enabled<class_TextEdit_property_hiding_enabled>` | ``false`` |
  37. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  38. | :ref:`bool<class_bool>` | :ref:`highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>` | ``false`` |
  39. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  40. | :ref:`bool<class_bool>` | :ref:`highlight_current_line<class_TextEdit_property_highlight_current_line>` | ``false`` |
  41. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  42. | :ref:`bool<class_bool>` | :ref:`minimap_draw<class_TextEdit_property_minimap_draw>` | ``false`` |
  43. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  44. | :ref:`int<class_int>` | :ref:`minimap_width<class_TextEdit_property_minimap_width>` | ``80`` |
  45. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  46. | :ref:`CursorShape<enum_Control_CursorShape>` | mouse_default_cursor_shape | ``1`` *(parent override)* |
  47. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  48. | :ref:`bool<class_bool>` | :ref:`override_selected_font_color<class_TextEdit_property_override_selected_font_color>` | ``false`` |
  49. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  50. | :ref:`bool<class_bool>` | :ref:`readonly<class_TextEdit_property_readonly>` | ``false`` |
  51. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  52. | :ref:`int<class_int>` | :ref:`scroll_horizontal<class_TextEdit_property_scroll_horizontal>` | ``0`` |
  53. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  54. | :ref:`float<class_float>` | :ref:`scroll_vertical<class_TextEdit_property_scroll_vertical>` | ``0.0`` |
  55. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  56. | :ref:`bool<class_bool>` | :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` | ``true`` |
  57. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  58. | :ref:`bool<class_bool>` | :ref:`shortcut_keys_enabled<class_TextEdit_property_shortcut_keys_enabled>` | ``true`` |
  59. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  60. | :ref:`bool<class_bool>` | :ref:`show_line_numbers<class_TextEdit_property_show_line_numbers>` | ``false`` |
  61. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  62. | :ref:`bool<class_bool>` | :ref:`smooth_scrolling<class_TextEdit_property_smooth_scrolling>` | ``false`` |
  63. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`syntax_highlighting<class_TextEdit_property_syntax_highlighting>` | ``false`` |
  65. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  66. | :ref:`String<class_String>` | :ref:`text<class_TextEdit_property_text>` | ``""`` |
  67. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  68. | :ref:`float<class_float>` | :ref:`v_scroll_speed<class_TextEdit_property_v_scroll_speed>` | ``80.0`` |
  69. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  70. | :ref:`bool<class_bool>` | :ref:`virtual_keyboard_enabled<class_TextEdit_property_virtual_keyboard_enabled>` | ``true`` |
  71. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  72. | :ref:`bool<class_bool>` | :ref:`wrap_enabled<class_TextEdit_property_wrap_enabled>` | ``false`` |
  73. +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
  74. Methods
  75. -------
  76. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`add_color_region<class_TextEdit_method_add_color_region>` **(** :ref:`String<class_String>` begin_key, :ref:`String<class_String>` end_key, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` line_only=false **)** |
  78. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`add_keyword_color<class_TextEdit_method_add_keyword_color>` **(** :ref:`String<class_String>` keyword, :ref:`Color<class_Color>` color **)** |
  80. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`bool<class_bool>` | :ref:`can_fold<class_TextEdit_method_can_fold>` **(** :ref:`int<class_int>` line **)** |const| |
  82. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`center_viewport_to_cursor<class_TextEdit_method_center_viewport_to_cursor>` **(** **)** |
  84. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`clear_colors<class_TextEdit_method_clear_colors>` **(** **)** |
  86. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`clear_undo_history<class_TextEdit_method_clear_undo_history>` **(** **)** |
  88. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`copy<class_TextEdit_method_copy>` **(** **)** |
  90. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`int<class_int>` | :ref:`cursor_get_column<class_TextEdit_method_cursor_get_column>` **(** **)** |const| |
  92. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`int<class_int>` | :ref:`cursor_get_line<class_TextEdit_method_cursor_get_line>` **(** **)** |const| |
  94. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | void | :ref:`cursor_set_column<class_TextEdit_method_cursor_set_column>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=true **)** |
  96. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`cursor_set_line<class_TextEdit_method_cursor_set_line>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` adjust_viewport=true, :ref:`bool<class_bool>` can_be_hidden=true, :ref:`int<class_int>` wrap_index=0 **)** |
  98. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`cut<class_TextEdit_method_cut>` **(** **)** |
  100. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`deselect<class_TextEdit_method_deselect>` **(** **)** |
  102. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | void | :ref:`fold_all_lines<class_TextEdit_method_fold_all_lines>` **(** **)** |
  104. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | void | :ref:`fold_line<class_TextEdit_method_fold_line>` **(** :ref:`int<class_int>` line **)** |
  106. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`Array<class_Array>` | :ref:`get_breakpoints<class_TextEdit_method_get_breakpoints>` **(** **)** |const| |
  108. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`Color<class_Color>` | :ref:`get_keyword_color<class_TextEdit_method_get_keyword_color>` **(** :ref:`String<class_String>` keyword **)** |const| |
  110. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`String<class_String>` | :ref:`get_line<class_TextEdit_method_get_line>` **(** :ref:`int<class_int>` line **)** |const| |
  112. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`int<class_int>` | :ref:`get_line_count<class_TextEdit_method_get_line_count>` **(** **)** |const| |
  114. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`PopupMenu<class_PopupMenu>` | :ref:`get_menu<class_TextEdit_method_get_menu>` **(** **)** |const| |
  116. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`int<class_int>` | :ref:`get_selection_from_column<class_TextEdit_method_get_selection_from_column>` **(** **)** |const| |
  118. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`int<class_int>` | :ref:`get_selection_from_line<class_TextEdit_method_get_selection_from_line>` **(** **)** |const| |
  120. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`String<class_String>` | :ref:`get_selection_text<class_TextEdit_method_get_selection_text>` **(** **)** |const| |
  122. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`int<class_int>` | :ref:`get_selection_to_column<class_TextEdit_method_get_selection_to_column>` **(** **)** |const| |
  124. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`get_selection_to_line<class_TextEdit_method_get_selection_to_line>` **(** **)** |const| |
  126. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`String<class_String>` | :ref:`get_word_under_cursor<class_TextEdit_method_get_word_under_cursor>` **(** **)** |const| |
  128. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`bool<class_bool>` | :ref:`has_keyword_color<class_TextEdit_method_has_keyword_color>` **(** :ref:`String<class_String>` keyword **)** |const| |
  130. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | void | :ref:`insert_text_at_cursor<class_TextEdit_method_insert_text_at_cursor>` **(** :ref:`String<class_String>` text **)** |
  132. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`bool<class_bool>` | :ref:`is_folded<class_TextEdit_method_is_folded>` **(** :ref:`int<class_int>` line **)** |const| |
  134. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`bool<class_bool>` | :ref:`is_line_hidden<class_TextEdit_method_is_line_hidden>` **(** :ref:`int<class_int>` line **)** |const| |
  136. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`bool<class_bool>` | :ref:`is_selection_active<class_TextEdit_method_is_selection_active>` **(** **)** |const| |
  138. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`menu_option<class_TextEdit_method_menu_option>` **(** :ref:`int<class_int>` option **)** |
  140. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`paste<class_TextEdit_method_paste>` **(** **)** |
  142. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | void | :ref:`redo<class_TextEdit_method_redo>` **(** **)** |
  144. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`remove_breakpoints<class_TextEdit_method_remove_breakpoints>` **(** **)** |
  146. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`PoolIntArray<class_PoolIntArray>` | :ref:`search<class_TextEdit_method_search>` **(** :ref:`String<class_String>` key, :ref:`int<class_int>` flags, :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column **)** |const| |
  148. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | void | :ref:`select<class_TextEdit_method_select>` **(** :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line, :ref:`int<class_int>` to_column **)** |
  150. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | void | :ref:`select_all<class_TextEdit_method_select_all>` **(** **)** |
  152. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | void | :ref:`set_line<class_TextEdit_method_set_line>` **(** :ref:`int<class_int>` line, :ref:`String<class_String>` new_text **)** |
  154. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)** |
  156. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`toggle_fold_line<class_TextEdit_method_toggle_fold_line>` **(** :ref:`int<class_int>` line **)** |
  158. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`undo<class_TextEdit_method_undo>` **(** **)** |
  160. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | void | :ref:`unfold_line<class_TextEdit_method_unfold_line>` **(** :ref:`int<class_int>` line **)** |
  162. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | void | :ref:`unhide_all_lines<class_TextEdit_method_unhide_all_lines>` **(** **)** |
  164. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. Theme Properties
  166. ----------------
  167. +---------------------------------+-----------------------------+---------------------------------+
  168. | :ref:`Color<class_Color>` | background_color | Color( 0, 0, 0, 0 ) |
  169. +---------------------------------+-----------------------------+---------------------------------+
  170. | :ref:`Color<class_Color>` | bookmark_color | Color( 0.08, 0.49, 0.98, 1 ) |
  171. +---------------------------------+-----------------------------+---------------------------------+
  172. | :ref:`Color<class_Color>` | brace_mismatch_color | Color( 1, 0.2, 0.2, 1 ) |
  173. +---------------------------------+-----------------------------+---------------------------------+
  174. | :ref:`Color<class_Color>` | breakpoint_color | Color( 0.8, 0.8, 0.4, 0.2 ) |
  175. +---------------------------------+-----------------------------+---------------------------------+
  176. | :ref:`Color<class_Color>` | caret_background_color | Color( 0, 0, 0, 1 ) |
  177. +---------------------------------+-----------------------------+---------------------------------+
  178. | :ref:`Color<class_Color>` | caret_color | Color( 0.88, 0.88, 0.88, 1 ) |
  179. +---------------------------------+-----------------------------+---------------------------------+
  180. | :ref:`Color<class_Color>` | code_folding_color | Color( 0.8, 0.8, 0.8, 0.8 ) |
  181. +---------------------------------+-----------------------------+---------------------------------+
  182. | :ref:`StyleBox<class_StyleBox>` | completion | |
  183. +---------------------------------+-----------------------------+---------------------------------+
  184. | :ref:`Color<class_Color>` | completion_background_color | Color( 0.17, 0.16, 0.2, 1 ) |
  185. +---------------------------------+-----------------------------+---------------------------------+
  186. | :ref:`Color<class_Color>` | completion_existing_color | Color( 0.87, 0.87, 0.87, 0.13 ) |
  187. +---------------------------------+-----------------------------+---------------------------------+
  188. | :ref:`Color<class_Color>` | completion_font_color | Color( 0.67, 0.67, 0.67, 1 ) |
  189. +---------------------------------+-----------------------------+---------------------------------+
  190. | :ref:`int<class_int>` | completion_lines | 7 |
  191. +---------------------------------+-----------------------------+---------------------------------+
  192. | :ref:`int<class_int>` | completion_max_width | 50 |
  193. +---------------------------------+-----------------------------+---------------------------------+
  194. | :ref:`Color<class_Color>` | completion_scroll_color | Color( 1, 1, 1, 1 ) |
  195. +---------------------------------+-----------------------------+---------------------------------+
  196. | :ref:`int<class_int>` | completion_scroll_width | 3 |
  197. +---------------------------------+-----------------------------+---------------------------------+
  198. | :ref:`Color<class_Color>` | completion_selected_color | Color( 0.26, 0.26, 0.27, 1 ) |
  199. +---------------------------------+-----------------------------+---------------------------------+
  200. | :ref:`Color<class_Color>` | current_line_color | Color( 0.25, 0.25, 0.26, 0.8 ) |
  201. +---------------------------------+-----------------------------+---------------------------------+
  202. | :ref:`Color<class_Color>` | executing_line_color | Color( 0.2, 0.8, 0.2, 0.4 ) |
  203. +---------------------------------+-----------------------------+---------------------------------+
  204. | :ref:`StyleBox<class_StyleBox>` | focus | |
  205. +---------------------------------+-----------------------------+---------------------------------+
  206. | :ref:`Texture<class_Texture>` | fold | |
  207. +---------------------------------+-----------------------------+---------------------------------+
  208. | :ref:`Texture<class_Texture>` | folded | |
  209. +---------------------------------+-----------------------------+---------------------------------+
  210. | :ref:`Font<class_Font>` | font | |
  211. +---------------------------------+-----------------------------+---------------------------------+
  212. | :ref:`Color<class_Color>` | font_color | Color( 0.88, 0.88, 0.88, 1 ) |
  213. +---------------------------------+-----------------------------+---------------------------------+
  214. | :ref:`Color<class_Color>` | font_color_readonly | Color( 0.88, 0.88, 0.88, 0.5 ) |
  215. +---------------------------------+-----------------------------+---------------------------------+
  216. | :ref:`Color<class_Color>` | font_color_selected | Color( 0, 0, 0, 1 ) |
  217. +---------------------------------+-----------------------------+---------------------------------+
  218. | :ref:`Color<class_Color>` | function_color | Color( 0.4, 0.64, 0.81, 1 ) |
  219. +---------------------------------+-----------------------------+---------------------------------+
  220. | :ref:`Color<class_Color>` | line_number_color | Color( 0.67, 0.67, 0.67, 0.4 ) |
  221. +---------------------------------+-----------------------------+---------------------------------+
  222. | :ref:`int<class_int>` | line_spacing | 4 |
  223. +---------------------------------+-----------------------------+---------------------------------+
  224. | :ref:`Color<class_Color>` | mark_color | Color( 1, 0.4, 0.4, 0.4 ) |
  225. +---------------------------------+-----------------------------+---------------------------------+
  226. | :ref:`Color<class_Color>` | member_variable_color | Color( 0.9, 0.31, 0.35, 1 ) |
  227. +---------------------------------+-----------------------------+---------------------------------+
  228. | :ref:`StyleBox<class_StyleBox>` | normal | |
  229. +---------------------------------+-----------------------------+---------------------------------+
  230. | :ref:`Color<class_Color>` | number_color | Color( 0.92, 0.58, 0.2, 1 ) |
  231. +---------------------------------+-----------------------------+---------------------------------+
  232. | :ref:`StyleBox<class_StyleBox>` | read_only | |
  233. +---------------------------------+-----------------------------+---------------------------------+
  234. | :ref:`Color<class_Color>` | safe_line_number_color | Color( 0.67, 0.78, 0.67, 0.6 ) |
  235. +---------------------------------+-----------------------------+---------------------------------+
  236. | :ref:`Color<class_Color>` | selection_color | Color( 0.49, 0.49, 0.49, 1 ) |
  237. +---------------------------------+-----------------------------+---------------------------------+
  238. | :ref:`Texture<class_Texture>` | space | |
  239. +---------------------------------+-----------------------------+---------------------------------+
  240. | :ref:`Color<class_Color>` | symbol_color | Color( 0.94, 0.94, 0.94, 1 ) |
  241. +---------------------------------+-----------------------------+---------------------------------+
  242. | :ref:`Texture<class_Texture>` | tab | |
  243. +---------------------------------+-----------------------------+---------------------------------+
  244. | :ref:`Color<class_Color>` | word_highlighted_color | Color( 0.8, 0.9, 0.9, 0.15 ) |
  245. +---------------------------------+-----------------------------+---------------------------------+
  246. Signals
  247. -------
  248. .. _class_TextEdit_signal_breakpoint_toggled:
  249. - **breakpoint_toggled** **(** :ref:`int<class_int>` row **)**
  250. Emitted when a breakpoint is placed via the breakpoint gutter.
  251. ----
  252. .. _class_TextEdit_signal_cursor_changed:
  253. - **cursor_changed** **(** **)**
  254. Emitted when the cursor changes.
  255. ----
  256. .. _class_TextEdit_signal_info_clicked:
  257. - **info_clicked** **(** :ref:`int<class_int>` row, :ref:`String<class_String>` info **)**
  258. Emitted when the info icon is clicked.
  259. ----
  260. .. _class_TextEdit_signal_request_completion:
  261. - **request_completion** **(** **)**
  262. ----
  263. .. _class_TextEdit_signal_symbol_lookup:
  264. - **symbol_lookup** **(** :ref:`String<class_String>` symbol, :ref:`int<class_int>` row, :ref:`int<class_int>` column **)**
  265. ----
  266. .. _class_TextEdit_signal_text_changed:
  267. - **text_changed** **(** **)**
  268. Emitted when the text changes.
  269. Enumerations
  270. ------------
  271. .. _enum_TextEdit_SearchFlags:
  272. .. _class_TextEdit_constant_SEARCH_MATCH_CASE:
  273. .. _class_TextEdit_constant_SEARCH_WHOLE_WORDS:
  274. .. _class_TextEdit_constant_SEARCH_BACKWARDS:
  275. enum **SearchFlags**:
  276. - **SEARCH_MATCH_CASE** = **1** --- Match case when searching.
  277. - **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching.
  278. - **SEARCH_BACKWARDS** = **4** --- Search from end to beginning.
  279. ----
  280. .. _enum_TextEdit_SearchResult:
  281. .. _class_TextEdit_constant_SEARCH_RESULT_COLUMN:
  282. .. _class_TextEdit_constant_SEARCH_RESULT_LINE:
  283. enum **SearchResult**:
  284. - **SEARCH_RESULT_COLUMN** = **0** --- Used to access the result column from :ref:`search<class_TextEdit_method_search>`.
  285. - **SEARCH_RESULT_LINE** = **1** --- Used to access the result line from :ref:`search<class_TextEdit_method_search>`.
  286. ----
  287. .. _enum_TextEdit_MenuItems:
  288. .. _class_TextEdit_constant_MENU_CUT:
  289. .. _class_TextEdit_constant_MENU_COPY:
  290. .. _class_TextEdit_constant_MENU_PASTE:
  291. .. _class_TextEdit_constant_MENU_CLEAR:
  292. .. _class_TextEdit_constant_MENU_SELECT_ALL:
  293. .. _class_TextEdit_constant_MENU_UNDO:
  294. .. _class_TextEdit_constant_MENU_REDO:
  295. .. _class_TextEdit_constant_MENU_MAX:
  296. enum **MenuItems**:
  297. - **MENU_CUT** = **0** --- Cuts (copies and clears) the selected text.
  298. - **MENU_COPY** = **1** --- Copies the selected text.
  299. - **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position).
  300. - **MENU_CLEAR** = **3** --- Erases the whole ``TextEdit`` text.
  301. - **MENU_SELECT_ALL** = **4** --- Selects the whole ``TextEdit`` text.
  302. - **MENU_UNDO** = **5** --- Undoes the previous action.
  303. - **MENU_REDO** = **6** --- Redoes the previous action.
  304. - **MENU_MAX** = **7** --- Represents the size of the :ref:`MenuItems<enum_TextEdit_MenuItems>` enum.
  305. Property Descriptions
  306. ---------------------
  307. .. _class_TextEdit_property_breakpoint_gutter:
  308. - :ref:`bool<class_bool>` **breakpoint_gutter**
  309. +-----------+--------------------------------------+
  310. | *Default* | ``false`` |
  311. +-----------+--------------------------------------+
  312. | *Setter* | set_breakpoint_gutter_enabled(value) |
  313. +-----------+--------------------------------------+
  314. | *Getter* | is_breakpoint_gutter_enabled() |
  315. +-----------+--------------------------------------+
  316. If ``true``, the breakpoint gutter is visible.
  317. ----
  318. .. _class_TextEdit_property_caret_blink:
  319. - :ref:`bool<class_bool>` **caret_blink**
  320. +-----------+---------------------------------+
  321. | *Default* | ``false`` |
  322. +-----------+---------------------------------+
  323. | *Setter* | cursor_set_blink_enabled(value) |
  324. +-----------+---------------------------------+
  325. | *Getter* | cursor_get_blink_enabled() |
  326. +-----------+---------------------------------+
  327. If ``true``, the caret (visual cursor) blinks.
  328. ----
  329. .. _class_TextEdit_property_caret_blink_speed:
  330. - :ref:`float<class_float>` **caret_blink_speed**
  331. +-----------+-------------------------------+
  332. | *Default* | ``0.65`` |
  333. +-----------+-------------------------------+
  334. | *Setter* | cursor_set_blink_speed(value) |
  335. +-----------+-------------------------------+
  336. | *Getter* | cursor_get_blink_speed() |
  337. +-----------+-------------------------------+
  338. Duration (in seconds) of a caret's blinking cycle.
  339. ----
  340. .. _class_TextEdit_property_caret_block_mode:
  341. - :ref:`bool<class_bool>` **caret_block_mode**
  342. +-----------+------------------------------+
  343. | *Default* | ``false`` |
  344. +-----------+------------------------------+
  345. | *Setter* | cursor_set_block_mode(value) |
  346. +-----------+------------------------------+
  347. | *Getter* | cursor_is_block_mode() |
  348. +-----------+------------------------------+
  349. If ``true``, the caret displays as a rectangle.
  350. If ``false``, the caret displays as a bar.
  351. ----
  352. .. _class_TextEdit_property_caret_moving_by_right_click:
  353. - :ref:`bool<class_bool>` **caret_moving_by_right_click**
  354. +-----------+------------------------------------+
  355. | *Default* | ``true`` |
  356. +-----------+------------------------------------+
  357. | *Setter* | set_right_click_moves_caret(value) |
  358. +-----------+------------------------------------+
  359. | *Getter* | is_right_click_moving_caret() |
  360. +-----------+------------------------------------+
  361. If ``true``, a right-click moves the cursor at the mouse position before displaying the context menu.
  362. If ``false``, the context menu disregards mouse location.
  363. ----
  364. .. _class_TextEdit_property_context_menu_enabled:
  365. - :ref:`bool<class_bool>` **context_menu_enabled**
  366. +-----------+---------------------------------+
  367. | *Default* | ``true`` |
  368. +-----------+---------------------------------+
  369. | *Setter* | set_context_menu_enabled(value) |
  370. +-----------+---------------------------------+
  371. | *Getter* | is_context_menu_enabled() |
  372. +-----------+---------------------------------+
  373. If ``true``, a right-click displays the context menu.
  374. ----
  375. .. _class_TextEdit_property_draw_spaces:
  376. - :ref:`bool<class_bool>` **draw_spaces**
  377. +-----------+------------------------+
  378. | *Default* | ``false`` |
  379. +-----------+------------------------+
  380. | *Setter* | set_draw_spaces(value) |
  381. +-----------+------------------------+
  382. | *Getter* | is_drawing_spaces() |
  383. +-----------+------------------------+
  384. If ``true``, the "space" character will have a visible representation.
  385. ----
  386. .. _class_TextEdit_property_draw_tabs:
  387. - :ref:`bool<class_bool>` **draw_tabs**
  388. +-----------+----------------------+
  389. | *Default* | ``false`` |
  390. +-----------+----------------------+
  391. | *Setter* | set_draw_tabs(value) |
  392. +-----------+----------------------+
  393. | *Getter* | is_drawing_tabs() |
  394. +-----------+----------------------+
  395. If ``true``, the "tab" character will have a visible representation.
  396. ----
  397. .. _class_TextEdit_property_fold_gutter:
  398. - :ref:`bool<class_bool>` **fold_gutter**
  399. +-----------+-----------------------------+
  400. | *Default* | ``false`` |
  401. +-----------+-----------------------------+
  402. | *Setter* | set_draw_fold_gutter(value) |
  403. +-----------+-----------------------------+
  404. | *Getter* | is_drawing_fold_gutter() |
  405. +-----------+-----------------------------+
  406. If ``true``, the fold gutter is visible. This enables folding groups of indented lines.
  407. ----
  408. .. _class_TextEdit_property_hiding_enabled:
  409. - :ref:`bool<class_bool>` **hiding_enabled**
  410. +-----------+---------------------------+
  411. | *Default* | ``false`` |
  412. +-----------+---------------------------+
  413. | *Setter* | set_hiding_enabled(value) |
  414. +-----------+---------------------------+
  415. | *Getter* | is_hiding_enabled() |
  416. +-----------+---------------------------+
  417. If ``true``, all lines that have been set to hidden by :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`, will not be visible.
  418. ----
  419. .. _class_TextEdit_property_highlight_all_occurrences:
  420. - :ref:`bool<class_bool>` **highlight_all_occurrences**
  421. +-----------+----------------------------------------+
  422. | *Default* | ``false`` |
  423. +-----------+----------------------------------------+
  424. | *Setter* | set_highlight_all_occurrences(value) |
  425. +-----------+----------------------------------------+
  426. | *Getter* | is_highlight_all_occurrences_enabled() |
  427. +-----------+----------------------------------------+
  428. If ``true``, all occurrences of the selected text will be highlighted.
  429. ----
  430. .. _class_TextEdit_property_highlight_current_line:
  431. - :ref:`bool<class_bool>` **highlight_current_line**
  432. +-----------+-------------------------------------+
  433. | *Default* | ``false`` |
  434. +-----------+-------------------------------------+
  435. | *Setter* | set_highlight_current_line(value) |
  436. +-----------+-------------------------------------+
  437. | *Getter* | is_highlight_current_line_enabled() |
  438. +-----------+-------------------------------------+
  439. If ``true``, the line containing the cursor is highlighted.
  440. ----
  441. .. _class_TextEdit_property_minimap_draw:
  442. - :ref:`bool<class_bool>` **minimap_draw**
  443. +-----------+----------------------+
  444. | *Default* | ``false`` |
  445. +-----------+----------------------+
  446. | *Setter* | draw_minimap(value) |
  447. +-----------+----------------------+
  448. | *Getter* | is_drawing_minimap() |
  449. +-----------+----------------------+
  450. If ``true``, a minimap is shown, providing an outline of your source code.
  451. ----
  452. .. _class_TextEdit_property_minimap_width:
  453. - :ref:`int<class_int>` **minimap_width**
  454. +-----------+--------------------------+
  455. | *Default* | ``80`` |
  456. +-----------+--------------------------+
  457. | *Setter* | set_minimap_width(value) |
  458. +-----------+--------------------------+
  459. | *Getter* | get_minimap_width() |
  460. +-----------+--------------------------+
  461. The width, in pixels, of the minimap.
  462. ----
  463. .. _class_TextEdit_property_override_selected_font_color:
  464. - :ref:`bool<class_bool>` **override_selected_font_color**
  465. +-----------+-----------------------------------------+
  466. | *Default* | ``false`` |
  467. +-----------+-----------------------------------------+
  468. | *Setter* | set_override_selected_font_color(value) |
  469. +-----------+-----------------------------------------+
  470. | *Getter* | is_overriding_selected_font_color() |
  471. +-----------+-----------------------------------------+
  472. If ``true``, custom ``font_color_selected`` will be used for selected text.
  473. ----
  474. .. _class_TextEdit_property_readonly:
  475. - :ref:`bool<class_bool>` **readonly**
  476. +-----------+---------------------+
  477. | *Default* | ``false`` |
  478. +-----------+---------------------+
  479. | *Setter* | set_readonly(value) |
  480. +-----------+---------------------+
  481. | *Getter* | is_readonly() |
  482. +-----------+---------------------+
  483. If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
  484. ----
  485. .. _class_TextEdit_property_scroll_horizontal:
  486. - :ref:`int<class_int>` **scroll_horizontal**
  487. +-----------+---------------------+
  488. | *Default* | ``0`` |
  489. +-----------+---------------------+
  490. | *Setter* | set_h_scroll(value) |
  491. +-----------+---------------------+
  492. | *Getter* | get_h_scroll() |
  493. +-----------+---------------------+
  494. The current horizontal scroll value.
  495. ----
  496. .. _class_TextEdit_property_scroll_vertical:
  497. - :ref:`float<class_float>` **scroll_vertical**
  498. +-----------+---------------------+
  499. | *Default* | ``0.0`` |
  500. +-----------+---------------------+
  501. | *Setter* | set_v_scroll(value) |
  502. +-----------+---------------------+
  503. | *Getter* | get_v_scroll() |
  504. +-----------+---------------------+
  505. The current vertical scroll value.
  506. ----
  507. .. _class_TextEdit_property_selecting_enabled:
  508. - :ref:`bool<class_bool>` **selecting_enabled**
  509. +-----------+------------------------------+
  510. | *Default* | ``true`` |
  511. +-----------+------------------------------+
  512. | *Setter* | set_selecting_enabled(value) |
  513. +-----------+------------------------------+
  514. | *Getter* | is_selecting_enabled() |
  515. +-----------+------------------------------+
  516. If ``true``, text can be selected.
  517. If ``false``, text can not be selected by the user or by the :ref:`select<class_TextEdit_method_select>` or :ref:`select_all<class_TextEdit_method_select_all>` methods.
  518. ----
  519. .. _class_TextEdit_property_shortcut_keys_enabled:
  520. - :ref:`bool<class_bool>` **shortcut_keys_enabled**
  521. +-----------+----------------------------------+
  522. | *Default* | ``true`` |
  523. +-----------+----------------------------------+
  524. | *Setter* | set_shortcut_keys_enabled(value) |
  525. +-----------+----------------------------------+
  526. | *Getter* | is_shortcut_keys_enabled() |
  527. +-----------+----------------------------------+
  528. If ``true``, shortcut keys for context menu items are enabled, even if the context menu is disabled.
  529. ----
  530. .. _class_TextEdit_property_show_line_numbers:
  531. - :ref:`bool<class_bool>` **show_line_numbers**
  532. +-----------+--------------------------------+
  533. | *Default* | ``false`` |
  534. +-----------+--------------------------------+
  535. | *Setter* | set_show_line_numbers(value) |
  536. +-----------+--------------------------------+
  537. | *Getter* | is_show_line_numbers_enabled() |
  538. +-----------+--------------------------------+
  539. If ``true``, line numbers are displayed to the left of the text.
  540. ----
  541. .. _class_TextEdit_property_smooth_scrolling:
  542. - :ref:`bool<class_bool>` **smooth_scrolling**
  543. +-----------+---------------------------------+
  544. | *Default* | ``false`` |
  545. +-----------+---------------------------------+
  546. | *Setter* | set_smooth_scroll_enable(value) |
  547. +-----------+---------------------------------+
  548. | *Getter* | is_smooth_scroll_enabled() |
  549. +-----------+---------------------------------+
  550. If ``true``, sets the ``step`` of the scrollbars to ``0.25`` which results in smoother scrolling.
  551. ----
  552. .. _class_TextEdit_property_syntax_highlighting:
  553. - :ref:`bool<class_bool>` **syntax_highlighting**
  554. +-----------+------------------------------+
  555. | *Default* | ``false`` |
  556. +-----------+------------------------------+
  557. | *Setter* | set_syntax_coloring(value) |
  558. +-----------+------------------------------+
  559. | *Getter* | is_syntax_coloring_enabled() |
  560. +-----------+------------------------------+
  561. If ``true``, any custom color properties that have been set for this ``TextEdit`` will be visible.
  562. ----
  563. .. _class_TextEdit_property_text:
  564. - :ref:`String<class_String>` **text**
  565. +-----------+-----------------+
  566. | *Default* | ``""`` |
  567. +-----------+-----------------+
  568. | *Setter* | set_text(value) |
  569. +-----------+-----------------+
  570. | *Getter* | get_text() |
  571. +-----------+-----------------+
  572. String value of the ``TextEdit``.
  573. ----
  574. .. _class_TextEdit_property_v_scroll_speed:
  575. - :ref:`float<class_float>` **v_scroll_speed**
  576. +-----------+---------------------------+
  577. | *Default* | ``80.0`` |
  578. +-----------+---------------------------+
  579. | *Setter* | set_v_scroll_speed(value) |
  580. +-----------+---------------------------+
  581. | *Getter* | get_v_scroll_speed() |
  582. +-----------+---------------------------+
  583. Vertical scroll sensitivity.
  584. ----
  585. .. _class_TextEdit_property_virtual_keyboard_enabled:
  586. - :ref:`bool<class_bool>` **virtual_keyboard_enabled**
  587. +-----------+-------------------------------------+
  588. | *Default* | ``true`` |
  589. +-----------+-------------------------------------+
  590. | *Setter* | set_virtual_keyboard_enabled(value) |
  591. +-----------+-------------------------------------+
  592. | *Getter* | is_virtual_keyboard_enabled() |
  593. +-----------+-------------------------------------+
  594. If ``true``, the native virtual keyboard is shown when focused on platforms that support it.
  595. ----
  596. .. _class_TextEdit_property_wrap_enabled:
  597. - :ref:`bool<class_bool>` **wrap_enabled**
  598. +-----------+-------------------------+
  599. | *Default* | ``false`` |
  600. +-----------+-------------------------+
  601. | *Setter* | set_wrap_enabled(value) |
  602. +-----------+-------------------------+
  603. | *Getter* | is_wrap_enabled() |
  604. +-----------+-------------------------+
  605. If ``true``, enables text wrapping when it goes beyond the edge of what is visible.
  606. Method Descriptions
  607. -------------------
  608. .. _class_TextEdit_method_add_color_region:
  609. - void **add_color_region** **(** :ref:`String<class_String>` begin_key, :ref:`String<class_String>` end_key, :ref:`Color<class_Color>` color, :ref:`bool<class_bool>` line_only=false **)**
  610. Adds color region (given the delimiters) and its colors.
  611. ----
  612. .. _class_TextEdit_method_add_keyword_color:
  613. - void **add_keyword_color** **(** :ref:`String<class_String>` keyword, :ref:`Color<class_Color>` color **)**
  614. Adds a ``keyword`` and its :ref:`Color<class_Color>`.
  615. ----
  616. .. _class_TextEdit_method_can_fold:
  617. - :ref:`bool<class_bool>` **can_fold** **(** :ref:`int<class_int>` line **)** |const|
  618. Returns if the given line is foldable, that is, it has indented lines right below it.
  619. ----
  620. .. _class_TextEdit_method_center_viewport_to_cursor:
  621. - void **center_viewport_to_cursor** **(** **)**
  622. Centers the viewport on the line the editing cursor is at. This also resets the :ref:`scroll_horizontal<class_TextEdit_property_scroll_horizontal>` value to ``0``.
  623. ----
  624. .. _class_TextEdit_method_clear_colors:
  625. - void **clear_colors** **(** **)**
  626. Clears all custom syntax coloring information previously added with :ref:`add_color_region<class_TextEdit_method_add_color_region>` or :ref:`add_keyword_color<class_TextEdit_method_add_keyword_color>`.
  627. ----
  628. .. _class_TextEdit_method_clear_undo_history:
  629. - void **clear_undo_history** **(** **)**
  630. Clears the undo history.
  631. ----
  632. .. _class_TextEdit_method_copy:
  633. - void **copy** **(** **)**
  634. Copy's the current text selection.
  635. ----
  636. .. _class_TextEdit_method_cursor_get_column:
  637. - :ref:`int<class_int>` **cursor_get_column** **(** **)** |const|
  638. Returns the column the editing cursor is at.
  639. ----
  640. .. _class_TextEdit_method_cursor_get_line:
  641. - :ref:`int<class_int>` **cursor_get_line** **(** **)** |const|
  642. Returns the line the editing cursor is at.
  643. ----
  644. .. _class_TextEdit_method_cursor_set_column:
  645. - void **cursor_set_column** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=true **)**
  646. Moves the cursor at the specified ``column`` index.
  647. If ``adjust_viewport`` is set to ``true``, the viewport will center at the cursor position after the move occurs.
  648. ----
  649. .. _class_TextEdit_method_cursor_set_line:
  650. - void **cursor_set_line** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` adjust_viewport=true, :ref:`bool<class_bool>` can_be_hidden=true, :ref:`int<class_int>` wrap_index=0 **)**
  651. Moves the cursor at the specified ``line`` index.
  652. If ``adjust_viewport`` is set to ``true``, the viewport will center at the cursor position after the move occurs.
  653. If ``can_be_hidden`` is set to ``true``, the specified ``line`` can be hidden using :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`.
  654. ----
  655. .. _class_TextEdit_method_cut:
  656. - void **cut** **(** **)**
  657. Cut's the current selection.
  658. ----
  659. .. _class_TextEdit_method_deselect:
  660. - void **deselect** **(** **)**
  661. Deselects the current selection.
  662. ----
  663. .. _class_TextEdit_method_fold_all_lines:
  664. - void **fold_all_lines** **(** **)**
  665. Folds all lines that are possible to be folded (see :ref:`can_fold<class_TextEdit_method_can_fold>`).
  666. ----
  667. .. _class_TextEdit_method_fold_line:
  668. - void **fold_line** **(** :ref:`int<class_int>` line **)**
  669. Folds the given line, if possible (see :ref:`can_fold<class_TextEdit_method_can_fold>`).
  670. ----
  671. .. _class_TextEdit_method_get_breakpoints:
  672. - :ref:`Array<class_Array>` **get_breakpoints** **(** **)** |const|
  673. Returns an array containing the line number of each breakpoint.
  674. ----
  675. .. _class_TextEdit_method_get_keyword_color:
  676. - :ref:`Color<class_Color>` **get_keyword_color** **(** :ref:`String<class_String>` keyword **)** |const|
  677. Returns the :ref:`Color<class_Color>` of the specified ``keyword``.
  678. ----
  679. .. _class_TextEdit_method_get_line:
  680. - :ref:`String<class_String>` **get_line** **(** :ref:`int<class_int>` line **)** |const|
  681. Returns the text of a specific line.
  682. ----
  683. .. _class_TextEdit_method_get_line_count:
  684. - :ref:`int<class_int>` **get_line_count** **(** **)** |const|
  685. Returns the amount of total lines in the text.
  686. ----
  687. .. _class_TextEdit_method_get_menu:
  688. - :ref:`PopupMenu<class_PopupMenu>` **get_menu** **(** **)** |const|
  689. Returns the :ref:`PopupMenu<class_PopupMenu>` of this ``TextEdit``. By default, this menu is displayed when right-clicking on the ``TextEdit``.
  690. ----
  691. .. _class_TextEdit_method_get_selection_from_column:
  692. - :ref:`int<class_int>` **get_selection_from_column** **(** **)** |const|
  693. Returns the selection begin column.
  694. ----
  695. .. _class_TextEdit_method_get_selection_from_line:
  696. - :ref:`int<class_int>` **get_selection_from_line** **(** **)** |const|
  697. Returns the selection begin line.
  698. ----
  699. .. _class_TextEdit_method_get_selection_text:
  700. - :ref:`String<class_String>` **get_selection_text** **(** **)** |const|
  701. Returns the text inside the selection.
  702. ----
  703. .. _class_TextEdit_method_get_selection_to_column:
  704. - :ref:`int<class_int>` **get_selection_to_column** **(** **)** |const|
  705. Returns the selection end column.
  706. ----
  707. .. _class_TextEdit_method_get_selection_to_line:
  708. - :ref:`int<class_int>` **get_selection_to_line** **(** **)** |const|
  709. Returns the selection end line.
  710. ----
  711. .. _class_TextEdit_method_get_word_under_cursor:
  712. - :ref:`String<class_String>` **get_word_under_cursor** **(** **)** |const|
  713. Returns a :ref:`String<class_String>` text with the word under the mouse cursor location.
  714. ----
  715. .. _class_TextEdit_method_has_keyword_color:
  716. - :ref:`bool<class_bool>` **has_keyword_color** **(** :ref:`String<class_String>` keyword **)** |const|
  717. Returns whether the specified ``keyword`` has a color set to it or not.
  718. ----
  719. .. _class_TextEdit_method_insert_text_at_cursor:
  720. - void **insert_text_at_cursor** **(** :ref:`String<class_String>` text **)**
  721. Insert the specified text at the cursor position.
  722. ----
  723. .. _class_TextEdit_method_is_folded:
  724. - :ref:`bool<class_bool>` **is_folded** **(** :ref:`int<class_int>` line **)** |const|
  725. Returns whether the line at the specified index is folded or not.
  726. ----
  727. .. _class_TextEdit_method_is_line_hidden:
  728. - :ref:`bool<class_bool>` **is_line_hidden** **(** :ref:`int<class_int>` line **)** |const|
  729. Returns whether the line at the specified index is hidden or not.
  730. ----
  731. .. _class_TextEdit_method_is_selection_active:
  732. - :ref:`bool<class_bool>` **is_selection_active** **(** **)** |const|
  733. Returns ``true`` if the selection is active.
  734. ----
  735. .. _class_TextEdit_method_menu_option:
  736. - void **menu_option** **(** :ref:`int<class_int>` option **)**
  737. Triggers a right-click menu action by the specified index. See :ref:`MenuItems<enum_TextEdit_MenuItems>` for a list of available indexes.
  738. ----
  739. .. _class_TextEdit_method_paste:
  740. - void **paste** **(** **)**
  741. Paste the current selection.
  742. ----
  743. .. _class_TextEdit_method_redo:
  744. - void **redo** **(** **)**
  745. Perform redo operation.
  746. ----
  747. .. _class_TextEdit_method_remove_breakpoints:
  748. - void **remove_breakpoints** **(** **)**
  749. Removes all the breakpoints. This will not fire the :ref:`breakpoint_toggled<class_TextEdit_signal_breakpoint_toggled>` signal.
  750. ----
  751. .. _class_TextEdit_method_search:
  752. - :ref:`PoolIntArray<class_PoolIntArray>` **search** **(** :ref:`String<class_String>` key, :ref:`int<class_int>` flags, :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column **)** |const|
  753. Perform a search inside the text. Search flags can be specified in the :ref:`SearchFlags<enum_TextEdit_SearchFlags>` enum.
  754. Returns an empty ``PoolIntArray`` if no result was found. Otherwise, the result line and column can be accessed at indices specified in the :ref:`SearchResult<enum_TextEdit_SearchResult>` enum, e.g:
  755. ::
  756. var result = search(key, flags, line, column)
  757. if result.size() > 0:
  758. # Result found.
  759. var res_line = result[TextEdit.SEARCH_RESULT_LINE]
  760. var res_column = result[TextEdit.SEARCH_RESULT_COLUMN]
  761. ----
  762. .. _class_TextEdit_method_select:
  763. - void **select** **(** :ref:`int<class_int>` from_line, :ref:`int<class_int>` from_column, :ref:`int<class_int>` to_line, :ref:`int<class_int>` to_column **)**
  764. Perform selection, from line/column to line/column.
  765. If :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` is ``false``, no selection will occur.
  766. ----
  767. .. _class_TextEdit_method_select_all:
  768. - void **select_all** **(** **)**
  769. Select all the text.
  770. If :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` is ``false``, no selection will occur.
  771. ----
  772. .. _class_TextEdit_method_set_line:
  773. - void **set_line** **(** :ref:`int<class_int>` line, :ref:`String<class_String>` new_text **)**
  774. Sets the text for a specific line.
  775. ----
  776. .. _class_TextEdit_method_set_line_as_hidden:
  777. - void **set_line_as_hidden** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**
  778. If ``true``, hides the line of the specified index.
  779. ----
  780. .. _class_TextEdit_method_toggle_fold_line:
  781. - void **toggle_fold_line** **(** :ref:`int<class_int>` line **)**
  782. Toggle the folding of the code block at the given line.
  783. ----
  784. .. _class_TextEdit_method_undo:
  785. - void **undo** **(** **)**
  786. Perform undo operation.
  787. ----
  788. .. _class_TextEdit_method_unfold_line:
  789. - void **unfold_line** **(** :ref:`int<class_int>` line **)**
  790. Unfolds the given line, if folded.
  791. ----
  792. .. _class_TextEdit_method_unhide_all_lines:
  793. - void **unhide_all_lines** **(** **)**
  794. Unhide all lines that were previously set to hidden by :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`.
  795. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  796. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  797. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`