A multiline text editor designed for editing code.
class CodeEditCodeEdit is a specialized TextEdit designed for editing plain text code files. It has many features commonly found in code editors such as line numbers, line folding, code completion, indent management, and string/comment management.
This object emits the following signals:
import SwiftGodotFramework to write Godot Game Extensions using the Swift Programming Language.
class TextEditA multiline text editor.
var breakpointToggled: Signal1 { get }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.
var codeCompletionRequested: SimpleSignal { get }Emitted when the user requests code completion.
var symbolLookup: Signal2 { get }Emitted when the user has clicked on a valid symbol.
var symbolValidate: Signal3 { get }Emitted when the user hovers over a symbol. The symbol should be validated and responded to, by calling setSymbolLookupWordAsValid(_:).
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol Hashable : EquatableA type that can be hashed into a Hasher to produce an integer hash value.
protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable : VariantStorableTypes that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.
protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
override class var godotClassName: StringName { get }final var autoBraceCompletionEnabled: Bool { get set }Sets whether brace pairs should be autocompleted.
final var autoBraceCompletionHighlightMatching: Bool { get set }Highlight mismatching brace pairs.
final var autoBraceCompletionPairs: GDictionary { get set }Sets the brace pairs to be autocompleted.
final var codeCompletionEnabled: Bool { get set }Sets whether code completion is allowed.
final var codeCompletionPrefixes: VariantCollection<String> { get set }Sets prefixes that will trigger code completion.
final var delimiterComments: VariantCollection<String> { get set }Sets the comment delimiters. All existing comment delimiters will be removed.
final var delimiterStrings: VariantCollection<String> { get set }Sets the string delimiters. All existing string delimiters will be removed.
final var guttersDrawBookmarks: Bool { get set }Sets if bookmarked should be drawn in the gutter. This gutter is shared with breakpoints and executing lines.
final var guttersDrawBreakpointsGutter: Bool { get set }Sets if breakpoints should be drawn in the gutter. This gutter is shared with bookmarks and executing lines.
final var guttersDrawExecutingLines: Bool { get set }Sets if executing lines should be marked in the gutter. This gutter is shared with breakpoints and bookmarks lines.
final var guttersDrawFoldGutter: Bool { get set }Sets if foldable lines icons should be drawn in the gutter.
final var guttersDrawLineNumbers: Bool { get set }Sets if line numbers should be drawn in the gutter.
final var guttersZeroPadLineNumbers: Bool { get set }Sets if line numbers drawn in the gutter are zero padded.
final var indentAutomatic: Bool { get set }Sets whether automatic indent are enabled, this will add an extra indent if a prefix or brace is found.
final var indentAutomaticPrefixes: VariantCollection<String> { get set }Prefixes to trigger an automatic indent.
final var indentSize: Int32 { get set }Size of the tabulation indent (one [kbd]Tab[/kbd] press) in characters. If indentUseSpaces is enabled the number of spaces to use.
final var indentUseSpaces: Bool { get set }Use spaces instead of tabs for indentation.
final var lineFolding: Bool { get set }Sets whether line folding is allowed.
final var lineLengthGuidelines: VariantCollection<Int64> { get set }Draws vertical lines at the provided columns. The first entry is considered a main hard guideline and is draw more prominently.
final var symbolLookupOnClick: Bool { get set }Set when a validated word from [signal symbol_validate] is clicked, the [signal symbol_lookup] should be emitted.
func _confirmCodeCompletion(replace: Bool) Override this method to define how the selected entry should be inserted. If replace is true, any existing text should be replaced.
func _filterCodeCompletionCandidates(_ candidates: VariantCollection<GDictionary>) -> VariantCollection<GDictionary> Override this method to define what items in candidates should be displayed.
func _requestCodeCompletion(force: Bool) Override this method to define what happens when the user requests code completion. If force is true, any checks should be bypassed.
final func addAutoBraceCompletionPair(startKey: String, endKey: String) Adds a brace pair.
final func addCodeCompletionOption(type: CodeEdit.CodeCompletionKind, displayText: String, insertText: String, textColor: Color = Color (r: 1, g: 1, b: 1, a: 1), icon: Resource? = nil, value: Variant, location: Int32 = 1024) Submits an item to the queue of potential candidates for the autocomplete menu. Call updateCodeCompletionOptions(force:) to update the list.
final func addCommentDelimiter(startKey: String, endKey: String, lineOnly: Bool = false) Adds a comment delimiter from startKey to endKey. Both keys should be symbols, and startKey must not be shared with other delimiters.
final func addStringDelimiter(startKey: String, endKey: String, lineOnly: Bool = false) Defines a string delimiter from startKey to endKey. Both keys should be symbols, and startKey must not be shared with other delimiters.
final func canFoldLine(_ line: Int32) -> Bool Returns if the given line is foldable, that is, it has indented lines right below it or a comment / string block.
final func cancelCodeCompletion() Cancels the autocomplete menu.
final func clearBookmarkedLines() Clears all bookmarked lines.
final func clearBreakpointedLines() Clears all breakpointed lines.
final func clearCommentDelimiters() Removes all comment delimiters.
final func clearExecutingLines() Clears all executed lines.
final func clearStringDelimiters() Removes all string delimiters.
final func confirmCodeCompletion(replace: Bool = false) Inserts the selected entry into the text. If replace is true, any existing text is replaced rather than merged.
final func convertIndent(fromLine: Int32 = -1, toLine: Int32 = -1) Converts the indents of lines between fromLine and toLine to tabs or spaces as set by indentUseSpaces.
final func createCodeRegion() Creates a new code region with the selection. At least one single line comment delimiter have to be defined (see addCommentDelimiter(startKey:endKey:lineOnly:)).
final func deleteLines() Deletes all lines that are selected or have a caret on them.
final func doIndent() Perform an indent as if the user activated the “ui_text_indent” action.
final func duplicateLines() Duplicates all lines currently selected with any caret. Duplicates the entire line beneath the current one no matter where the caret is within the line.
final func duplicateSelection() Duplicates all selected text and duplicates all lines with a caret on them.
final func foldAllLines() Folds all lines that are possible to be folded (see canFoldLine(_:)).
final func foldLine(_ line: Int32) Folds the given line, if possible (see canFoldLine(_:)).
final func getAutoBraceCompletionCloseKey(openKey: String) -> String Gets the matching auto brace close key for openKey.
final func getBookmarkedLines() -> PackedInt32Array Gets all bookmarked lines.
final func getBreakpointedLines() -> PackedInt32Array Gets all breakpointed lines.
final func getCodeCompletionOption(index: Int32) -> GDictionary Gets the completion option at index. The return GDictionary has the following key-values:
final func getCodeCompletionOptions() -> VariantCollection<GDictionary> Gets all completion options, see getCodeCompletionOption(index:) for return content.
final func getCodeCompletionSelectedIndex() -> Int32 Gets the index of the current selected completion option.
final func getCodeRegionEndTag() -> String Returns the code region end tag (without comment delimiter).
final func getCodeRegionStartTag() -> String Returns the code region start tag (without comment delimiter).
final func getDelimiterEndKey(delimiterIndex: Int32) -> String Gets the end key for a string or comment region index.
final func getDelimiterEndPosition(line: Int32, column: Int32) -> Vector2 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.
final func getDelimiterStartKey(delimiterIndex: Int32) -> String Gets the start key for a string or comment region index.
final func getDelimiterStartPosition(line: Int32, column: Int32) -> Vector2 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.
final func getExecutingLines() -> PackedInt32Array Gets all executing lines.
final func getFoldedLines() -> VariantCollection<Int64> Returns all lines that are current folded.
final func getTextForCodeCompletion() -> String Returns the full text with char 0xFFFF at the caret location.
final func getTextForSymbolLookup() -> String Returns the full text with char 0xFFFF at the cursor location.
final func getTextWithCursorChar(line: Int32, column: Int32) -> String Returns the full text with char 0xFFFF at the specified location.
final func hasAutoBraceCompletionCloseKey(_ closeKey: String) -> Bool Returns true if close key closeKey exists.
final func hasAutoBraceCompletionOpenKey(_ openKey: String) -> Bool Returns true if open key openKey exists.
final func hasCommentDelimiter(startKey: String) -> Bool Returns true if comment startKey exists.
final func hasStringDelimiter(startKey: String) -> Bool Returns true if string startKey exists.
final func indentLines() Indents selected lines, or in the case of no selection the caret line by one.
final func isInComment(line: Int32, column: Int32 = -1) -> Int32 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.
final func isInString(line: Int32, column: Int32 = -1) -> Int32 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.
final func isLineBookmarked(line: Int32) -> Bool Returns whether the line at the specified index is bookmarked or not.
final func isLineBreakpointed(line: Int32) -> Bool Returns whether the line at the specified index is breakpointed or not.
final func isLineCodeRegionEnd(line: Int32) -> Bool Returns whether the line at the specified index is a code region end.
final func isLineCodeRegionStart(line: Int32) -> Bool Returns whether the line at the specified index is a code region start.
final func isLineExecuting(line: Int32) -> Bool Returns whether the line at the specified index is marked as executing or not.
final func isLineFolded(line: Int32) -> Bool Returns whether the line at the specified index is folded or not.
final func moveLinesDown() Moves all lines down that are selected or have a caret on them.
final func moveLinesUp() Moves all lines up that are selected or have a caret on them.
final func removeCommentDelimiter(startKey: String) Removes the comment delimiter with startKey.
final func removeStringDelimiter(startKey: String) Removes the string delimiter with startKey.
final func requestCodeCompletion(force: Bool = false) Emits [signal 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.
final func setCodeCompletionSelectedIndex(_ index: Int32) Sets the current selected completion option.
final func setCodeHint(_ codeHint: String) Sets the code hint text. Pass an empty string to clear.
final func setCodeHintDrawBelow(_ drawBelow: Bool) Sets if the code hint should draw below the text.
final func setCodeRegionTags(start: String = "region", end: String = "endregion") Sets the code region start and end tags (without comment delimiter).
final func setLineAsBookmarked(line: Int32, bookmarked: Bool) Sets the line as bookmarked.
final func setLineAsBreakpoint(line: Int32, breakpointed: Bool) Sets the line as breakpointed.
final func setLineAsExecuting(line: Int32, executing: Bool) Sets the line as executing.
final func setSymbolLookupWordAsValid(_ valid: Bool) Sets the symbol emitted by [signal symbol_validate] as a valid lookup.
final func toggleFoldableLine(_ line: Int32) Toggle the folding of the code block at the given line.
final func toggleFoldableLinesAtCarets() Toggle the folding of the code block on all lines with a caret on them.
final func unfoldAllLines() Unfolds all lines, folded or not.
final func unfoldLine(_ line: Int32) Unfolds all lines that were previously folded.
final func unindentLines() Unindents selected lines, or in the case of no selection the caret line by one. Same as performing “ui_text_unindent” action.
final func updateCodeCompletionOptions(force: Bool) Submits all completion options added with addCodeCompletionOption(type:displayText:insertText:textColor:icon:value:location:). Will try to force the autocomplete menu to popup, if force is true.
enum CodeCompletionKindenum CodeCompletionLocationclass Signal1Signal support.
class Signal2Signal support.
class Signal3Signal support.