CodeLensProvider

interface CodeLensProvider<T : CodeLens>(source)

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

Online Documentation

Properties

onDidChangeCodeLenses

abstract var onDidChangeCodeLenses: Event<Void?>?

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

resolveCodeLens

abstract var resolveCodeLens: (codeLens: T, token: CancellationToken) -> ProviderResult<T>?

This function will be called for each visible code lens, usually when scrolling and after calls to compute-lenses.

Functions

provideCodeLenses

abstract fun provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<ReadonlyArray<T>>

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.