TextEdit

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Multiline text editing control.

Methods

void add_color_region ( String begin_key, String end_key, Color color, bool line_only=false )
void add_keyword_color ( String keyword, Color color )
bool can_fold ( int line ) const
void center_viewport_to_cursor ( )
void clear_colors ( )
void clear_undo_history ( )
void copy ( )
int cursor_get_column ( ) const
int cursor_get_line ( ) const
void cursor_set_column ( int column, bool adjust_viewport=true )
void cursor_set_line ( int line, bool adjust_viewport=true, bool can_be_hidden=true, int wrap_index=0 )
void cut ( )
void deselect ( )
void fold_all_lines ( )
void fold_line ( int line )
Array get_breakpoints ( ) const
Color get_keyword_color ( String keyword ) const
String get_line ( int line ) const
int get_line_count ( ) const
PopupMenu get_menu ( ) const
int get_selection_from_column ( ) const
int get_selection_from_line ( ) const
String get_selection_text ( ) const
int get_selection_to_column ( ) const
int get_selection_to_line ( ) const
String get_word_under_cursor ( ) const
bool has_keyword_color ( String keyword ) const
void insert_text_at_cursor ( String text )
bool is_folded ( int line ) const
bool is_line_hidden ( int line ) const
bool is_selection_active ( ) const
void menu_option ( int option )
void paste ( )
void redo ( )
void remove_breakpoints ( )
PoolIntArray search ( String key, int flags, int from_line, int from_column ) const
void select ( int from_line, int from_column, int to_line, int to_column )
void select_all ( )
void set_line_as_hidden ( int line, bool enable )
void toggle_fold_line ( int line )
void undo ( )
void unfold_line ( int line )
void unhide_all_lines ( )

Theme Properties

Color background_color Color( 0, 0, 0, 0 )
Color bookmark_color Color( 0.08, 0.49, 0.98, 1 )
Color brace_mismatch_color Color( 1, 0.2, 0.2, 1 )
Color breakpoint_color Color( 0.8, 0.8, 0.4, 0.2 )
Color caret_background_color Color( 0, 0, 0, 1 )
Color caret_color Color( 0.88, 0.88, 0.88, 1 )
Color code_folding_color Color( 0.8, 0.8, 0.8, 0.8 )
StyleBox completion  
Color completion_background_color Color( 0.17, 0.16, 0.2, 1 )
Color completion_existing_color Color( 0.87, 0.87, 0.87, 0.13 )
Color completion_font_color Color( 0.67, 0.67, 0.67, 1 )
int completion_lines 7
int completion_max_width 50
Color completion_scroll_color Color( 1, 1, 1, 1 )
int completion_scroll_width 3
Color completion_selected_color Color( 0.26, 0.26, 0.27, 1 )
Color current_line_color Color( 0.25, 0.25, 0.26, 0.8 )
Color executing_line_color Color( 0.2, 0.8, 0.2, 0.4 )
StyleBox focus  
Texture fold  
Texture folded  
Font font  
Color font_color Color( 0.88, 0.88, 0.88, 1 )
Color font_color_readonly Color( 0.88, 0.88, 0.88, 0.5 )
Color font_color_selected Color( 0, 0, 0, 1 )
Color function_color Color( 0.4, 0.64, 0.81, 1 )
Color line_number_color Color( 0.67, 0.67, 0.67, 0.4 )
int line_spacing 4
Color mark_color Color( 1, 0.4, 0.4, 0.4 )
Color member_variable_color Color( 0.9, 0.31, 0.35, 1 )
StyleBox normal  
Color number_color Color( 0.92, 0.58, 0.2, 1 )
StyleBox read_only  
Color safe_line_number_color Color( 0.67, 0.78, 0.67, 0.6 )
Color selection_color Color( 0.49, 0.49, 0.49, 1 )
Texture space  
Color symbol_color Color( 0.94, 0.94, 0.94, 1 )
Texture tab  
Color word_highlighted_color Color( 0.8, 0.9, 0.9, 0.15 )

Signals

  • breakpoint_toggled ( int row )

Emitted when a breakpoint is placed via the breakpoint gutter.

  • cursor_changed ( )

Emitted when the cursor changes.

Emitted when the info icon is clicked.

  • request_completion ( )
  • text_changed ( )

Emitted when the text changes.

Enumerations

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

  • SEARCH_RESULT_COLUMN = 0 — Used to access the result column from search.
  • SEARCH_RESULT_LINE = 1 — Used to access the result line from search.

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 MenuItems enum.

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

  • bool breakpoint_gutter
Default false
Setter set_breakpoint_gutter_enabled(value)
Getter is_breakpoint_gutter_enabled()

If true, the breakpoint gutter is visible.

Default false
Setter cursor_set_blink_enabled(value)
Getter cursor_get_blink_enabled()

If true, the caret (visual cursor) blinks.

Default 0.65
Setter cursor_set_blink_speed(value)
Getter cursor_get_blink_speed()

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

  • 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.

  • 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.

  • 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.

Default false
Setter set_draw_spaces(value)
Getter is_drawing_spaces()

If true, the “space” character will have a visible representation.

Default false
Setter set_draw_tabs(value)
Getter is_drawing_tabs()

If true, the “tab” character will have a visible representation.

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.

  • 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 set_line_as_hidden, will not be visible.

  • 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.

  • 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.

Default false
Setter draw_minimap(value)
Getter is_drawing_minimap()
  • int minimap_width
Default 80
Setter set_minimap_width(value)
Getter get_minimap_width()
  • bool override_selected_font_color
Default false
Setter set_override_selected_font_color(value)
Getter is_overriding_selected_font_color()
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.

  • bool selecting_enabled
Default true
Setter set_selecting_enabled(value)
Getter is_selecting_enabled()
  • bool shortcut_keys_enabled
Default true
Setter set_shortcut_keys_enabled(value)
Getter is_shortcut_keys_enabled()
  • 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.

  • 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.

  • 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.

Default “”
Setter set_text(value)
Getter get_text()

String value of the TextEdit.

Default 80.0
Setter set_v_scroll_speed(value)
Getter get_v_scroll_speed()

Vertical scroll sensitivity.

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

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

  • void add_keyword_color ( String keyword, Color color )

Adds a keyword and its Color.

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

  • void center_viewport_to_cursor ( )
  • void clear_colors ( )

Clears all custom syntax coloring information previously added with add_color_region or add_keyword_color.

  • void clear_undo_history ( )

Clears the undo history.

  • void copy ( )

Copy’s the current text selection.

  • int cursor_get_column ( ) const

Returns the column the editing cursor is at.

  • int cursor_get_line ( ) const

Returns the line the editing cursor is at.

  • void cursor_set_column ( int column, 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.

  • void cursor_set_line ( int line, bool adjust_viewport=true, bool can_be_hidden=true, 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 set_line_as_hidden.

  • void cut ( )

Cut’s the current selection.

  • void deselect ( )

Deselects the current selection.

  • void fold_all_lines ( )

Folds all lines that are possible to be folded (see can_fold).

  • void fold_line ( int line )

Folds the given line, if possible (see can_fold).

  • Array get_breakpoints ( ) const

Returns an array containing the line number of each breakpoint.

Returns the Color of the specified keyword.

Returns the text of a specific line.

  • int get_line_count ( ) const

Returns the amount of total lines in the text.

Returns the PopupMenu of this TextEdit. By default, this menu is displayed when right-clicking on the TextEdit.

  • int get_selection_from_column ( ) const

Returns the selection begin column.

  • int get_selection_from_line ( ) const

Returns the selection begin line.

  • String get_selection_text ( ) const

Returns the text inside the selection.

  • int get_selection_to_column ( ) const

Returns the selection end column.

  • int get_selection_to_line ( ) const

Returns the selection end line.

  • String get_word_under_cursor ( ) const

Returns a String text with the word under the mouse cursor location.

Returns whether the specified keyword has a color set to it or not.

  • void insert_text_at_cursor ( String text )

Insert the specified text at the cursor position.

  • bool is_folded ( int line ) const

Returns whether the line at the specified index is folded or not.

  • bool is_line_hidden ( int line ) const

Returns whether the line at the specified index is hidden or not.

  • bool is_selection_active ( ) const

Returns true if the selection is active.

  • void menu_option ( int option )

Triggers a right-click menu action by the specified index. See MenuItems for a list of available indexes.

  • void paste ( )

Paste the current selection.

  • void redo ( )

Perform redo operation.

  • void remove_breakpoints ( )

Removes all the breakpoints. This will not fire the breakpoint_toggled signal.

Perform a search inside the text. Search flags can be specified in the 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 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]
  • void select ( int from_line, int from_column, int to_line, int to_column )

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

  • void select_all ( )

Select all the text.

  • void set_line_as_hidden ( int line, bool enable )

If true, hides the line of the specified index.

  • void toggle_fold_line ( int line )

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

  • void undo ( )

Perform undo operation.

  • void unfold_line ( int line )

Unfolds the given line, if folded.

  • void unhide_all_lines ( )

Unhide all lines that were previously set to hidden by set_line_as_hidden.