Interface DocumentDropEditProvider<T>

Provider which handles dropping of resources into a text editor.

This allows users to drag and drop resources (including resources from external apps) into the editor. While dragging and dropping files, users can hold down shift to drop the file into the editor instead of opening it. Requires editor.dropIntoEditor.enabled to be on.

interface DocumentDropEditProvider<
    T extends DocumentDropEdit = DocumentDropEdit,
> {
    provideDocumentDropEdits(
        document: TextDocument,
        position: Position,
        dataTransfer: DataTransfer,
        token: CancellationToken,
    ): ProviderResult<T | T[]>;
    resolveDocumentDropEdit?(
        edit: T,
        token: CancellationToken,
    ): ProviderResult<T>;
}

Type Parameters

T extends DocumentDropEdit = DocumentDropEdit

Index

Methods

provideDocumentDropEdits resolveDocumentDropEdit?

Methods

provideDocumentDropEdits

provideDocumentDropEdits(
    document: TextDocument,
    position: Position,
    dataTransfer: DataTransfer,
    token: CancellationToken,
): ProviderResult<T | T[]>
Provide edits which inserts the content being dragged and dropped into the document.
Parameters
- document: TextDocument
  The document in which the drop occurred.
- position: Position
  The position in the document where the drop occurred.
- dataTransfer: DataTransfer
  A DataTransfer object that holds data about what is being dragged and dropped.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<T | T[]>
A DocumentDropEdit or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.
- Defined in packages/plugin/src/theia.d.ts:14802

`Optional`resolveDocumentDropEdit

resolveDocumentDropEdit?(edit: T, token: CancellationToken): ProviderResult<T>
Optional method which fills in the DocumentDropEdit.additionalEdit before the edit is applied.

This is called once per edit and should be used if generating the complete edit may take a long time. Resolve can only be used to change DocumentDropEdit.additionalEdit.
Parameters
- edit: T
  The DocumentDropEdit to resolve.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<T>
The resolved edit or a thenable that resolves to such. It is OK to return the given edit. If no result is returned, the given edit is used.

Stubbed
- Defined in packages/plugin/src/theia.d.ts:14817

Interface DocumentDropEditProvider<T>

Type Parameters

Index

Methods

Methods

provideDocumentDropEdits

Parameters

Returns ProviderResult<T | T[]>

`Optional`resolveDocumentDropEdit

Parameters

Returns ProviderResult<T>

Stubbed

Settings

On This Page

Interface DocumentDropEditProvider<T>

Type Parameters

Index

Methods

Methods

provideDocumentDropEdits

Parameters

Returns ProviderResult<T | T[]>

OptionalresolveDocumentDropEdit

Parameters

Returns ProviderResult<T>

Stubbed

Settings

On This Page

`Optional`resolveDocumentDropEdit