Interface CodeLensProvider<T>

A code lens provider adds commands to source text. The commands will be shown as dedicated horizontal lines in between the source text.

Type Parameters

T extends CodeLens = CodeLens

Hierarchy

CodeLensProvider

Index

Properties

onDidChangeCodeLenses

Methods

Properties

Optional onDidChangeCodeLenses

onDidChangeCodeLenses?: Event<void>

An optional event to signal that the code lenses from this provider have changed.

Methods

provideCodeLenses

provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<T[]>

- Defined in packages/plugin/src/theia.d.ts:9750
Compute a list of lenses. This call should return as fast as possible and if computing the commands is expensive implementors should only return code lens objects with the range set and implement resolve.

Parameters
- document: TextDocument
  
  The document in which the command was invoked.
- token: CancellationToken
  
  A cancellation token.
Returns ProviderResult<T[]>
An array of code lenses or a thenable that resolves to such. The lack of a result can be signaled by returning undefined, null, or an empty array.

Optional resolveCodeLens

resolveCodeLens(codeLens: T, token: CancellationToken): ProviderResult<T>

- Defined in packages/plugin/src/theia.d.ts:9759
This function will be called for each visible code lens, usually when scrolling and after calls to compute-lenses.

Parameters
- codeLens: T
  
  code lens that must be resolved.
- token: CancellationToken
  
  A cancellation token.
Returns ProviderResult<T>
The given, resolved code lens or thenable that resolves to such.