Godot
/
godot-docs
oglindă de https://github.com/godotengine/godot-docs.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800
							.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the TextEdit.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_TextEdit:

TextEdit
========

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

**Category:** Core

Brief Description
-----------------

Multiline text editing control.

Properties
----------

+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>`                       |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`caret_blink<class_TextEdit_property_caret_blink>`                                   |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`   | :ref:`caret_blink_speed<class_TextEdit_property_caret_blink_speed>`                       |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`caret_block_mode<class_TextEdit_property_caret_block_mode>`                         |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`caret_moving_by_right_click<class_TextEdit_property_caret_moving_by_right_click>`   |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`context_menu_enabled<class_TextEdit_property_context_menu_enabled>`                 |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`draw_spaces<class_TextEdit_property_draw_spaces>`                                   |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`draw_tabs<class_TextEdit_property_draw_tabs>`                                       |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`fold_gutter<class_TextEdit_property_fold_gutter>`                                   |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`       | :ref:`hiding_enabled<class_TextEdit_property_hiding_enabled>`                             |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>`       |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`highlight_current_line<class_TextEdit_property_highlight_current_line>`             |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`override_selected_font_color<class_TextEdit_property_override_selected_font_color>` |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`readonly<class_TextEdit_property_readonly>`                                         |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`show_line_numbers<class_TextEdit_property_show_line_numbers>`                       |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`smooth_scrolling<class_TextEdit_property_smooth_scrolling>`                         |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`syntax_highlighting<class_TextEdit_property_syntax_highlighting>`                   |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`text<class_TextEdit_property_text>`                                                 |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`   | :ref:`v_scroll_speed<class_TextEdit_property_v_scroll_speed>`                             |
+-----------------------------+-------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`     | :ref:`wrap_enabled<class_TextEdit_property_wrap_enabled>`                                 |
+-----------------------------+-------------------------------------------------------------------------------------------+

Methods
-------

+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)**   |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`add_keyword_color<class_TextEdit_method_add_keyword_color>` **(** :ref:`String<class_String>` keyword, :ref:`Color<class_Color>` color **)**                                                                                 |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`can_fold<class_TextEdit_method_can_fold>` **(** :ref:`int<class_int>` line **)** const                                                                                                                                       |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`clear_colors<class_TextEdit_method_clear_colors>` **(** **)**                                                                                                                                                                |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`clear_undo_history<class_TextEdit_method_clear_undo_history>` **(** **)**                                                                                                                                                    |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`copy<class_TextEdit_method_copy>` **(** **)**                                                                                                                                                                                |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`cursor_get_column<class_TextEdit_method_cursor_get_column>` **(** **)** const                                                                                                                                                |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`cursor_get_line<class_TextEdit_method_cursor_get_line>` **(** **)** const                                                                                                                                                    |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`cursor_set_column<class_TextEdit_method_cursor_set_column>` **(** :ref:`int<class_int>` column, :ref:`bool<class_bool>` adjust_viewport=true **)**                                                                           |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)** |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`cut<class_TextEdit_method_cut>` **(** **)**                                                                                                                                                                                  |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`deselect<class_TextEdit_method_deselect>` **(** **)**                                                                                                                                                                        |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`fold_all_lines<class_TextEdit_method_fold_all_lines>` **(** **)**                                                                                                                                                            |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`fold_line<class_TextEdit_method_fold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                           |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>`               | :ref:`get_breakpoints<class_TextEdit_method_get_breakpoints>` **(** **)** const                                                                                                                                                    |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>`               | :ref:`get_keyword_color<class_TextEdit_method_get_keyword_color>` **(** :ref:`String<class_String>` keyword **)** const                                                                                                            |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`             | :ref:`get_line<class_TextEdit_method_get_line>` **(** :ref:`int<class_int>` line **)** const                                                                                                                                       |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`get_line_count<class_TextEdit_method_get_line_count>` **(** **)** const                                                                                                                                                      |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PopupMenu<class_PopupMenu>`       | :ref:`get_menu<class_TextEdit_method_get_menu>` **(** **)** const                                                                                                                                                                  |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`get_selection_from_column<class_TextEdit_method_get_selection_from_column>` **(** **)** const                                                                                                                                |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`get_selection_from_line<class_TextEdit_method_get_selection_from_line>` **(** **)** const                                                                                                                                    |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`             | :ref:`get_selection_text<class_TextEdit_method_get_selection_text>` **(** **)** const                                                                                                                                              |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`get_selection_to_column<class_TextEdit_method_get_selection_to_column>` **(** **)** const                                                                                                                                    |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                   | :ref:`get_selection_to_line<class_TextEdit_method_get_selection_to_line>` **(** **)** const                                                                                                                                        |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>`             | :ref:`get_word_under_cursor<class_TextEdit_method_get_word_under_cursor>` **(** **)** const                                                                                                                                        |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`has_keyword_color<class_TextEdit_method_has_keyword_color>` **(** :ref:`String<class_String>` keyword **)** const                                                                                                            |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`insert_text_at_cursor<class_TextEdit_method_insert_text_at_cursor>` **(** :ref:`String<class_String>` text **)**                                                                                                             |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_folded<class_TextEdit_method_is_folded>` **(** :ref:`int<class_int>` line **)** const                                                                                                                                     |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_line_hidden<class_TextEdit_method_is_line_hidden>` **(** :ref:`int<class_int>` line **)** const                                                                                                                           |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`                 | :ref:`is_selection_active<class_TextEdit_method_is_selection_active>` **(** **)** const                                                                                                                                            |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`menu_option<class_TextEdit_method_menu_option>` **(** :ref:`int<class_int>` option **)**                                                                                                                                     |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`paste<class_TextEdit_method_paste>` **(** **)**                                                                                                                                                                              |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`redo<class_TextEdit_method_redo>` **(** **)**                                                                                                                                                                                |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`remove_breakpoints<class_TextEdit_method_remove_breakpoints>` **(** **)**                                                                                                                                                    |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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                                     |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 **)**                                         |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`select_all<class_TextEdit_method_select_all>` **(** **)**                                                                                                                                                                    |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>` **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**                                                                                         |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`toggle_fold_line<class_TextEdit_method_toggle_fold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                             |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`undo<class_TextEdit_method_undo>` **(** **)**                                                                                                                                                                                |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`unfold_line<class_TextEdit_method_unfold_line>` **(** :ref:`int<class_int>` line **)**                                                                                                                                       |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                    | :ref:`unhide_all_lines<class_TextEdit_method_unhide_all_lines>` **(** **)**                                                                                                                                                        |
+-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Theme Properties
----------------

+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | background_color            |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | bookmark_color              |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | brace_mismatch_color        |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | breakpoint_color            |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | caret_background_color      |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | caret_color                 |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | code_folding_color          |
+---------------------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | completion                  |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | completion_background_color |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | completion_existing_color   |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | completion_font_color       |
+---------------------------------+-----------------------------+
| :ref:`int<class_int>`           | completion_lines            |
+---------------------------------+-----------------------------+
| :ref:`int<class_int>`           | completion_max_width        |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | completion_scroll_color     |
+---------------------------------+-----------------------------+
| :ref:`int<class_int>`           | completion_scroll_width     |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | completion_selected_color   |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | current_line_color          |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | executing_line_color        |
+---------------------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | focus                       |
+---------------------------------+-----------------------------+
| :ref:`Texture<class_Texture>`   | fold                        |
+---------------------------------+-----------------------------+
| :ref:`Texture<class_Texture>`   | folded                      |
+---------------------------------+-----------------------------+
| :ref:`Font<class_Font>`         | font                        |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | font_color                  |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | font_color_selected         |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | function_color              |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | line_number_color           |
+---------------------------------+-----------------------------+
| :ref:`int<class_int>`           | line_spacing                |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | mark_color                  |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | member_variable_color       |
+---------------------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | normal                      |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | number_color                |
+---------------------------------+-----------------------------+
| :ref:`StyleBox<class_StyleBox>` | read_only                   |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | safe_line_number_color      |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | selection_color             |
+---------------------------------+-----------------------------+
| :ref:`Texture<class_Texture>`   | space                       |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | symbol_color                |
+---------------------------------+-----------------------------+
| :ref:`Texture<class_Texture>`   | tab                         |
+---------------------------------+-----------------------------+
| :ref:`Color<class_Color>`       | word_highlighted_color      |
+---------------------------------+-----------------------------+

Signals
-------

.. _class_TextEdit_signal_breakpoint_toggled:

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

Emitted when a breakpoint is placed via the breakpoint gutter.

.. _class_TextEdit_signal_cursor_changed:

- **cursor_changed** **(** **)**

Emitted when the cursor changes.

.. _class_TextEdit_signal_info_clicked:

- **info_clicked** **(** :ref:`int<class_int>` row, :ref:`String<class_String>` info **)**

.. _class_TextEdit_signal_request_completion:

- **request_completion** **(** **)**

.. _class_TextEdit_signal_symbol_lookup:

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

.. _class_TextEdit_signal_text_changed:

- **text_changed** **(** **)**

Emitted when the text changes.

Enumerations
------------

.. _enum_TextEdit_SearchFlags:

.. _class_TextEdit_constant_SEARCH_MATCH_CASE:

.. _class_TextEdit_constant_SEARCH_WHOLE_WORDS:

.. _class_TextEdit_constant_SEARCH_BACKWARDS:

enum **SearchFlags**:

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

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

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

.. _enum_TextEdit_MenuItems:

.. _class_TextEdit_constant_MENU_CUT:

.. _class_TextEdit_constant_MENU_COPY:

.. _class_TextEdit_constant_MENU_PASTE:

.. _class_TextEdit_constant_MENU_CLEAR:

.. _class_TextEdit_constant_MENU_SELECT_ALL:

.. _class_TextEdit_constant_MENU_UNDO:

.. _class_TextEdit_constant_MENU_REDO:

.. _class_TextEdit_constant_MENU_MAX:

enum **MenuItems**:

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

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

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

- **MENU_CLEAR** = **3** --- Erases the whole ``TextEdit`` text.

- **MENU_SELECT_ALL** = **4** --- Selects the whole ``TextEdit`` text.

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

- **MENU_REDO** = **6**

- **MENU_MAX** = **7**

Description
-----------

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.

Property Descriptions
---------------------

.. _class_TextEdit_property_breakpoint_gutter:

- :ref:`bool<class_bool>` **breakpoint_gutter**

+----------+--------------------------------------+
| *Setter* | set_breakpoint_gutter_enabled(value) |
+----------+--------------------------------------+
| *Getter* | is_breakpoint_gutter_enabled()       |
+----------+--------------------------------------+

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

.. _class_TextEdit_property_caret_blink:

- :ref:`bool<class_bool>` **caret_blink**

+----------+---------------------------------+
| *Setter* | cursor_set_blink_enabled(value) |
+----------+---------------------------------+
| *Getter* | cursor_get_blink_enabled()      |
+----------+---------------------------------+

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

.. _class_TextEdit_property_caret_blink_speed:

- :ref:`float<class_float>` **caret_blink_speed**

+----------+-------------------------------+
| *Setter* | cursor_set_blink_speed(value) |
+----------+-------------------------------+
| *Getter* | cursor_get_blink_speed()      |
+----------+-------------------------------+

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

.. _class_TextEdit_property_caret_block_mode:

- :ref:`bool<class_bool>` **caret_block_mode**

+----------+------------------------------+
| *Setter* | cursor_set_block_mode(value) |
+----------+------------------------------+
| *Getter* | cursor_is_block_mode()       |
+----------+------------------------------+

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

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

.. _class_TextEdit_property_caret_moving_by_right_click:

- :ref:`bool<class_bool>` **caret_moving_by_right_click**

+----------+------------------------------------+
| *Setter* | set_right_click_moves_caret(value) |
+----------+------------------------------------+
| *Getter* | is_right_click_moving_caret()      |
+----------+------------------------------------+

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

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

.. _class_TextEdit_property_context_menu_enabled:

- :ref:`bool<class_bool>` **context_menu_enabled**

+----------+---------------------------------+
| *Setter* | set_context_menu_enabled(value) |
+----------+---------------------------------+
| *Getter* | is_context_menu_enabled()       |
+----------+---------------------------------+

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

.. _class_TextEdit_property_draw_spaces:

- :ref:`bool<class_bool>` **draw_spaces**

+----------+------------------------+
| *Setter* | set_draw_spaces(value) |
+----------+------------------------+
| *Getter* | is_drawing_spaces()    |
+----------+------------------------+

If ``true``, the "space" character will have a visible representation.

.. _class_TextEdit_property_draw_tabs:

- :ref:`bool<class_bool>` **draw_tabs**

+----------+----------------------+
| *Setter* | set_draw_tabs(value) |
+----------+----------------------+
| *Getter* | is_drawing_tabs()    |
+----------+----------------------+

If ``true``, the "tab" character will have a visible representation.

.. _class_TextEdit_property_fold_gutter:

- :ref:`bool<class_bool>` **fold_gutter**

+----------+--------------------------------+
| *Setter* | set_fold_gutter_enabled(value) |
+----------+--------------------------------+
| *Getter* | is_fold_gutter_enabled()       |
+----------+--------------------------------+

If ``true``, the fold gutter is visible. This enables folding groups of indented lines.

.. _class_TextEdit_property_hiding_enabled:

- :ref:`int<class_int>` **hiding_enabled**

+----------+---------------------------+
| *Setter* | set_hiding_enabled(value) |
+----------+---------------------------+
| *Getter* | is_hiding_enabled()       |
+----------+---------------------------+

.. _class_TextEdit_property_highlight_all_occurrences:

- :ref:`bool<class_bool>` **highlight_all_occurrences**

+----------+----------------------------------------+
| *Setter* | set_highlight_all_occurrences(value)   |
+----------+----------------------------------------+
| *Getter* | is_highlight_all_occurrences_enabled() |
+----------+----------------------------------------+

.. _class_TextEdit_property_highlight_current_line:

- :ref:`bool<class_bool>` **highlight_current_line**

+----------+-------------------------------------+
| *Setter* | set_highlight_current_line(value)   |
+----------+-------------------------------------+
| *Getter* | is_highlight_current_line_enabled() |
+----------+-------------------------------------+

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

.. _class_TextEdit_property_override_selected_font_color:

- :ref:`bool<class_bool>` **override_selected_font_color**

+----------+-----------------------------------------+
| *Setter* | set_override_selected_font_color(value) |
+----------+-----------------------------------------+
| *Getter* | is_overriding_selected_font_color()     |
+----------+-----------------------------------------+

.. _class_TextEdit_property_readonly:

- :ref:`bool<class_bool>` **readonly**

+----------+---------------------+
| *Setter* | set_readonly(value) |
+----------+---------------------+
| *Getter* | is_readonly()       |
+----------+---------------------+

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

.. _class_TextEdit_property_show_line_numbers:

- :ref:`bool<class_bool>` **show_line_numbers**

+----------+--------------------------------+
| *Setter* | set_show_line_numbers(value)   |
+----------+--------------------------------+
| *Getter* | is_show_line_numbers_enabled() |
+----------+--------------------------------+

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

.. _class_TextEdit_property_smooth_scrolling:

- :ref:`bool<class_bool>` **smooth_scrolling**

+----------+---------------------------------+
| *Setter* | set_smooth_scroll_enable(value) |
+----------+---------------------------------+
| *Getter* | is_smooth_scroll_enabled()      |
+----------+---------------------------------+

.. _class_TextEdit_property_syntax_highlighting:

- :ref:`bool<class_bool>` **syntax_highlighting**

+----------+------------------------------+
| *Setter* | set_syntax_coloring(value)   |
+----------+------------------------------+
| *Getter* | is_syntax_coloring_enabled() |
+----------+------------------------------+

.. _class_TextEdit_property_text:

- :ref:`String<class_String>` **text**

+----------+-----------------+
| *Setter* | set_text(value) |
+----------+-----------------+
| *Getter* | get_text()      |
+----------+-----------------+

String value of the ``TextEdit``.

.. _class_TextEdit_property_v_scroll_speed:

- :ref:`float<class_float>` **v_scroll_speed**

+----------+---------------------------+
| *Setter* | set_v_scroll_speed(value) |
+----------+---------------------------+
| *Getter* | get_v_scroll_speed()      |
+----------+---------------------------+

Vertical scroll sensitivity.

.. _class_TextEdit_property_wrap_enabled:

- :ref:`bool<class_bool>` **wrap_enabled**

+----------+-------------------------+
| *Setter* | set_wrap_enabled(value) |
+----------+-------------------------+
| *Getter* | is_wrap_enabled()       |
+----------+-------------------------+

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

Method Descriptions
-------------------

.. _class_TextEdit_method_add_color_region:

- 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 **)**

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

.. _class_TextEdit_method_add_keyword_color:

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

Add a keyword and its color.

.. _class_TextEdit_method_can_fold:

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

Returns if the given line is foldable, that is, it has indented lines right below it.

.. _class_TextEdit_method_clear_colors:

- void **clear_colors** **(** **)**

Clear all the syntax coloring information.

.. _class_TextEdit_method_clear_undo_history:

- void **clear_undo_history** **(** **)**

Clear the undo history.

.. _class_TextEdit_method_copy:

- void **copy** **(** **)**

Copy the current selection.

.. _class_TextEdit_method_cursor_get_column:

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

Return the column the editing cursor is at.

.. _class_TextEdit_method_cursor_get_line:

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

Return the line the editing cursor is at.

.. _class_TextEdit_method_cursor_set_column:

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

.. _class_TextEdit_method_cursor_set_line:

- 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 **)**

.. _class_TextEdit_method_cut:

- void **cut** **(** **)**

Cut the current selection.

.. _class_TextEdit_method_deselect:

- void **deselect** **(** **)**

Clears the current selection.

.. _class_TextEdit_method_fold_all_lines:

- void **fold_all_lines** **(** **)**

Folds all lines that are possible to be folded (see :ref:`can_fold<class_TextEdit_method_can_fold>`).

.. _class_TextEdit_method_fold_line:

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

Folds the given line, if possible (see :ref:`can_fold<class_TextEdit_method_can_fold>`).

.. _class_TextEdit_method_get_breakpoints:

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

Return an array containing the line number of each breakpoint.

.. _class_TextEdit_method_get_keyword_color:

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

.. _class_TextEdit_method_get_line:

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

Return the text of a specific line.

.. _class_TextEdit_method_get_line_count:

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

Return the amount of total lines in the text.

.. _class_TextEdit_method_get_menu:

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

Returns the :ref:`PopupMenu<class_PopupMenu>` of this ``TextEdit``. By default, this menu is displayed when right-clicking on the ``TextEdit``.

.. _class_TextEdit_method_get_selection_from_column:

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

Return the selection begin column.

.. _class_TextEdit_method_get_selection_from_line:

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

Return the selection begin line.

.. _class_TextEdit_method_get_selection_text:

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

Return the text inside the selection.

.. _class_TextEdit_method_get_selection_to_column:

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

Return the selection end column.

.. _class_TextEdit_method_get_selection_to_line:

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

Return the selection end line.

.. _class_TextEdit_method_get_word_under_cursor:

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

.. _class_TextEdit_method_has_keyword_color:

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

.. _class_TextEdit_method_insert_text_at_cursor:

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

Insert a given text at the cursor position.

.. _class_TextEdit_method_is_folded:

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

Returns if the given line is folded.

.. _class_TextEdit_method_is_line_hidden:

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

.. _class_TextEdit_method_is_selection_active:

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

Return ``true`` if the selection is active.

.. _class_TextEdit_method_menu_option:

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

.. _class_TextEdit_method_paste:

- void **paste** **(** **)**

Paste the current selection.

.. _class_TextEdit_method_redo:

- void **redo** **(** **)**

Perform redo operation.

.. _class_TextEdit_method_remove_breakpoints:

- void **remove_breakpoints** **(** **)**

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

.. _class_TextEdit_method_search:

- :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

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

.. _class_TextEdit_method_select:

- 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 **)**

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

.. _class_TextEdit_method_select_all:

- void **select_all** **(** **)**

Select all the text.

.. _class_TextEdit_method_set_line_as_hidden:

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

.. _class_TextEdit_method_toggle_fold_line:

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

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

.. _class_TextEdit_method_undo:

- void **undo** **(** **)**

Perform undo operation.

.. _class_TextEdit_method_unfold_line:

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

Unfolds the given line, if folded.

.. _class_TextEdit_method_unhide_all_lines:

- void **unhide_all_lines** **(** **)**