lsp / org.pinelang.lsp.lsp.models / CompletionItem
CompletionItem¶
data class CompletionItem
Constructors¶
Name | Summary |
---|---|
<init> | CompletionItem(label: String , kind: Int ? = null, detail: String ? = null, documentation: String ? = null, deprecated: Boolean ? = null, preselect: Boolean ? = false, sortText: String ? = null, filterText: String ? = null, insertText: String ? = null, insertTextFormat: Int ? = null, textEdit: TextEdit ? = null, additionalTextEdits: List < TextEdit >? = null, commitCharacters: List < String >? = null, command: Command ? = null, data: Any ? = null) |
Properties¶
Name | Summary |
---|---|
additionalTextEdits | An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves.val additionalTextEdits: List < TextEdit >? |
command | An optional command that is executed after inserting this completion. Note that additional modifications to the current document should be described with the additionalTextEdits-property.val command: Command ? |
commitCharacters | An optional set of characters that when pressed while this completion is active will accept it first and then type that character. Note that all commit characters should have length=1 and that superfluous characters will be ignored.val commitCharacters: List < String >? |
data | A data entry field that is preserved on a completion item between a completion and a completion resolve request.val data: Any ? |
deprecated | Indicates if this item is deprecated.val deprecated: Boolean ? |
detail | A human-readable string with additional information about this item, like type or symbol information.val detail: String ? |
documentation | A human-readable string that represents a doc-comment.val documentation: String ? |
filterText | A string that should be used when filtering a set of completion items. When falsy the label is used.val filterText: String ? |
insertText | A string that should be inserted into a document when selecting this completion. When falsy the label is used.val insertText: String ? |
insertTextFormat | The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit . If omitted defaults to InsertTextFormat.PlainText . 1: The primary text to be inserted is treated as a plain string. 2: The primary text to be inserted is treated as a snippet.val insertTextFormat: Int ? |
kind | The kind of this completion item. Based of the kind an icon is chosen by the editor. The standardized set of available values is defined in CompletionItemKind .val kind: Int ? |
label | The label of this completion item. By default also the text that is inserted when selecting this completion.val label: String |
preselect | Select this item when showing.val preselect: Boolean ? |
sortText | A string that should be used when comparing this item with other items. When falsy the label is used.val sortText: String ? |
textEdit | An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored.val textEdit: TextEdit ? |