CodeEdit

Inherits: TextEdit < Control < CanvasItem < Node < Object

Multiline text control intended for editing code.

Description

CodeEdit is a specialized TextEdit designed for editing plain text code files. It contains a bunch of features commonly found in code editors such as line numbers, line folding, code completion, indent management and string / comment management.

Note: By default CodeEdit always use left-to-right text direction to correctly display source code.

Properties

bool

auto_brace_completion_enabled

false

bool

auto_brace_completion_highlight_matching

false

Dictionary

auto_brace_completion_pairs

{ "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }

bool

code_completion_enabled

false

String[]

code_completion_prefixes

[]

String[]

delimiter_comments

[]

String[]

delimiter_strings

["' '", "\" \""]

bool

gutters_draw_bookmarks

false

bool

gutters_draw_breakpoints_gutter

false

bool

gutters_draw_executing_lines

false

bool

gutters_draw_fold_gutter

false

bool

gutters_draw_line_numbers

false

bool

gutters_zero_pad_line_numbers

false

bool

indent_automatic

false

String[]

indent_automatic_prefixes

[":", "{", "[", "("]

int

indent_size

4

bool

indent_use_spaces

false

LayoutDirection

layout_direction

2 (overrides Control)

bool

line_folding

false

int[]

line_length_guidelines

[]

bool

symbol_lookup_on_click

false

TextDirection

text_direction

1 (overrides TextEdit)

Methods

void

_confirm_code_completion ( bool replace ) virtual

Dictionary[]

_filter_code_completion_candidates ( Dictionary[] candidates ) virtual const

void

_request_code_completion ( bool force ) virtual

void

add_auto_brace_completion_pair ( String start_key, String end_key )

void

add_code_completion_option ( CodeCompletionKind type, String display_text, String insert_text, Color text_color=Color(1, 1, 1, 1), Resource icon=null, Variant value=0 )

void

add_comment_delimiter ( String start_key, String end_key, bool line_only=false )

void

add_string_delimiter ( String start_key, String end_key, bool line_only=false )

bool

can_fold_line ( int line ) const

void

cancel_code_completion ( )

void

clear_bookmarked_lines ( )

void

clear_breakpointed_lines ( )

void

clear_comment_delimiters ( )

void

clear_executing_lines ( )

void

clear_string_delimiters ( )

void

confirm_code_completion ( bool replace=false )

void

do_indent ( )

void

fold_all_lines ( )

void

fold_line ( int line )

String

get_auto_brace_completion_close_key ( String open_key ) const

PackedInt32Array

get_bookmarked_lines ( ) const

PackedInt32Array

get_breakpointed_lines ( ) const

Dictionary

get_code_completion_option ( int index ) const

Dictionary[]

get_code_completion_options ( ) const

int

get_code_completion_selected_index ( ) const

String

get_delimiter_end_key ( int delimiter_index ) const

Vector2

get_delimiter_end_position ( int line, int column ) const

String

get_delimiter_start_key ( int delimiter_index ) const

Vector2

get_delimiter_start_position ( int line, int column ) const

PackedInt32Array

get_executing_lines ( ) const

int[]

get_folded_lines ( ) const

String

get_text_for_code_completion ( ) const

String

get_text_for_symbol_lookup ( )

bool

has_auto_brace_completion_close_key ( String close_key ) const

bool

has_auto_brace_completion_open_key ( String open_key ) const

bool

has_comment_delimiter ( String start_key ) const

bool

has_string_delimiter ( String start_key ) const

void

indent_lines ( )

int

is_in_comment ( int line, int column=-1 ) const

int

is_in_string ( int line, int column=-1 ) const

bool

is_line_bookmarked ( int line ) const

bool

is_line_breakpointed ( int line ) const

bool

is_line_executing ( int line ) const

bool

is_line_folded ( int line ) const

void

remove_comment_delimiter ( String start_key )

void

remove_string_delimiter ( String start_key )

void

request_code_completion ( bool force=false )

void

set_code_completion_selected_index ( int index )

void

set_code_hint ( String code_hint )

void

set_code_hint_draw_below ( bool draw_below )

void

set_line_as_bookmarked ( int line, bool bookmarked )

void

set_line_as_breakpoint ( int line, bool breakpointed )

void

set_line_as_executing ( int line, bool executing )

void

set_symbol_lookup_word_as_valid ( bool valid )

void

toggle_foldable_line ( int line )

void

unfold_all_lines ( )

void

unfold_line ( int line )

void

unindent_lines ( )

void

update_code_completion_options ( bool force )

Theme Properties

Color

background_color

Color(0, 0, 0, 0)

Color

bookmark_color

Color(0.5, 0.64, 1, 0.8)

Color

brace_mismatch_color

Color(1, 0.2, 0.2, 1)

Color

breakpoint_color

Color(0.9, 0.29, 0.3, 1)

Color

caret_background_color

Color(0, 0, 0, 1)

Color

caret_color

Color(0.875, 0.875, 0.875, 1)

Color

code_folding_color

Color(0.8, 0.8, 0.8, 0.8)

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)

Color

completion_scroll_color

Color(1, 1, 1, 0.29)

Color

completion_scroll_hovered_color

Color(1, 1, 1, 0.4)

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.98, 0.89, 0.27, 1)

Color

font_color

Color(0.875, 0.875, 0.875, 1)

Color

font_outline_color

Color(1, 1, 1, 1)

Color

font_placeholder_color

Color(0.875, 0.875, 0.875, 0.6)

Color

font_readonly_color

Color(0.875, 0.875, 0.875, 0.5)

Color

font_selected_color

Color(0, 0, 0, 0)

Color

line_length_guideline_color

Color(0.3, 0.5, 0.8, 0.1)

Color

line_number_color

Color(0.67, 0.67, 0.67, 0.4)

Color

search_result_border_color

Color(0.3, 0.3, 0.3, 0.4)

Color

search_result_color

Color(0.3, 0.3, 0.3, 1)

Color

selection_color

Color(0.5, 0.5, 0.5, 1)

Color

word_highlighted_color

Color(0.8, 0.9, 0.9, 0.15)

int

completion_lines

7

int

completion_max_width

50

int

completion_scroll_width

6

int

line_spacing

4

int

outline_size

0

Font

font

int

font_size

Texture2D

bookmark

Texture2D

breakpoint

Texture2D

can_fold

Texture2D

executing_line

Texture2D

folded

Texture2D

folded_eol_icon

Texture2D

space

Texture2D

tab

StyleBox

completion

StyleBox

focus

StyleBox

normal

StyleBox

read_only


Signals

breakpoint_toggled ( int line )

Emitted when a breakpoint is added or removed from a line. If the line is moved via backspace a removed is emitted at the old line.


code_completion_requested ( )

Emitted when the user requests code completion.


symbol_lookup ( String symbol, int line, int column )

Emitted when the user has clicked on a valid symbol.


symbol_validate ( String symbol )

Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling set_symbol_lookup_word_as_valid.


Enumerations

enum CodeCompletionKind:

CodeCompletionKind KIND_CLASS = 0

Marks the option as a class.

CodeCompletionKind KIND_FUNCTION = 1

Marks the option as a function.

CodeCompletionKind KIND_SIGNAL = 2

Marks the option as a Godot signal.

CodeCompletionKind KIND_VARIABLE = 3

Marks the option as a variable.

CodeCompletionKind KIND_MEMBER = 4

Marks the option as a member.

CodeCompletionKind KIND_ENUM = 5

Marks the option as a enum entry.

CodeCompletionKind KIND_CONSTANT = 6

Marks the option as a constant.

CodeCompletionKind KIND_NODE_PATH = 7

Marks the option as a Godot node path.

CodeCompletionKind KIND_FILE_PATH = 8

Marks the option as a file path.

CodeCompletionKind KIND_PLAIN_TEXT = 9

Marks the option as unclassified or plain text.


Property Descriptions

bool auto_brace_completion_enabled = false

  • void set_auto_brace_completion_enabled ( bool value )

  • bool is_auto_brace_completion_enabled ( )

Sets whether brace pairs should be autocompleted.


bool auto_brace_completion_highlight_matching = false

  • void set_highlight_matching_braces_enabled ( bool value )

  • bool is_highlight_matching_braces_enabled ( )

Highlight mismatching brace pairs.


Dictionary auto_brace_completion_pairs = { "\"": "\"", "'": "'", "(": ")", "[": "]", "{": "}" }

  • void set_auto_brace_completion_pairs ( Dictionary value )

  • Dictionary get_auto_brace_completion_pairs ( )

Sets the brace pairs to be autocompleted.


bool code_completion_enabled = false

  • void set_code_completion_enabled ( bool value )

  • bool is_code_completion_enabled ( )

Sets whether code completion is allowed.


String[] code_completion_prefixes = []

  • void set_code_completion_prefixes ( String[] value )

  • String[] get_code_completion_prefixes ( )

Sets prefixes that will trigger code completion.


String[] delimiter_comments = []

  • void set_comment_delimiters ( String[] value )

  • String[] get_comment_delimiters ( )

Sets the comment delimiters. All existing comment delimiters will be removed.


String[] delimiter_strings = ["' '", "\" \""]

  • void set_string_delimiters ( String[] value )

  • String[] get_string_delimiters ( )

Sets the string delimiters. All existing string delimiters will be removed.


bool gutters_draw_bookmarks = false

  • void set_draw_bookmarks_gutter ( bool value )

  • bool is_drawing_bookmarks_gutter ( )

Sets if bookmarked should be drawn in the gutter. This gutter is shared with breakpoints and executing lines.


bool gutters_draw_breakpoints_gutter = false

  • void set_draw_breakpoints_gutter ( bool value )

  • bool is_drawing_breakpoints_gutter ( )

Sets if breakpoints should be drawn in the gutter. This gutter is shared with bookmarks and executing lines.


bool gutters_draw_executing_lines = false

  • void set_draw_executing_lines_gutter ( bool value )

  • bool is_drawing_executing_lines_gutter ( )

Sets if executing lines should be marked in the gutter. This gutter is shared with breakpoints and bookmarks lines.


bool gutters_draw_fold_gutter = false

  • void set_draw_fold_gutter ( bool value )

  • bool is_drawing_fold_gutter ( )

Sets if foldable lines icons should be drawn in the gutter.


bool gutters_draw_line_numbers = false

  • void set_draw_line_numbers ( bool value )

  • bool is_draw_line_numbers_enabled ( )

Sets if line numbers should be drawn in the gutter.


bool gutters_zero_pad_line_numbers = false

  • void set_line_numbers_zero_padded ( bool value )

  • bool is_line_numbers_zero_padded ( )

Sets if line numbers drawn in the gutter are zero padded.


bool indent_automatic = false

  • void set_auto_indent_enabled ( bool value )

  • bool is_auto_indent_enabled ( )

Sets whether automatic indent are enabled, this will add an extra indent if a prefix or brace is found.


String[] indent_automatic_prefixes = [":", "{", "[", "("]

  • void set_auto_indent_prefixes ( String[] value )

  • String[] get_auto_indent_prefixes ( )

Prefixes to trigger an automatic indent.


int indent_size = 4

  • void set_indent_size ( int value )

  • int get_indent_size ( )

Size of tabs, if indent_use_spaces is enabled the number of spaces to use.


bool indent_use_spaces = false

  • void set_indent_using_spaces ( bool value )

  • bool is_indent_using_spaces ( )

Use spaces instead of tabs for indentation.


bool line_folding = false

  • void set_line_folding_enabled ( bool value )

  • bool is_line_folding_enabled ( )

Sets whether line folding is allowed.


int[] line_length_guidelines = []

  • void set_line_length_guidelines ( int[] value )

  • int[] get_line_length_guidelines ( )

Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently


bool symbol_lookup_on_click = false

  • void set_symbol_lookup_on_click_enabled ( bool value )

  • bool is_symbol_lookup_on_click_enabled ( )

Set when a validated word from symbol_validate is clicked, the symbol_lookup should be emitted.


Method Descriptions

void _confirm_code_completion ( bool replace ) virtual

Override this method to define how the selected entry should be inserted. If replace is true, any existing text should be replaced.


Dictionary[] _filter_code_completion_candidates ( Dictionary[] candidates ) virtual const

Override this method to define what items in candidates should be displayed.

Both candidates and the return is a Array of Dictionary, see get_code_completion_option for Dictionary content.


void _request_code_completion ( bool force ) virtual

Override this method to define what happens when the user requests code completion. If force is true, any checks should be bypassed.


void add_auto_brace_completion_pair ( String start_key, String end_key )

Adds a brace pair.

Both the start and end keys must be symbols. Only the start key has to be unique.


void add_code_completion_option ( CodeCompletionKind type, String display_text, String insert_text, Color text_color=Color(1, 1, 1, 1), Resource icon=null, Variant value=0 )

Submits an item to the queue of potential candidates for the autocomplete menu. Call update_code_completion_options to update the list.

Note: This list will replace all current candidates.


void add_comment_delimiter ( String start_key, String end_key, bool line_only=false )

Adds a comment delimiter.

Both the start and end keys must be symbols. Only the start key has to be unique.

Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to true.


void add_string_delimiter ( String start_key, String end_key, bool line_only=false )

Adds a string delimiter.

Both the start and end keys must be symbols. Only the start key has to be unique.

Line only denotes if the region should continue until the end of the line or carry over on to the next line. If the end key is blank this is automatically set to true.


bool can_fold_line ( int line ) const

Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block.


void cancel_code_completion ( )

Cancels the autocomplete menu.


void clear_bookmarked_lines ( )

Clears all bookmarked lines.


void clear_breakpointed_lines ( )

Clears all breakpointed lines.


void clear_comment_delimiters ( )

Removes all comment delimiters.


void clear_executing_lines ( )

Clears all executed lines.


void clear_string_delimiters ( )

Removes all string delimiters.


void confirm_code_completion ( bool replace=false )

Inserts the selected entry into the text. If replace is true, any existing text is replaced rather then merged.


void do_indent ( )

Perform an indent as if the user activated the "ui_text_indent" action.


void fold_all_lines ( )

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


void fold_line ( int line )

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


String get_auto_brace_completion_close_key ( String open_key ) const

Gets the matching auto brace close key for open_key.


PackedInt32Array get_bookmarked_lines ( ) const

Gets all bookmarked lines.


PackedInt32Array get_breakpointed_lines ( ) const

Gets all breakpointed lines.


Dictionary get_code_completion_option ( int index ) const

Gets the completion option at index. The return Dictionary has the following key-values:

kind