CodeEdit¶
Inherits: TextEdit < Control < CanvasItem < Node < Object
Multiline text control intended for editing code.
Description¶
CodeEdit is a specialised 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¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
layout_direction |
|
|
|
||
|
||
|
||
text_direction |
|
Methods¶
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
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.
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:
KIND_CLASS = 0 --- Marks the option as a class.
KIND_FUNCTION = 1 --- Marks the option as a function.
KIND_SIGNAL = 2 --- Marks the option as a Godot signal.
KIND_VARIABLE = 3 --- Marks the option as a variable.
KIND_MEMBER = 4 --- Marks the option as a member.
KIND_ENUM = 5 --- Marks the option as a enum entry.
KIND_CONSTANT = 6 --- Marks the option as a constant.
KIND_NODE_PATH = 7 --- Marks the option as a Godot node path.
KIND_FILE_PATH = 8 --- Marks the option as a file path.
KIND_PLAIN_TEXT = 9 --- Marks the option as unclassified or plain text.
Property Descriptions¶
bool auto_brace_completion_enabled
Default |
|
Setter |
set_auto_brace_completion_enabled(value) |
Getter |
is_auto_brace_completion_enabled() |
Sets whether brace pairs should be autocompleted.
bool auto_brace_completion_highlight_matching
Default |
|
Setter |
set_highlight_matching_braces_enabled(value) |
Getter |
is_highlight_matching_braces_enabled() |
Highlight mismatching brace pairs.
Dictionary auto_brace_completion_pairs
Default |
|
Setter |
set_auto_brace_completion_pairs(value) |
Getter |
get_auto_brace_completion_pairs() |
Sets the brace pairs to be autocompleted.
bool code_completion_enabled
Default |
|
Setter |
set_code_completion_enabled(value) |
Getter |
is_code_completion_enabled() |
Sets whether code completion is allowed.
String[] code_completion_prefixes
Default |
|
Setter |
set_code_completion_prefixes(value) |
Getter |
get_code_comletion_prefixes() |
Sets prefixes that will trigger code completion.
String[] delimiter_comments
Default |
|
Setter |
set_comment_delimiters(value) |
Getter |
get_comment_delimiters() |
Sets the comment delimiters. All existing comment delimiters will be removed.
String[] delimiter_strings
Default |
|
Setter |
set_string_delimiters(value) |
Getter |
get_string_delimiters() |
Sets the string delimiters. All existing string delimiters will be removed.
bool gutters_draw_bookmarks
Default |
|
Setter |
set_draw_bookmarks_gutter(value) |
Getter |
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
Default |
|
Setter |
set_draw_breakpoints_gutter(value) |
Getter |
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
Default |
|
Setter |
set_draw_executing_lines_gutter(value) |
Getter |
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
Default |
|
Setter |
set_draw_fold_gutter(value) |
Getter |
is_drawing_fold_gutter() |
Sets if foldable lines icons should be drawn in the gutter.
bool gutters_draw_line_numbers
Default |
|
Setter |
set_draw_line_numbers(value) |
Getter |
is_draw_line_numbers_enabled() |
Sets if line numbers should be drawn in the gutter.
bool gutters_zero_pad_line_numbers
Default |
|
Setter |
set_line_numbers_zero_padded(value) |
Getter |
is_line_numbers_zero_padded() |
Sets if line numbers drawn in the gutter are zero padded.
bool indent_automatic
Default |
|
Setter |
set_auto_indent_enabled(value) |
Getter |
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
Default |
|
Setter |
set_auto_indent_prefixes(value) |
Getter |
get_auto_indent_prefixes() |
Prefixes to trigger an automatic indent.
int indent_size
Default |
|
Setter |
set_indent_size(value) |
Getter |
get_indent_size() |
Size of tabs, if indent_use_spaces is enabled the number of spaces to use.
bool indent_use_spaces
Default |
|
Setter |
set_indent_using_spaces(value) |
Getter |
is_indent_using_spaces() |
Use spaces instead of tabs for indentation.
bool line_folding
Default |
|
Setter |
set_line_folding_enabled(value) |
Getter |
is_line_folding_enabled() |
Sets whether line folding is allowed.
int[] line_length_guidelines
Default |
|
Setter |
set_line_length_guidelines(value) |
Getter |
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
Default |
|
Setter |
set_symbol_lookup_on_click_enabled(value) |
Getter |
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.
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.
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.
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.
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 do_unindent ( )
Perform an unindent as if the user activated the "ui_text_unindent" 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).
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: CodeCompletionKind
display_text: Text that is shown on the autocomplete menu.
insert_text: Text that is to be inserted when this item is selected.
font_color: Color of the text on the autocomplete menu.
icon: Icon to draw on the autocomplete menu.
default_value: Value of the symbol.
Dictionary[] get_code_completion_options ( ) const
Gets all completion options, see get_code_completion_option for return content.
int get_code_completion_selected_index ( ) const
Gets the index of the current selected completion option.
Gets the end key for a string or comment region index.
If line column is in a string or comment, returns the end position of the region. If not or no end could be found, both Vector2 values will be -1.
Gets the start key for a string or comment region index.
If line column is in a string or comment, returns the start position of the region. If not or no start could be found, both Vector2 values will be -1.
PackedInt32Array get_executing_lines ( ) const
Gets all executing lines.
int[] get_folded_lines ( ) const
Returns all lines that are current folded.
String get_text_for_code_completion ( ) const
Returns the full text with char 0xFFFF at the caret location.
String get_text_for_symbol_lookup ( )
Returns the full text with char 0xFFFF at the cursor location.
Returns true if close key close_key exists.
Returns true if open key open_key exists.
Returns true if comment start_key exists.
Returns true if string start_key exists.
void indent_lines ( )
Indents selected lines, or in the case of no selection the caret line by one.
Returns delimiter index if line column is in a comment. If column is not provided, will return delimiter index if the entire line is a comment. Otherwise -1.
Returns the delimiter index if line column is in a string. If column is not provided, will return the delimiter index if the entire line is a string. Otherwise -1.
Returns whether the line at the specified index is bookmarked or not.
Returns whether the line at the specified index is breakpointed or not.
Returns whether the line at the specified index is marked as executing or not.
Returns whether the line at the specified index is folded or not.
void remove_comment_delimiter ( String start_key )
Removes the comment delimiter with start_key.
void remove_string_delimiter ( String start_key )
Removes the string delimiter with start_key.
void request_code_completion ( bool force=false )
Emits code_completion_requested, if force is true will bypass all checks. Otherwise will check that the caret is in a word or in front of a prefix. Will ignore the request if all current options are of type file path, node path or signal.
void set_code_completion_selected_index ( int index )
Sets the current selected completion option.
void set_code_hint ( String code_hint )
Sets the code hint text. Pass an empty string to clear.
void set_code_hint_draw_below ( bool draw_below )
Sets if the code hint should draw below the text.
Sets the line as bookmarked.
Sets the line as breakpointed.
Sets the line as executing.
void set_symbol_lookup_word_as_valid ( bool valid )
Sets the symbol emitted by symbol_validate as a valid lookup.
void toggle_foldable_line ( int line )
Toggle the folding of the code block at the given line.
void unfold_all_lines ( )
Unfolds all lines, folded or not.
void unfold_line ( int line )
Unfolds all lines that were previously folded.
void unindent_lines ( )
Unindents selected lines, or in the case of no selection the caret line by one.
void update_code_completion_options ( bool force )
Submits all completion options added with add_code_completion_option. Will try to force the autoccomplete menu to popup, if force is true.
Note: This will replace all current candidates.
Theme Property Descriptions¶
Color background_color
Default |
|
Sets the background Color.
Color bookmark_color
Default |
|
Color of the bookmark icon for bookmarked lines.
Color brace_mismatch_color
Default |
|
Color of the text to highlight mismatched braces.
Color breakpoint_color
Default |
|
Color of the breakpoint icon for bookmarked lines.
Color caret_background_color
Default |
|
Color of the text behind the caret when block caret is enabled.
Color caret_color
Default |
|
Color of the caret.
Color code_folding_color
Default |
|
Color for all icons related to line folding.
Color completion_background_color
Default |
|
Sets the background Color for the code completion popup.
Color completion_existing_color
Default |
|
Background highlight Color for matching text in code completion options.
Color completion_font_color
Default |
|
Font Color for the code completion popup.
Color completion_scroll_color
Default |
|
Color of the scrollbar in the code completion popup.
Color completion_scroll_hovered_color
Default |
|
Color of the scrollbar in the code completion popup when hovered.
Color completion_selected_color
Default |
|
Background highlight Color for the current selected option item in the code completion popup.
Color current_line_color
Default |
|
Background Color of the line containing the caret.
Color executing_line_color
Default |
|
Color of the executing icon for executing lines.
Color font_color
Default |
|
Sets the font Color.
Color font_outline_color
Default |
|
The tint of text outline of the CodeEdit.
Color font_placeholder_color
Default |
|
Font color for TextEdit.placeholder_text.
Color font_readonly_color
Default |
|
Sets the font Color when TextEdit.editable is disabled.
Color font_selected_color
Default |
|
Sets the Color of the selected text. TextEdit.override_selected_font_color has to be enabled.
Color line_length_guideline_color
Default |
|
Color of the main line length guideline, secondary guidelines will have 50% alpha applied.
Color line_number_color
Default |
|
Sets the Color of line numbers.
Color search_result_border_color
Default |
|
Color of the border around text that matches the search query.
Color search_result_color
Default |
|
Color behind the text that matches the search query.
Color selection_color
Default |
|
Sets the highlight Color of text selections.
Color word_highlighted_color
Default |
|
Sets the highlight