kotlin-vscode/vscode/CustomEditorProvider

CustomEditorProvider

interface CustomEditorProvider<T : CustomDocument> : CustomReadonlyEditorProvider<T> (source)

Provider for editable custom editors that use a custom document model.

Custom editors use {@linkcode CustomDocument} as their document model instead of a {@linkcode TextDocument}. This gives extensions full control over actions such as edit, save, and backup.

You should use this type of custom editor when dealing with binary files or more complex scenarios. For simple text based documents, use {@linkcode CustomTextEditorProvider} instead.

Parameters

T

Type of the custom document returned by this provider.

Online Documentation

Properties

onDidChangeCustomDocument

abstract val onDidChangeCustomDocument: Event<JsAny>

Signal that an edit has occurred inside a custom editor.

Functions

backupCustomDocument

abstract fun backupCustomDocument(document: T, context: CustomDocumentBackupContext, cancellation: CancellationToken): PromiseLike<CustomDocumentBackup>

Back up a dirty custom document.

openCustomDocument

abstract fun openCustomDocument(uri: Uri, openContext: CustomDocumentOpenContext, token: CancellationToken): PromiseResult<T>

Create a new document for a given resource.

resolveCustomEditor

abstract fun resolveCustomEditor(document: T, webviewPanel: WebviewPanel, token: CancellationToken): PromiseLike<Void?>?

Resolve a custom editor for a given resource.

revertCustomDocument

abstract fun revertCustomDocument(document: T, cancellation: CancellationToken): PromiseLike<Void?>

Revert a custom document to its last saved state.

saveCustomDocument

abstract fun saveCustomDocument(document: T, cancellation: CancellationToken): PromiseLike<Void?>

Save a custom document.

saveCustomDocumentAs

abstract fun saveCustomDocumentAs(document: T, destination: Uri, cancellation: CancellationToken): PromiseLike<Void?>

Save a custom document to a different location.