Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: a9ccac82ea
Branches Tags
godot-docs
/
classes
/
class_textedit.rst

class_textedit.rst 46 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the TextEdit.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_TextEdit:
    6. 

  6. 

  7. TextEdit
    8. 

  8. ========
    9. 

  9. 

  10. **Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Multiline text editing control.
    18. 

  18. 

  19. Properties
    20. 

  20. ----------
    21. 

  21. 

  22. +-----------------------------+-------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`bool<class_bool>`     | :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>`                       |
    24. 

  24. +-----------------------------+-------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`bool<class_bool>`     | :ref:`caret_blink<class_TextEdit_property_caret_blink>`                                   |
    26. 

  26. +-----------------------------+-------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`float<class_float>`   | :ref:`caret_blink_speed<class_TextEdit_property_caret_blink_speed>`                       |
    28. 

  28. +-----------------------------+-------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`bool<class_bool>`     | :ref:`caret_block_mode<class_TextEdit_property_caret_block_mode>`                         |
    30. 

  30. +-----------------------------+-------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`bool<class_bool>`     | :ref:`caret_moving_by_right_click<class_TextEdit_property_caret_moving_by_right_click>`   |
    32. 

  32. +-----------------------------+-------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`bool<class_bool>`     | :ref:`context_menu_enabled<class_TextEdit_property_context_menu_enabled>`                 |
    34. 

  34. +-----------------------------+-------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`int<class_int>`       | :ref:`hiding_enabled<class_TextEdit_property_hiding_enabled>`                             |
    36. 

  36. +-----------------------------+-------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`bool<class_bool>`     | :ref:`highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>`       |
    38. 

  38. +-----------------------------+-------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`bool<class_bool>`     | :ref:`highlight_current_line<class_TextEdit_property_highlight_current_line>`             |
    40. 

  40. +-----------------------------+-------------------------------------------------------------------------------------------+
    41. 

  41. | :ref:`bool<class_bool>`     | :ref:`override_selected_font_color<class_TextEdit_property_override_selected_font_color>` |
    42. 

  42. +-----------------------------+-------------------------------------------------------------------------------------------+
    43. 

  43. | :ref:`bool<class_bool>`     | :ref:`readonly<class_TextEdit_property_readonly>`                                         |
    44. 

  44. +-----------------------------+-------------------------------------------------------------------------------------------+
    45. 

  45. | :ref:`bool<class_bool>`     | :ref:`show_line_numbers<class_TextEdit_property_show_line_numbers>`                       |
    46. 

  46. +-----------------------------+-------------------------------------------------------------------------------------------+
    47. 

  47. | :ref:`bool<class_bool>`     | :ref:`smooth_scrolling<class_TextEdit_property_smooth_scrolling>`                         |
    48. 

  48. +-----------------------------+-------------------------------------------------------------------------------------------+
    49. 

  49. | :ref:`bool<class_bool>`     | :ref:`syntax_highlighting<class_TextEdit_property_syntax_highlighting>`                   |
    50. 

  50. +-----------------------------+-------------------------------------------------------------------------------------------+
    51. 

  51. | :ref:`String<class_String>` | :ref:`text<class_TextEdit_property_text>`                                                 |
    52. 

  52. +-----------------------------+-------------------------------------------------------------------------------------------+
    53. 

  53. | :ref:`float<class_float>`   | :ref:`v_scroll_speed<class_TextEdit_property_v_scroll_speed>`                             |
    54. 

  54. +-----------------------------+-------------------------------------------------------------------------------------------+
    55. 

  55. | :ref:`bool<class_bool>`     | :ref:`wrap_enabled<class_TextEdit_property_wrap_enabled>`                                 |
    56. 

  56. +-----------------------------+-------------------------------------------------------------------------------------------+
    57. 

  57. 

  58. Methods
    59. 

  59. -------
    60. 

  60. 

  61. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. | 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 **)**   |
    63. 

  63. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    64. 

  64. | void                                    | :ref:`add_keyword_color<class_TextEdit_method_add_keyword_color>` **(** :ref:`String<class_String>` keyword, :ref:`Color<class_Color>` color **)**                                                                                 |
    65. 

  65. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    66. 

  66. | :ref:`bool<class_bool>`                 | :ref:`can_fold<class_TextEdit_method_can_fold>` **(** :ref:`int<class_int>` line **)** const                                                                                                                                       |
    67. 

  67. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    68. 

  68. | void                                    | :ref:`clear_colors<class_TextEdit_method_clear_colors>` **(** **)**                                                                                                                                                                |
    69. 

  69. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    70. 

  70. | void                                    | :ref:`clear_undo_history<class_TextEdit_method_clear_undo_history>` **(** **)**                                                                                                                                                    |
    71. 

  71. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    72. 

  72. | void                                    | :ref:`copy<class_TextEdit_method_copy>` **(** **)**                                                                                                                                                                                |
    73. 

  73. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    74. 

  74. | :ref:`int<class_int>`                   | :ref:`cursor_get_column<class_TextEdit_method_cursor_get_column>` **(** **)** const                                                                                                                                                |
    75. 

  75. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    76. 

  76. | :ref:`int<class_int>`                   | :ref:`cursor_get_line<class_TextEdit_method_cursor_get_line>` **(** **)** const                                                                                                                                                    |
    77. 

  77. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    78. 

  78. | void                                    | :ref:`cursor_set_column<class_TextEdit_method_cursor_set_column>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=true **)**                                                                           |
    79. 

  79. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    80. 

  80. | 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 **)** |
    81. 

  81. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    82. 

  82. | void                                    | :ref:`cut<class_TextEdit_method_cut>` **(** **)**                                                                                                                                                                                  |
    83. 

  83. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    84. 

  84. | void                                    | :ref:`deselect<class_TextEdit_method_deselect>` **(** **)**                                                                                                                                                                        |
    85. 

  85. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    86. 

  86. | void                                    | :ref:`fold_all_lines<class_TextEdit_method_fold_all_lines>` **(** **)**                                                                                                                                                            |
    87. 

  87. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    88. 

  88. | void                                    | :ref:`fold_line<class_TextEdit_method_fold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                           |
    89. 

  89. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    90. 

  90. | :ref:`Array<class_Array>`               | :ref:`get_breakpoints<class_TextEdit_method_get_breakpoints>` **(** **)** const                                                                                                                                                    |
    91. 

  91. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    92. 

  92. | :ref:`Color<class_Color>`               | :ref:`get_keyword_color<class_TextEdit_method_get_keyword_color>` **(** :ref:`String<class_String>` keyword **)** const                                                                                                            |
    93. 

  93. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94. | :ref:`String<class_String>`             | :ref:`get_line<class_TextEdit_method_get_line>` **(** :ref:`int<class_int>` line **)** const                                                                                                                                       |
    95. 

  95. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96. | :ref:`int<class_int>`                   | :ref:`get_line_count<class_TextEdit_method_get_line_count>` **(** **)** const                                                                                                                                                      |
    97. 

  97. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    98. 

  98. | :ref:`PopupMenu<class_PopupMenu>`       | :ref:`get_menu<class_TextEdit_method_get_menu>` **(** **)** const                                                                                                                                                                  |
    99. 

  99. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    100. 

  100. | :ref:`int<class_int>`                   | :ref:`get_selection_from_column<class_TextEdit_method_get_selection_from_column>` **(** **)** const                                                                                                                                |
    101. 

  101. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    102. 

  102. | :ref:`int<class_int>`                   | :ref:`get_selection_from_line<class_TextEdit_method_get_selection_from_line>` **(** **)** const                                                                                                                                    |
    103. 

  103. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    104. 

  104. | :ref:`String<class_String>`             | :ref:`get_selection_text<class_TextEdit_method_get_selection_text>` **(** **)** const                                                                                                                                              |
    105. 

  105. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    106. 

  106. | :ref:`int<class_int>`                   | :ref:`get_selection_to_column<class_TextEdit_method_get_selection_to_column>` **(** **)** const                                                                                                                                    |
    107. 

  107. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    108. 

  108. | :ref:`int<class_int>`                   | :ref:`get_selection_to_line<class_TextEdit_method_get_selection_to_line>` **(** **)** const                                                                                                                                        |
    109. 

  109. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    110. 

  110. | :ref:`String<class_String>`             | :ref:`get_word_under_cursor<class_TextEdit_method_get_word_under_cursor>` **(** **)** const                                                                                                                                        |
    111. 

  111. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    112. 

  112. | :ref:`bool<class_bool>`                 | :ref:`has_keyword_color<class_TextEdit_method_has_keyword_color>` **(** :ref:`String<class_String>` keyword **)** const                                                                                                            |
    113. 

  113. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    114. 

  114. | void                                    | :ref:`insert_text_at_cursor<class_TextEdit_method_insert_text_at_cursor>` **(** :ref:`String<class_String>` text **)**                                                                                                             |
    115. 

  115. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    116. 

  116. | :ref:`bool<class_bool>`                 | :ref:`is_folded<class_TextEdit_method_is_folded>` **(** :ref:`int<class_int>` line **)** const                                                                                                                                     |
    117. 

  117. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    118. 

  118. | :ref:`bool<class_bool>`                 | :ref:`is_line_hidden<class_TextEdit_method_is_line_hidden>` **(** :ref:`int<class_int>` line **)** const                                                                                                                           |
    119. 

  119. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    120. 

  120. | :ref:`bool<class_bool>`                 | :ref:`is_selection_active<class_TextEdit_method_is_selection_active>` **(** **)** const                                                                                                                                            |
    121. 

  121. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    122. 

  122. | void                                    | :ref:`menu_option<class_TextEdit_method_menu_option>` **(** :ref:`int<class_int>` option **)**                                                                                                                                     |
    123. 

  123. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    124. 

  124. | void                                    | :ref:`paste<class_TextEdit_method_paste>` **(** **)**                                                                                                                                                                              |
    125. 

  125. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    126. 

  126. | void                                    | :ref:`redo<class_TextEdit_method_redo>` **(** **)**                                                                                                                                                                                |
    127. 

  127. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    128. 

  128. | void                                    | :ref:`remove_breakpoints<class_TextEdit_method_remove_breakpoints>` **(** **)**                                                                                                                                                    |
    129. 

  129. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    130. 

  130. | :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                                     |
    131. 

  131. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    132. 

  132. | 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 **)**                                         |
    133. 

  133. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    134. 

  134. | void                                    | :ref:`select_all<class_TextEdit_method_select_all>` **(** **)**                                                                                                                                                                    |
    135. 

  135. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    136. 

  136. | void                                    | :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**                                                                                         |
    137. 

  137. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    138. 

  138. | void                                    | :ref:`toggle_fold_line<class_TextEdit_method_toggle_fold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                             |
    139. 

  139. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    140. 

  140. | void                                    | :ref:`undo<class_TextEdit_method_undo>` **(** **)**                                                                                                                                                                                |
    141. 

  141. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    142. 

  142. | void                                    | :ref:`unfold_line<class_TextEdit_method_unfold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                       |
    143. 

  143. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    144. 

  144. | void                                    | :ref:`unhide_all_lines<class_TextEdit_method_unhide_all_lines>` **(** **)**                                                                                                                                                        |
    145. 

  145. +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    146. 

  146. 

  147. Theme Properties
    148. 

  148. ----------------
    149. 

  149. 

  150. +---------------------------------+-----------------------------+
    151. 

  151. | :ref:`Color<class_Color>`       | background_color            |
    152. 

  152. +---------------------------------+-----------------------------+
    153. 

  153. | :ref:`Color<class_Color>`       | brace_mismatch_color        |
    154. 

  154. +---------------------------------+-----------------------------+
    155. 

  155. | :ref:`Color<class_Color>`       | breakpoint_color            |
    156. 

  156. +---------------------------------+-----------------------------+
    157. 

  157. | :ref:`Color<class_Color>`       | caret_background_color      |
    158. 

  158. +---------------------------------+-----------------------------+
    159. 

  159. | :ref:`Color<class_Color>`       | caret_color                 |
    160. 

  160. +---------------------------------+-----------------------------+
    161. 

  161. | :ref:`Color<class_Color>`       | code_folding_color          |
    162. 

  162. +---------------------------------+-----------------------------+
    163. 

  163. | :ref:`StyleBox<class_StyleBox>` | completion                  |
    164. 

  164. +---------------------------------+-----------------------------+
    165. 

  165. | :ref:`Color<class_Color>`       | completion_background_color |
    166. 

  166. +---------------------------------+-----------------------------+
    167. 

  167. | :ref:`Color<class_Color>`       | completion_existing_color   |
    168. 

  168. +---------------------------------+-----------------------------+
    169. 

  169. | :ref:`Color<class_Color>`       | completion_font_color       |
    170. 

  170. +---------------------------------+-----------------------------+
    171. 

  171. | :ref:`int<class_int>`           | completion_lines            |
    172. 

  172. +---------------------------------+-----------------------------+
    173. 

  173. | :ref:`int<class_int>`           | completion_max_width        |
    174. 

  174. +---------------------------------+-----------------------------+
    175. 

  175. | :ref:`Color<class_Color>`       | completion_scroll_color     |
    176. 

  176. +---------------------------------+-----------------------------+
    177. 

  177. | :ref:`int<class_int>`           | completion_scroll_width     |
    178. 

  178. +---------------------------------+-----------------------------+
    179. 

  179. | :ref:`Color<class_Color>`       | completion_selected_color   |
    180. 

  180. +---------------------------------+-----------------------------+
    181. 

  181. | :ref:`Color<class_Color>`       | current_line_color          |
    182. 

  182. +---------------------------------+-----------------------------+
    183. 

  183. | :ref:`StyleBox<class_StyleBox>` | focus                       |
    184. 

  184. +---------------------------------+-----------------------------+
    185. 

  185. | :ref:`Font<class_Font>`         | font                        |
    186. 

  186. +---------------------------------+-----------------------------+
    187. 

  187. | :ref:`Color<class_Color>`       | font_color                  |
    188. 

  188. +---------------------------------+-----------------------------+
    189. 

  189. | :ref:`Color<class_Color>`       | font_color_selected         |
    190. 

  190. +---------------------------------+-----------------------------+
    191. 

  191. | :ref:`Color<class_Color>`       | function_color              |
    192. 

  192. +---------------------------------+-----------------------------+
    193. 

  193. | :ref:`Color<class_Color>`       | line_number_color           |
    194. 

  194. +---------------------------------+-----------------------------+
    195. 

  195. | :ref:`int<class_int>`           | line_spacing                |
    196. 

  196. +---------------------------------+-----------------------------+
    197. 

  197. | :ref:`Color<class_Color>`       | mark_color                  |
    198. 

  198. +---------------------------------+-----------------------------+
    199. 

  199. | :ref:`Color<class_Color>`       | member_variable_color       |
    200. 

  200. +---------------------------------+-----------------------------+
    201. 

  201. | :ref:`StyleBox<class_StyleBox>` | normal                      |
    202. 

  202. +---------------------------------+-----------------------------+
    203. 

  203. | :ref:`Color<class_Color>`       | number_color                |
    204. 

  204. +---------------------------------+-----------------------------+
    205. 

  205. | :ref:`StyleBox<class_StyleBox>` | read_only                   |
    206. 

  206. +---------------------------------+-----------------------------+
    207. 

  207. | :ref:`Color<class_Color>`       | safe_line_number_color      |
    208. 

  208. +---------------------------------+-----------------------------+
    209. 

  209. | :ref:`Color<class_Color>`       | selection_color             |
    210. 

  210. +---------------------------------+-----------------------------+
    211. 

  211. | :ref:`Color<class_Color>`       | symbol_color                |
    212. 

  212. +---------------------------------+-----------------------------+
    213. 

  213. | :ref:`Texture<class_Texture>`   | tab                         |
    214. 

  214. +---------------------------------+-----------------------------+
    215. 

  215. | :ref:`Color<class_Color>`       | word_highlighted_color      |
    216. 

  216. +---------------------------------+-----------------------------+
    217. 

  217. 

  218. Signals
    219. 

  219. -------
    220. 

  220. 

  221. .. _class_TextEdit_signal_breakpoint_toggled:
    222. 

  222. 

  223. - **breakpoint_toggled** **(** :ref:`int<class_int>` row **)**
    224. 

  224. 

  225. Emitted when a breakpoint is placed via the breakpoint gutter.
    226. 

  226. 

  227. .. _class_TextEdit_signal_cursor_changed:
    228. 

  228. 

  229. - **cursor_changed** **(** **)**
    230. 

  230. 

  231. Emitted when the cursor changes.
    232. 

  232. 

  233. .. _class_TextEdit_signal_request_completion:
    234. 

  234. 

  235. - **request_completion** **(** **)**
    236. 

  236. 

  237. .. _class_TextEdit_signal_symbol_lookup:
    238. 

  238. 

  239. - **symbol_lookup** **(** :ref:`String<class_String>` symbol, :ref:`int<class_int>` row, :ref:`int<class_int>` column **)**
    240. 

  240. 

  241. .. _class_TextEdit_signal_text_changed:
    242. 

  242. 

  243. - **text_changed** **(** **)**
    244. 

  244. 

  245. Emitted when the text changes.
    246. 

  246. 

  247. Enumerations
    248. 

  248. ------------
    249. 

  249. 

  250. .. _enum_TextEdit_SearchFlags:
    251. 

  251. 

  252. .. _class_TextEdit_constant_SEARCH_MATCH_CASE:
    253. 

  253. 

  254. .. _class_TextEdit_constant_SEARCH_WHOLE_WORDS:
    255. 

  255. 

  256. .. _class_TextEdit_constant_SEARCH_BACKWARDS:
    257. 

  257. 

  258. enum **SearchFlags**:
    259. 

  259. 

  260. - **SEARCH_MATCH_CASE** = **1** --- Match case when searching.
    261. 

  261. 

  262. - **SEARCH_WHOLE_WORDS** = **2** --- Match whole words when searching.
    263. 

  263. 

  264. - **SEARCH_BACKWARDS** = **4** --- Search from end to beginning.
    265. 

  265. 

  266. .. _enum_TextEdit_MenuItems:
    267. 

  267. 

  268. .. _class_TextEdit_constant_MENU_CUT:
    269. 

  269. 

  270. .. _class_TextEdit_constant_MENU_COPY:
    271. 

  271. 

  272. .. _class_TextEdit_constant_MENU_PASTE:
    273. 

  273. 

  274. .. _class_TextEdit_constant_MENU_CLEAR:
    275. 

  275. 

  276. .. _class_TextEdit_constant_MENU_SELECT_ALL:
    277. 

  277. 

  278. .. _class_TextEdit_constant_MENU_UNDO:
    279. 

  279. 

  280. .. _class_TextEdit_constant_MENU_REDO:
    281. 

  281. 

  282. .. _class_TextEdit_constant_MENU_MAX:
    283. 

  283. 

  284. enum **MenuItems**:
    285. 

  285. 

  286. - **MENU_CUT** = **0** --- Cuts (Copies and clears) the selected text.
    287. 

  287. 

  288. - **MENU_COPY** = **1** --- Copies the selected text.
    289. 

  289. 

  290. - **MENU_PASTE** = **2** --- Pastes the clipboard text over the selected text (or at the cursor's position).
    291. 

  291. 

  292. - **MENU_CLEAR** = **3** --- Erases the whole :ref:`TextEdit<class_TextEdit>` text.
    293. 

  293. 

  294. - **MENU_SELECT_ALL** = **4** --- Selects the whole :ref:`TextEdit<class_TextEdit>` text.
    295. 

  295. 

  296. - **MENU_UNDO** = **5** --- Undoes the previous action.
    297. 

  297. 

  298. - **MENU_REDO** = **6**
    299. 

  299. 

  300. - **MENU_MAX** = **7**
    301. 

  301. 

  302. Description
    303. 

  303. -----------
    304. 

  304. 

  305. 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.
    306. 

  306. 

  307. Property Descriptions
    308. 

  308. ---------------------
    309. 

  309. 

  310. .. _class_TextEdit_property_breakpoint_gutter:
    311. 

  311. 

  312. - :ref:`bool<class_bool>` **breakpoint_gutter**
    313. 

  313. 

  314. +----------+--------------------------------------+
    315. 

  315. | *Setter* | set_breakpoint_gutter_enabled(value) |
    316. 

  316. +----------+--------------------------------------+
    317. 

  317. | *Getter* | is_breakpoint_gutter_enabled()       |
    318. 

  318. +----------+--------------------------------------+
    319. 

  319. 

  320. If ``true``, the breakpoint gutter is visible.
    321. 

  321. 

  322. .. _class_TextEdit_property_caret_blink:
    323. 

  323. 

  324. - :ref:`bool<class_bool>` **caret_blink**
    325. 

  325. 

  326. +----------+---------------------------------+
    327. 

  327. | *Setter* | cursor_set_blink_enabled(value) |
    328. 

  328. +----------+---------------------------------+
    329. 

  329. | *Getter* | cursor_get_blink_enabled()      |
    330. 

  330. +----------+---------------------------------+
    331. 

  331. 

  332. If ``true``, the caret (visual cursor) blinks.
    333. 

  333. 

  334. .. _class_TextEdit_property_caret_blink_speed:
    335. 

  335. 

  336. - :ref:`float<class_float>` **caret_blink_speed**
    337. 

  337. 

  338. +----------+-------------------------------+
    339. 

  339. | *Setter* | cursor_set_blink_speed(value) |
    340. 

  340. +----------+-------------------------------+
    341. 

  341. | *Getter* | cursor_get_blink_speed()      |
    342. 

  342. +----------+-------------------------------+
    343. 

  343. 

  344. Duration (in seconds) of a caret's blinking cycle.
    345. 

  345. 

  346. .. _class_TextEdit_property_caret_block_mode:
    347. 

  347. 

  348. - :ref:`bool<class_bool>` **caret_block_mode**
    349. 

  349. 

  350. +----------+------------------------------+
    351. 

  351. | *Setter* | cursor_set_block_mode(value) |
    352. 

  352. +----------+------------------------------+
    353. 

  353. | *Getter* | cursor_is_block_mode()       |
    354. 

  354. +----------+------------------------------+
    355. 

  355. 

  356. If ``true``, the caret displays as a rectangle.
    357. 

  357. 

  358. If ``false``, the caret displays as a bar.
    359. 

  359. 

  360. .. _class_TextEdit_property_caret_moving_by_right_click:
    361. 

  361. 

  362. - :ref:`bool<class_bool>` **caret_moving_by_right_click**
    363. 

  363. 

  364. +----------+------------------------------------+
    365. 

  365. | *Setter* | set_right_click_moves_caret(value) |
    366. 

  366. +----------+------------------------------------+
    367. 

  367. | *Getter* | is_right_click_moving_caret()      |
    368. 

  368. +----------+------------------------------------+
    369. 

  369. 

  370. If ``true``, a right click moves the cursor at the mouse position before displaying the context menu.
    371. 

  371. 

  372. If ``false``, the context menu disregards mouse location.
    373. 

  373. 

  374. .. _class_TextEdit_property_context_menu_enabled:
    375. 

  375. 

  376. - :ref:`bool<class_bool>` **context_menu_enabled**
    377. 

  377. 

  378. +----------+---------------------------------+
    379. 

  379. | *Setter* | set_context_menu_enabled(value) |
    380. 

  380. +----------+---------------------------------+
    381. 

  381. | *Getter* | is_context_menu_enabled()       |
    382. 

  382. +----------+---------------------------------+
    383. 

  383. 

  384. If ``true``, a right click displays the context menu.
    385. 

  385. 

  386. .. _class_TextEdit_property_hiding_enabled:
    387. 

  387. 

  388. - :ref:`int<class_int>` **hiding_enabled**
    389. 

  389. 

  390. +----------+---------------------------+
    391. 

  391. | *Setter* | set_hiding_enabled(value) |
    392. 

  392. +----------+---------------------------+
    393. 

  393. | *Getter* | is_hiding_enabled()       |
    394. 

  394. +----------+---------------------------+
    395. 

  395. 

  396. .. _class_TextEdit_property_highlight_all_occurrences:
    397. 

  397. 

  398. - :ref:`bool<class_bool>` **highlight_all_occurrences**
    399. 

  399. 

  400. +----------+----------------------------------------+
    401. 

  401. | *Setter* | set_highlight_all_occurrences(value)   |
    402. 

  402. +----------+----------------------------------------+
    403. 

  403. | *Getter* | is_highlight_all_occurrences_enabled() |
    404. 

  404. +----------+----------------------------------------+
    405. 

  405. 

  406. .. _class_TextEdit_property_highlight_current_line:
    407. 

  407. 

  408. - :ref:`bool<class_bool>` **highlight_current_line**
    409. 

  409. 

  410. +----------+-------------------------------------+
    411. 

  411. | *Setter* | set_highlight_current_line(value)   |
    412. 

  412. +----------+-------------------------------------+
    413. 

  413. | *Getter* | is_highlight_current_line_enabled() |
    414. 

  414. +----------+-------------------------------------+
    415. 

  415. 

  416. If ``true``, the line containing the cursor is highlighted.
    417. 

  417. 

  418. .. _class_TextEdit_property_override_selected_font_color:
    419. 

  419. 

  420. - :ref:`bool<class_bool>` **override_selected_font_color**
    421. 

  421. 

  422. +----------+-----------------------------------------+
    423. 

  423. | *Setter* | set_override_selected_font_color(value) |
    424. 

  424. +----------+-----------------------------------------+
    425. 

  425. | *Getter* | is_overriding_selected_font_color()     |
    426. 

  426. +----------+-----------------------------------------+
    427. 

  427. 

  428. .. _class_TextEdit_property_readonly:
    429. 

  429. 

  430. - :ref:`bool<class_bool>` **readonly**
    431. 

  431. 

  432. +----------+---------------------+
    433. 

  433. | *Setter* | set_readonly(value) |
    434. 

  434. +----------+---------------------+
    435. 

  435. | *Getter* | is_readonly()       |
    436. 

  436. +----------+---------------------+
    437. 

  437. 

  438. If ``true``, read-only mode is enabled. Existing text cannot be modified and new text cannot be added.
    439. 

  439. 

  440. .. _class_TextEdit_property_show_line_numbers:
    441. 

  441. 

  442. - :ref:`bool<class_bool>` **show_line_numbers**
    443. 

  443. 

  444. +----------+--------------------------------+
    445. 

  445. | *Setter* | set_show_line_numbers(value)   |
    446. 

  446. +----------+--------------------------------+
    447. 

  447. | *Getter* | is_show_line_numbers_enabled() |
    448. 

  448. +----------+--------------------------------+
    449. 

  449. 

  450. If ``true``, line numbers are displayed to the left of the text.
    451. 

  451. 

  452. .. _class_TextEdit_property_smooth_scrolling:
    453. 

  453. 

  454. - :ref:`bool<class_bool>` **smooth_scrolling**
    455. 

  455. 

  456. +----------+---------------------------------+
    457. 

  457. | *Setter* | set_smooth_scroll_enable(value) |
    458. 

  458. +----------+---------------------------------+
    459. 

  459. | *Getter* | is_smooth_scroll_enabled()      |
    460. 

  460. +----------+---------------------------------+
    461. 

  461. 

  462. .. _class_TextEdit_property_syntax_highlighting:
    463. 

  463. 

  464. - :ref:`bool<class_bool>` **syntax_highlighting**
    465. 

  465. 

  466. +----------+------------------------------+
    467. 

  467. | *Setter* | set_syntax_coloring(value)   |
    468. 

  468. +----------+------------------------------+
    469. 

  469. | *Getter* | is_syntax_coloring_enabled() |
    470. 

  470. +----------+------------------------------+
    471. 

  471. 

  472. .. _class_TextEdit_property_text:
    473. 

  473. 

  474. - :ref:`String<class_String>` **text**
    475. 

  475. 

  476. +----------+-----------------+
    477. 

  477. | *Setter* | set_text(value) |
    478. 

  478. +----------+-----------------+
    479. 

  479. | *Getter* | get_text()      |
    480. 

  480. +----------+-----------------+
    481. 

  481. 

  482. String value of the :ref:`TextEdit<class_TextEdit>`.
    483. 

  483. 

  484. .. _class_TextEdit_property_v_scroll_speed:
    485. 

  485. 

  486. - :ref:`float<class_float>` **v_scroll_speed**
    487. 

  487. 

  488. +----------+---------------------------+
    489. 

  489. | *Setter* | set_v_scroll_speed(value) |
    490. 

  490. +----------+---------------------------+
    491. 

  491. | *Getter* | get_v_scroll_speed()      |
    492. 

  492. +----------+---------------------------+
    493. 

  493. 

  494. If ``true``, enables text wrapping when it goes beyond he edge of what is visible.
    495. 

  495. 

  496. .. _class_TextEdit_property_wrap_enabled:
    497. 

  497. 

  498. - :ref:`bool<class_bool>` **wrap_enabled**
    499. 

  499. 

  500. +----------+-------------------------+
    501. 

  501. | *Setter* | set_wrap_enabled(value) |
    502. 

  502. +----------+-------------------------+
    503. 

  503. | *Getter* | is_wrap_enabled()       |
    504. 

  504. +----------+-------------------------+
    505. 

  505. 

  506. Method Descriptions
    507. 

  507. -------------------
    508. 

  508. 

  509. .. _class_TextEdit_method_add_color_region:
    510. 

  510. 

  511. - 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 **)**
    512. 

  512. 

  513. Add color region (given the delimiters) and its colors.
    514. 

  514. 

  515. .. _class_TextEdit_method_add_keyword_color:
    516. 

  516. 

  517. - void **add_keyword_color** **(** :ref:`String<class_String>` keyword, :ref:`Color<class_Color>` color **)**
    518. 

  518. 

  519. Add a keyword and its color.
    520. 

  520. 

  521. .. _class_TextEdit_method_can_fold:
    522. 

  522. 

  523. - :ref:`bool<class_bool>` **can_fold** **(** :ref:`int<class_int>` line **)** const
    524. 

  524. 

  525. .. _class_TextEdit_method_clear_colors:
    526. 

  526. 

  527. - void **clear_colors** **(** **)**
    528. 

  528. 

  529. Clear all the syntax coloring information.
    530. 

  530. 

  531. .. _class_TextEdit_method_clear_undo_history:
    532. 

  532. 

  533. - void **clear_undo_history** **(** **)**
    534. 

  534. 

  535. Clear the undo history.
    536. 

  536. 

  537. .. _class_TextEdit_method_copy:
    538. 

  538. 

  539. - void **copy** **(** **)**
    540. 

  540. 

  541. Copy the current selection.
    542. 

  542. 

  543. .. _class_TextEdit_method_cursor_get_column:
    544. 

  544. 

  545. - :ref:`int<class_int>` **cursor_get_column** **(** **)** const
    546. 

  546. 

  547. Return the column the editing cursor is at.
    548. 

  548. 

  549. .. _class_TextEdit_method_cursor_get_line:
    550. 

  550. 

  551. - :ref:`int<class_int>` **cursor_get_line** **(** **)** const
    552. 

  552. 

  553. Return the line the editing cursor is at.
    554. 

  554. 

  555. .. _class_TextEdit_method_cursor_set_column:
    556. 

  556. 

  557. - void **cursor_set_column** **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=true **)**
    558. 

  558. 

  559. .. _class_TextEdit_method_cursor_set_line:
    560. 

  560. 

  561. - 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 **)**
    562. 

  562. 

  563. .. _class_TextEdit_method_cut:
    564. 

  564. 

  565. - void **cut** **(** **)**
    566. 

  566. 

  567. Cut the current selection.
    568. 

  568. 

  569. .. _class_TextEdit_method_deselect:
    570. 

  570. 

  571. - void **deselect** **(** **)**
    572. 

  572. 

  573. Clears the current selection.
    574. 

  574. 

  575. .. _class_TextEdit_method_fold_all_lines:
    576. 

  576. 

  577. - void **fold_all_lines** **(** **)**
    578. 

  578. 

  579. .. _class_TextEdit_method_fold_line:
    580. 

  580. 

  581. - void **fold_line** **(** :ref:`int<class_int>` line **)**
    582. 

  582. 

  583. .. _class_TextEdit_method_get_breakpoints:
    584. 

  584. 

  585. - :ref:`Array<class_Array>` **get_breakpoints** **(** **)** const
    586. 

  586. 

  587. Return an array containing the line number of each breakpoint.
    588. 

  588. 

  589. .. _class_TextEdit_method_get_keyword_color:
    590. 

  590. 

  591. - :ref:`Color<class_Color>` **get_keyword_color** **(** :ref:`String<class_String>` keyword **)** const
    592. 

  592. 

  593. .. _class_TextEdit_method_get_line:
    594. 

  594. 

  595. - :ref:`String<class_String>` **get_line** **(** :ref:`int<class_int>` line **)** const
    596. 

  596. 

  597. Return the text of a specific line.
    598. 

  598. 

  599. .. _class_TextEdit_method_get_line_count:
    600. 

  600. 

  601. - :ref:`int<class_int>` **get_line_count** **(** **)** const
    602. 

  602. 

  603. Return the amount of total lines in the text.
    604. 

  604. 

  605. .. _class_TextEdit_method_get_menu:
    606. 

  606. 

  607. - :ref:`PopupMenu<class_PopupMenu>` **get_menu** **(** **)** const
    608. 

  608. 

  609. .. _class_TextEdit_method_get_selection_from_column:
    610. 

  610. 

  611. - :ref:`int<class_int>` **get_selection_from_column** **(** **)** const
    612. 

  612. 

  613. Return the selection begin column.
    614. 

  614. 

  615. .. _class_TextEdit_method_get_selection_from_line:
    616. 

  616. 

  617. - :ref:`int<class_int>` **get_selection_from_line** **(** **)** const
    618. 

  618. 

  619. Return the selection begin line.
    620. 

  620. 

  621. .. _class_TextEdit_method_get_selection_text:
    622. 

  622. 

  623. - :ref:`String<class_String>` **get_selection_text** **(** **)** const
    624. 

  624. 

  625. Return the text inside the selection.
    626. 

  626. 

  627. .. _class_TextEdit_method_get_selection_to_column:
    628. 

  628. 

  629. - :ref:`int<class_int>` **get_selection_to_column** **(** **)** const
    630. 

  630. 

  631. Return the selection end column.
    632. 

  632. 

  633. .. _class_TextEdit_method_get_selection_to_line:
    634. 

  634. 

  635. - :ref:`int<class_int>` **get_selection_to_line** **(** **)** const
    636. 

  636. 

  637. Return the selection end line.
    638. 

  638. 

  639. .. _class_TextEdit_method_get_word_under_cursor:
    640. 

  640. 

  641. - :ref:`String<class_String>` **get_word_under_cursor** **(** **)** const
    642. 

  642. 

  643. .. _class_TextEdit_method_has_keyword_color:
    644. 

  644. 

  645. - :ref:`bool<class_bool>` **has_keyword_color** **(** :ref:`String<class_String>` keyword **)** const
    646. 

  646. 

  647. .. _class_TextEdit_method_insert_text_at_cursor:
    648. 

  648. 

  649. - void **insert_text_at_cursor** **(** :ref:`String<class_String>` text **)**
    650. 

  650. 

  651. Insert a given text at the cursor position.
    652. 

  652. 

  653. .. _class_TextEdit_method_is_folded:
    654. 

  654. 

  655. - :ref:`bool<class_bool>` **is_folded** **(** :ref:`int<class_int>` line **)** const
    656. 

  656. 

  657. .. _class_TextEdit_method_is_line_hidden:
    658. 

  658. 

  659. - :ref:`bool<class_bool>` **is_line_hidden** **(** :ref:`int<class_int>` line **)** const
    660. 

  660. 

  661. .. _class_TextEdit_method_is_selection_active:
    662. 

  662. 

  663. - :ref:`bool<class_bool>` **is_selection_active** **(** **)** const
    664. 

  664. 

  665. Return true if the selection is active.
    666. 

  666. 

  667. .. _class_TextEdit_method_menu_option:
    668. 

  668. 

  669. - void **menu_option** **(** :ref:`int<class_int>` option **)**
    670. 

  670. 

  671. .. _class_TextEdit_method_paste:
    672. 

  672. 

  673. - void **paste** **(** **)**
    674. 

  674. 

  675. Paste the current selection.
    676. 

  676. 

  677. .. _class_TextEdit_method_redo:
    678. 

  678. 

  679. - void **redo** **(** **)**
    680. 

  680. 

  681. Perform redo operation.
    682. 

  682. 

  683. .. _class_TextEdit_method_remove_breakpoints:
    684. 

  684. 

  685. - void **remove_breakpoints** **(** **)**
    686. 

  686. 

  687. Removes all the breakpoints (without firing "breakpoint_toggled" signal).
    688. 

  688. 

  689. .. _class_TextEdit_method_search:
    690. 

  690. 

  691. - :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
    692. 

  692. 

  693. Perform a search inside the text. Search flags can be specified in the SEARCH\_\* enum.
    694. 

  694. 

  695. .. _class_TextEdit_method_select:
    696. 

  696. 

  697. - 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 **)**
    698. 

  698. 

  699. Perform selection, from line/column to line/column.
    700. 

  700. 

  701. .. _class_TextEdit_method_select_all:
    702. 

  702. 

  703. - void **select_all** **(** **)**
    704. 

  704. 

  705. Select all the text.
    706. 

  706. 

  707. .. _class_TextEdit_method_set_line_as_hidden:
    708. 

  708. 

  709. - void **set_line_as_hidden** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**
    710. 

  710. 

  711. .. _class_TextEdit_method_toggle_fold_line:
    712. 

  712. 

  713. - void **toggle_fold_line** **(** :ref:`int<class_int>` line **)**
    714. 

  714. 

  715. Toggle the folding of the code block at the given line.
    716. 

  716. 

  717. .. _class_TextEdit_method_undo:
    718. 

  718. 

  719. - void **undo** **(** **)**
    720. 

  720. 

  721. Perform undo operation.
    722. 

  722. 

  723. .. _class_TextEdit_method_unfold_line:
    724. 

  724. 

  725. - void **unfold_line** **(** :ref:`int<class_int>` line **)**
    726. 

  726. 

  727. .. _class_TextEdit_method_unhide_all_lines:
    728. 

  728. 

  729. - void **unhide_all_lines** **(** **)**
    730. 

  730.