123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191 |
- :github_url: hide
- .. 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>`
- Multiline text editing control.
- 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.
- Properties
- ----------
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`breakpoint_gutter<class_TextEdit_property_breakpoint_gutter>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`caret_blink<class_TextEdit_property_caret_blink>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`float<class_float>` | :ref:`caret_blink_speed<class_TextEdit_property_caret_blink_speed>` | ``0.65`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`caret_block_mode<class_TextEdit_property_caret_block_mode>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`caret_moving_by_right_click<class_TextEdit_property_caret_moving_by_right_click>` | ``true`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`context_menu_enabled<class_TextEdit_property_context_menu_enabled>` | ``true`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`draw_spaces<class_TextEdit_property_draw_spaces>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`draw_tabs<class_TextEdit_property_draw_tabs>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`FocusMode<enum_Control_FocusMode>` | focus_mode | ``2`` *(parent override)* |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`fold_gutter<class_TextEdit_property_fold_gutter>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`hiding_enabled<class_TextEdit_property_hiding_enabled>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`highlight_all_occurrences<class_TextEdit_property_highlight_all_occurrences>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`highlight_current_line<class_TextEdit_property_highlight_current_line>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`minimap_draw<class_TextEdit_property_minimap_draw>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`int<class_int>` | :ref:`minimap_width<class_TextEdit_property_minimap_width>` | ``80`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`CursorShape<enum_Control_CursorShape>` | mouse_default_cursor_shape | ``1`` *(parent override)* |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`override_selected_font_color<class_TextEdit_property_override_selected_font_color>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`readonly<class_TextEdit_property_readonly>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`int<class_int>` | :ref:`scroll_horizontal<class_TextEdit_property_scroll_horizontal>` | ``0`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`float<class_float>` | :ref:`scroll_vertical<class_TextEdit_property_scroll_vertical>` | ``0.0`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` | ``true`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`shortcut_keys_enabled<class_TextEdit_property_shortcut_keys_enabled>` | ``true`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`show_line_numbers<class_TextEdit_property_show_line_numbers>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`smooth_scrolling<class_TextEdit_property_smooth_scrolling>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`syntax_highlighting<class_TextEdit_property_syntax_highlighting>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`String<class_String>` | :ref:`text<class_TextEdit_property_text>` | ``""`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`float<class_float>` | :ref:`v_scroll_speed<class_TextEdit_property_v_scroll_speed>` | ``80.0`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`virtual_keyboard_enabled<class_TextEdit_property_virtual_keyboard_enabled>` | ``true`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- | :ref:`bool<class_bool>` | :ref:`wrap_enabled<class_TextEdit_property_wrap_enabled>` | ``false`` |
- +----------------------------------------------+-------------------------------------------------------------------------------------------+---------------------------+
- 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:`center_viewport_to_cursor<class_TextEdit_method_center_viewport_to_cursor>` **(** **)** |
- +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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<class_TextEdit_method_set_line>` **(** :ref:`int<class_int>` line, :ref:`String<class_String>` new_text **)** |
- +-----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 | Color( 0, 0, 0, 0 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | bookmark_color | Color( 0.08, 0.49, 0.98, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | brace_mismatch_color | Color( 1, 0.2, 0.2, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | breakpoint_color | Color( 0.8, 0.8, 0.4, 0.2 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | caret_background_color | Color( 0, 0, 0, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | caret_color | Color( 0.88, 0.88, 0.88, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | code_folding_color | Color( 0.8, 0.8, 0.8, 0.8 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | completion | |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | completion_background_color | Color( 0.17, 0.16, 0.2, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | completion_existing_color | Color( 0.87, 0.87, 0.87, 0.13 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | completion_font_color | Color( 0.67, 0.67, 0.67, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`int<class_int>` | completion_lines | 7 |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`int<class_int>` | completion_max_width | 50 |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | completion_scroll_color | Color( 1, 1, 1, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`int<class_int>` | completion_scroll_width | 3 |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | completion_selected_color | Color( 0.26, 0.26, 0.27, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | current_line_color | Color( 0.25, 0.25, 0.26, 0.8 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | executing_line_color | Color( 0.2, 0.8, 0.2, 0.4 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :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 | Color( 0.88, 0.88, 0.88, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | font_color_readonly | Color( 0.88, 0.88, 0.88, 0.5 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | font_color_selected | Color( 0, 0, 0, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | function_color | Color( 0.4, 0.64, 0.81, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | line_number_color | Color( 0.67, 0.67, 0.67, 0.4 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`int<class_int>` | line_spacing | 4 |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | mark_color | Color( 1, 0.4, 0.4, 0.4 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | member_variable_color | Color( 0.9, 0.31, 0.35, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | normal | |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | number_color | Color( 0.92, 0.58, 0.2, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`StyleBox<class_StyleBox>` | read_only | |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | safe_line_number_color | Color( 0.67, 0.78, 0.67, 0.6 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | selection_color | Color( 0.49, 0.49, 0.49, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Texture<class_Texture>` | space | |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | symbol_color | Color( 0.94, 0.94, 0.94, 1 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Texture<class_Texture>` | tab | |
- +---------------------------------+-----------------------------+---------------------------------+
- | :ref:`Color<class_Color>` | word_highlighted_color | Color( 0.8, 0.9, 0.9, 0.15 ) |
- +---------------------------------+-----------------------------+---------------------------------+
- 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 **)**
- Emitted when the info icon is clicked.
- ----
- .. _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_SearchResult:
- .. _class_TextEdit_constant_SEARCH_RESULT_COLUMN:
- .. _class_TextEdit_constant_SEARCH_RESULT_LINE:
- enum **SearchResult**:
- - **SEARCH_RESULT_COLUMN** = **0** --- Used to access the result column from :ref:`search<class_TextEdit_method_search>`.
- - **SEARCH_RESULT_LINE** = **1** --- Used to access the result line from :ref:`search<class_TextEdit_method_search>`.
- ----
- .. _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** --- Redoes the previous action.
- - **MENU_MAX** = **7** --- Represents the size of the :ref:`MenuItems<enum_TextEdit_MenuItems>` enum.
- Property Descriptions
- ---------------------
- .. _class_TextEdit_property_breakpoint_gutter:
- - :ref:`bool<class_bool>` **breakpoint_gutter**
- +-----------+--------------------------------------+
- | *Default* | ``false`` |
- +-----------+--------------------------------------+
- | *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**
- +-----------+---------------------------------+
- | *Default* | ``false`` |
- +-----------+---------------------------------+
- | *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**
- +-----------+-------------------------------+
- | *Default* | ``0.65`` |
- +-----------+-------------------------------+
- | *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**
- +-----------+------------------------------+
- | *Default* | ``false`` |
- +-----------+------------------------------+
- | *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**
- +-----------+------------------------------------+
- | *Default* | ``true`` |
- +-----------+------------------------------------+
- | *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**
- +-----------+---------------------------------+
- | *Default* | ``true`` |
- +-----------+---------------------------------+
- | *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**
- +-----------+------------------------+
- | *Default* | ``false`` |
- +-----------+------------------------+
- | *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**
- +-----------+----------------------+
- | *Default* | ``false`` |
- +-----------+----------------------+
- | *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**
- +-----------+-----------------------------+
- | *Default* | ``false`` |
- +-----------+-----------------------------+
- | *Setter* | set_draw_fold_gutter(value) |
- +-----------+-----------------------------+
- | *Getter* | is_drawing_fold_gutter() |
- +-----------+-----------------------------+
- If ``true``, the fold gutter is visible. This enables folding groups of indented lines.
- ----
- .. _class_TextEdit_property_hiding_enabled:
- - :ref:`bool<class_bool>` **hiding_enabled**
- +-----------+---------------------------+
- | *Default* | ``false`` |
- +-----------+---------------------------+
- | *Setter* | set_hiding_enabled(value) |
- +-----------+---------------------------+
- | *Getter* | is_hiding_enabled() |
- +-----------+---------------------------+
- If ``true``, all lines that have been set to hidden by :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`, will not be visible.
- ----
- .. _class_TextEdit_property_highlight_all_occurrences:
- - :ref:`bool<class_bool>` **highlight_all_occurrences**
- +-----------+----------------------------------------+
- | *Default* | ``false`` |
- +-----------+----------------------------------------+
- | *Setter* | set_highlight_all_occurrences(value) |
- +-----------+----------------------------------------+
- | *Getter* | is_highlight_all_occurrences_enabled() |
- +-----------+----------------------------------------+
- If ``true``, all occurrences of the selected text will be highlighted.
- ----
- .. _class_TextEdit_property_highlight_current_line:
- - :ref:`bool<class_bool>` **highlight_current_line**
- +-----------+-------------------------------------+
- | *Default* | ``false`` |
- +-----------+-------------------------------------+
- | *Setter* | set_highlight_current_line(value) |
- +-----------+-------------------------------------+
- | *Getter* | is_highlight_current_line_enabled() |
- +-----------+-------------------------------------+
- If ``true``, the line containing the cursor is highlighted.
- ----
- .. _class_TextEdit_property_minimap_draw:
- - :ref:`bool<class_bool>` **minimap_draw**
- +-----------+----------------------+
- | *Default* | ``false`` |
- +-----------+----------------------+
- | *Setter* | draw_minimap(value) |
- +-----------+----------------------+
- | *Getter* | is_drawing_minimap() |
- +-----------+----------------------+
- If ``true``, a minimap is shown, providing an outline of your source code.
- ----
- .. _class_TextEdit_property_minimap_width:
- - :ref:`int<class_int>` **minimap_width**
- +-----------+--------------------------+
- | *Default* | ``80`` |
- +-----------+--------------------------+
- | *Setter* | set_minimap_width(value) |
- +-----------+--------------------------+
- | *Getter* | get_minimap_width() |
- +-----------+--------------------------+
- The width, in pixels, of the minimap.
- ----
- .. _class_TextEdit_property_override_selected_font_color:
- - :ref:`bool<class_bool>` **override_selected_font_color**
- +-----------+-----------------------------------------+
- | *Default* | ``false`` |
- +-----------+-----------------------------------------+
- | *Setter* | set_override_selected_font_color(value) |
- +-----------+-----------------------------------------+
- | *Getter* | is_overriding_selected_font_color() |
- +-----------+-----------------------------------------+
- If ``true``, custom ``font_color_selected`` will be used for selected text.
- ----
- .. _class_TextEdit_property_readonly:
- - :ref:`bool<class_bool>` **readonly**
- +-----------+---------------------+
- | *Default* | ``false`` |
- +-----------+---------------------+
- | *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_scroll_horizontal:
- - :ref:`int<class_int>` **scroll_horizontal**
- +-----------+---------------------+
- | *Default* | ``0`` |
- +-----------+---------------------+
- | *Setter* | set_h_scroll(value) |
- +-----------+---------------------+
- | *Getter* | get_h_scroll() |
- +-----------+---------------------+
- The current horizontal scroll value.
- ----
- .. _class_TextEdit_property_scroll_vertical:
- - :ref:`float<class_float>` **scroll_vertical**
- +-----------+---------------------+
- | *Default* | ``0.0`` |
- +-----------+---------------------+
- | *Setter* | set_v_scroll(value) |
- +-----------+---------------------+
- | *Getter* | get_v_scroll() |
- +-----------+---------------------+
- The current vertical scroll value.
- ----
- .. _class_TextEdit_property_selecting_enabled:
- - :ref:`bool<class_bool>` **selecting_enabled**
- +-----------+------------------------------+
- | *Default* | ``true`` |
- +-----------+------------------------------+
- | *Setter* | set_selecting_enabled(value) |
- +-----------+------------------------------+
- | *Getter* | is_selecting_enabled() |
- +-----------+------------------------------+
- If ``true``, text can be selected.
- If ``false``, text can not be selected by the user or by the :ref:`select<class_TextEdit_method_select>` or :ref:`select_all<class_TextEdit_method_select_all>` methods.
- ----
- .. _class_TextEdit_property_shortcut_keys_enabled:
- - :ref:`bool<class_bool>` **shortcut_keys_enabled**
- +-----------+----------------------------------+
- | *Default* | ``true`` |
- +-----------+----------------------------------+
- | *Setter* | set_shortcut_keys_enabled(value) |
- +-----------+----------------------------------+
- | *Getter* | is_shortcut_keys_enabled() |
- +-----------+----------------------------------+
- If ``true``, shortcut keys for context menu items are enabled, even if the context menu is disabled.
- ----
- .. _class_TextEdit_property_show_line_numbers:
- - :ref:`bool<class_bool>` **show_line_numbers**
- +-----------+--------------------------------+
- | *Default* | ``false`` |
- +-----------+--------------------------------+
- | *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**
- +-----------+---------------------------------+
- | *Default* | ``false`` |
- +-----------+---------------------------------+
- | *Setter* | set_smooth_scroll_enable(value) |
- +-----------+---------------------------------+
- | *Getter* | is_smooth_scroll_enabled() |
- +-----------+---------------------------------+
- If ``true``, sets the ``step`` of the scrollbars to ``0.25`` which results in smoother scrolling.
- ----
- .. _class_TextEdit_property_syntax_highlighting:
- - :ref:`bool<class_bool>` **syntax_highlighting**
- +-----------+------------------------------+
- | *Default* | ``false`` |
- +-----------+------------------------------+
- | *Setter* | set_syntax_coloring(value) |
- +-----------+------------------------------+
- | *Getter* | is_syntax_coloring_enabled() |
- +-----------+------------------------------+
- If ``true``, any custom color properties that have been set for this ``TextEdit`` will be visible.
- ----
- .. _class_TextEdit_property_text:
- - :ref:`String<class_String>` **text**
- +-----------+-----------------+
- | *Default* | ``""`` |
- +-----------+-----------------+
- | *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**
- +-----------+---------------------------+
- | *Default* | ``80.0`` |
- +-----------+---------------------------+
- | *Setter* | set_v_scroll_speed(value) |
- +-----------+---------------------------+
- | *Getter* | get_v_scroll_speed() |
- +-----------+---------------------------+
- Vertical scroll sensitivity.
- ----
- .. _class_TextEdit_property_virtual_keyboard_enabled:
- - :ref:`bool<class_bool>` **virtual_keyboard_enabled**
- +-----------+-------------------------------------+
- | *Default* | ``true`` |
- +-----------+-------------------------------------+
- | *Setter* | set_virtual_keyboard_enabled(value) |
- +-----------+-------------------------------------+
- | *Getter* | is_virtual_keyboard_enabled() |
- +-----------+-------------------------------------+
- If ``true``, the native virtual keyboard is shown when focused on platforms that support it.
- ----
- .. _class_TextEdit_property_wrap_enabled:
- - :ref:`bool<class_bool>` **wrap_enabled**
- +-----------+-------------------------+
- | *Default* | ``false`` |
- +-----------+-------------------------+
- | *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 **)**
- Adds 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 **)**
- Adds a ``keyword`` and its :ref:`Color<class_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_center_viewport_to_cursor:
- - void **center_viewport_to_cursor** **(** **)**
- Centers the viewport on the line the editing cursor is at. This also resets the :ref:`scroll_horizontal<class_TextEdit_property_scroll_horizontal>` value to ``0``.
- ----
- .. _class_TextEdit_method_clear_colors:
- - void **clear_colors** **(** **)**
- Clears all custom syntax coloring information previously added with :ref:`add_color_region<class_TextEdit_method_add_color_region>` or :ref:`add_keyword_color<class_TextEdit_method_add_keyword_color>`.
- ----
- .. _class_TextEdit_method_clear_undo_history:
- - void **clear_undo_history** **(** **)**
- Clears the undo history.
- ----
- .. _class_TextEdit_method_copy:
- - void **copy** **(** **)**
- Copy's the current text selection.
- ----
- .. _class_TextEdit_method_cursor_get_column:
- - :ref:`int<class_int>` **cursor_get_column** **(** **)** |const|
- Returns the column the editing cursor is at.
- ----
- .. _class_TextEdit_method_cursor_get_line:
- - :ref:`int<class_int>` **cursor_get_line** **(** **)** |const|
- Returns 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 **)**
- Moves the cursor at the specified ``column`` index.
- If ``adjust_viewport`` is set to ``true``, the viewport will center at the cursor position after the move occurs.
- ----
- .. _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 **)**
- Moves the cursor at the specified ``line`` index.
- If ``adjust_viewport`` is set to ``true``, the viewport will center at the cursor position after the move occurs.
- If ``can_be_hidden`` is set to ``true``, the specified ``line`` can be hidden using :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`.
- ----
- .. _class_TextEdit_method_cut:
- - void **cut** **(** **)**
- Cut's the current selection.
- ----
- .. _class_TextEdit_method_deselect:
- - void **deselect** **(** **)**
- Deselects 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|
- Returns 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|
- Returns the :ref:`Color<class_Color>` of the specified ``keyword``.
- ----
- .. _class_TextEdit_method_get_line:
- - :ref:`String<class_String>` **get_line** **(** :ref:`int<class_int>` line **)** |const|
- Returns the text of a specific line.
- ----
- .. _class_TextEdit_method_get_line_count:
- - :ref:`int<class_int>` **get_line_count** **(** **)** |const|
- Returns 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|
- Returns the selection begin column.
- ----
- .. _class_TextEdit_method_get_selection_from_line:
- - :ref:`int<class_int>` **get_selection_from_line** **(** **)** |const|
- Returns the selection begin line.
- ----
- .. _class_TextEdit_method_get_selection_text:
- - :ref:`String<class_String>` **get_selection_text** **(** **)** |const|
- Returns the text inside the selection.
- ----
- .. _class_TextEdit_method_get_selection_to_column:
- - :ref:`int<class_int>` **get_selection_to_column** **(** **)** |const|
- Returns the selection end column.
- ----
- .. _class_TextEdit_method_get_selection_to_line:
- - :ref:`int<class_int>` **get_selection_to_line** **(** **)** |const|
- Returns the selection end line.
- ----
- .. _class_TextEdit_method_get_word_under_cursor:
- - :ref:`String<class_String>` **get_word_under_cursor** **(** **)** |const|
- Returns a :ref:`String<class_String>` text with the word under the mouse cursor location.
- ----
- .. _class_TextEdit_method_has_keyword_color:
- - :ref:`bool<class_bool>` **has_keyword_color** **(** :ref:`String<class_String>` keyword **)** |const|
- Returns whether the specified ``keyword`` has a color set to it or not.
- ----
- .. _class_TextEdit_method_insert_text_at_cursor:
- - void **insert_text_at_cursor** **(** :ref:`String<class_String>` text **)**
- Insert the specified text at the cursor position.
- ----
- .. _class_TextEdit_method_is_folded:
- - :ref:`bool<class_bool>` **is_folded** **(** :ref:`int<class_int>` line **)** |const|
- Returns whether the line at the specified index is folded or not.
- ----
- .. _class_TextEdit_method_is_line_hidden:
- - :ref:`bool<class_bool>` **is_line_hidden** **(** :ref:`int<class_int>` line **)** |const|
- Returns whether the line at the specified index is hidden or not.
- ----
- .. _class_TextEdit_method_is_selection_active:
- - :ref:`bool<class_bool>` **is_selection_active** **(** **)** |const|
- Returns ``true`` if the selection is active.
- ----
- .. _class_TextEdit_method_menu_option:
- - void **menu_option** **(** :ref:`int<class_int>` option **)**
- Triggers a right-click menu action by the specified index. See :ref:`MenuItems<enum_TextEdit_MenuItems>` for a list of available indexes.
- ----
- .. _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. This will not fire the :ref:`breakpoint_toggled<class_TextEdit_signal_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 :ref:`SearchFlags<enum_TextEdit_SearchFlags>` enum.
- Returns an empty ``PoolIntArray`` if no result was found. Otherwise, the result line and column can be accessed at indices specified in the :ref:`SearchResult<enum_TextEdit_SearchResult>` enum, e.g:
- ::
- var result = search(key, flags, line, column)
- if result.size() > 0:
- # Result found.
- var res_line = result[TextEdit.SEARCH_RESULT_LINE]
- var res_column = result[TextEdit.SEARCH_RESULT_COLUMN]
- ----
- .. _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.
- If :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` is ``false``, no selection will occur.
- ----
- .. _class_TextEdit_method_select_all:
- - void **select_all** **(** **)**
- Select all the text.
- If :ref:`selecting_enabled<class_TextEdit_property_selecting_enabled>` is ``false``, no selection will occur.
- ----
- .. _class_TextEdit_method_set_line:
- - void **set_line** **(** :ref:`int<class_int>` line, :ref:`String<class_String>` new_text **)**
- Sets the text for a specific line.
- ----
- .. _class_TextEdit_method_set_line_as_hidden:
- - void **set_line_as_hidden** **(** :ref:`int<class_int>` line, :ref:`bool<class_bool>` enable **)**
- If ``true``, hides the line of the specified index.
- ----
- .. _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** **(** **)**
- Unhide all lines that were previously set to hidden by :ref:`set_line_as_hidden<class_TextEdit_method_set_line_as_hidden>`.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|