Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileDecorationProvider

The decoration provider interfaces defines the contract between extensions and file decorations.

层级

  • FileDecorationProvider

索引

Properties(1)

Methods(1)

Properties(1)

Optional onDidChangeFileDecorations

onDidChangeFileDecorations: Event<undefined | Uri | Uri[]>

An optional event to signal that decorations for one or many files have changed.

Note that this event should be used to propagate information about children.

see

EventEmitter

Methods(1)

provideFileDecoration

  • Provide decorations for a given uri.

    Note that this function is only called when a file gets rendered in the UI. This means a decoration from a descendent that propagates upwards must be signaled to the editor via the onDidChangeFileDecorations-event.

    Parameters

    • uri: Uri

      The uri of the file to provide a decoration for.

    • token: CancellationToken

      A cancellation token.

    Returns ProviderResult<FileDecoration>

    A decoration or a thenable that resolves to such.

友链:VS Code 中文文档 | VS Code 官网文档 | VS Code 扩展市场

Generated by TypeDoc. Maintained by 洛竹