TextEdit

Multiline text editing control.

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

Theme Properties

• breakpoint_toggled ( int row )

Emitted when a breakpoint is placed via the breakpoint gutter.

• cursor_changed ( )

Emitted when the cursor changes.

• info_clicked ( row, String info )

Emitted when the info icon is clicked.

• request_completion ( )

• symbol_lookup ( symbol, int row, column )

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

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.

• breakpoint_gutter

If true, the breakpoint gutter is visible.

• bool caret_blink

If true, the caret (visual cursor) blinks.

• caret_blink_speed

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

• bool caret_block_mode

If true, the caret displays as a rectangle.

If false, the caret displays as a bar.

• caret_moving_by_right_click

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.

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

• bool draw_spaces

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

• draw_tabs

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

• bool fold_gutter

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

• hiding_enabled

If true, all lines that have been set to hidden by set_line_as_hidden, will not be visible.

• highlight_all_occurrences

If true, all occurrences of the selected text will be highlighted.

• bool highlight_current_line

If true, the line containing the cursor is highlighted.

• minimap_draw

If true, a minimap is shown, providing an outline of your source code.

• int minimap_width

The width, in pixels, of the minimap.

• override_selected_font_color

If true, custom font_color_selected will be used for selected text.

• bool readonly

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

• scroll_horizontal

The current horizontal scroll value.

• float scroll_vertical

The current vertical scroll value.

• selecting_enabled

If false, text can not be selected by the user or by the select or methods.

• bool shortcut_keys_enabled

If , shortcut keys for context menu items are enabled, even if the context menu is disabled.

• show_line_numbers

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

• bool smooth_scrolling

If true, sets the step of the scrollbars to 0.25 which results in smoother scrolling.

• syntax_highlighting

If true, any custom color properties that have been set for this TextEdit will be visible.

• String text

String value of the TextEdit.

• v_scroll_speed

Vertical scroll sensitivity.

• bool virtual_keyboard_enabled

If true, the native virtual keyboard is shown when focused on platforms that support it.

• wrap_enabled

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

Method Descriptions

• void add_color_region ( String begin_key, end_key, Color color, line_only=false )

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

• void add_keyword_color ( String keyword, color )

Adds a keyword and its Color.

• can_fold ( int line ) const

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

• void center_viewport_to_cursor ( )

Centers the viewport on the line the editing cursor is at. This also resets the value to 0.

• void clear_colors ( )

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

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

• cursor_get_line ( ) const

Returns the line the editing cursor is at.

• void cursor_set_column ( int column, 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, adjust_viewport=true, bool can_be_hidden=true, 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.

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

• void fold_line ( int line )

Folds the given line, if possible (see ).

• Array get_breakpoints ( ) const

Returns an array containing the line number of each breakpoint.

• get_keyword_color ( String keyword ) const

Returns the of the specified keyword.

• String get_line ( line ) const

• int get_line_count ( ) const

Returns the amount of total lines in the text.

• get_menu ( ) const

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

• get_selection_from_column ( ) const

Returns the selection begin column.

• int get_selection_from_line ( ) const

Returns the selection begin line.

• get_selection_text ( ) const

Returns the text inside the selection.

• int get_selection_to_column ( ) const

Returns the selection end column.

• get_selection_to_line ( ) const

Returns the selection end line.

• String get_word_under_cursor ( ) const

Returns a text with the word under the caret (text cursor) location.

• bool has_keyword_color ( keyword ) const

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.

• is_folded ( int line ) const

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

• is_line_hidden ( int line ) const

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

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

• search ( String key, flags, int from_line, from_column ) const

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 enum, e.g:

• void select ( int from_line, from_column, int to_line, to_column )

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

If selecting_enabled is false, no selection will occur.

• void select_all ( )

Select all the text.

If is , no selection will occur.

• void set_line ( int line, new_text )

Sets the text for a specific line.

• void set_line_as_hidden ( int line, 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 ( 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.