TextEdit

Category: Core

Multiline text editing control.

Properties

Methods

Signals

• breakpoint_toggled ( int row )

Emitted when a breakpoint is placed via the breakpoint gutter.

• cursor_changed ( )

Emitted when the cursor changes.

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

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

• breakpoint_gutter

If , the breakpoint gutter is visible.

• bool caret_blink

If true, the caret (visual cursor) blinks.

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

• caret_block_mode

If true, the caret displays as a rectangle.

If false, the caret displays as a bar.

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

• context_menu_enabled

If true, a right click displays the context menu.

• int hiding_enabled

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

• override_selected_font_color

• bool readonly

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

• show_line_numbers

If , 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

• String text

String value of the .

• float v_scroll_speed

Vertical scroll sensitivity.

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

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

• void add_keyword_color ( String keyword, color )

Add a keyword and its Color.

• can_fold ( int line ) const

• void clear_colors ( )

Clears all the syntax coloring information.

• void clear_undo_history ( )

Clears the undo history.

• void copy ( )

Copy’s the current text selection.

• 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 ( 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. Default value is true.

• void cursor_set_line ( line, bool adjust_viewport=true, can_be_hidden=true, int wrap_index=0 )

Moves the cursor at the specified index.

If adjust_viewport is set to true, the viewport will center at the cursor position after the move occurs. Default value is true.

If can_be_hidden is set to true, the specified line can be hidden using . Default value is true.

• void cut ( )

Cut’s the current selection.

• void deselect ( )

Deselects the current selection.

• void fold_all_lines ( )

• 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

Returns the text of a specific line.

• int get_line_count ( ) const

Returns the amount of total lines in the text.

• get_menu ( ) const

• int get_selection_from_column ( ) const

• get_selection_from_line ( ) const

Returns the selection begin line.

• String get_selection_text ( ) const

Returns the text inside the selection.

• get_selection_to_column ( ) const

Returns the selection end column.

• int get_selection_to_line ( ) const

Returns the selection end line.

• get_word_under_cursor ( ) const

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

• has_keyword_color ( String keyword ) const

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

• void insert_text_at_cursor ( text )

Insert the specified text at the cursor position.

• bool is_folded ( line ) const

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

• bool is_line_hidden ( 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 ( 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 (without firing “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 SEARCH_* enum.

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

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

• void select_all ( )

Select all the text.

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

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