Class PreferencesContribution

Hierarchy

AbstractViewContribution<PreferencesWidget>
- PreferencesContribution

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PreferencesContribution(): PreferencesContribution

Overrides AbstractViewContribution<PreferencesWidget>.constructor
- Defined in packages/preferences/src/browser/preferences-contribution.ts:58
Returns PreferencesContribution

Properties

Protected Readonly clipboardService

clipboardService: ClipboardService

Protected Readonly editorManager

editorManager: EditorManager

Protected Readonly fileService

fileService: FileService

Protected Readonly preferenceService

preferenceService: PreferenceService

Protected Readonly quickInputService

quickInputService: QuickInputService

Protected Readonly schema

schema: PreferenceSchemaProvider

Protected Readonly scopeTracker

scopeTracker: PreferencesWidget

Protected Readonly workspacePreferenceProvider

workspacePreferenceProvider: WorkspacePreferenceProvider

Protected Readonly workspaceService

workspaceService: WorkspaceService

Methods

Private obtainConfigUri

obtainConfigUri(serializedScope: number, activeScopeIsFolder: boolean, resource?: string): Promise<undefined | URI>

- Defined in packages/preferences/src/browser/preferences-contribution.ts:238
Parameters
- serializedScope: number
- activeScopeIsFolder: boolean
- Optional resource: string
Returns Promise<undefined | URI>

Protected openFolderPreferences

openFolderPreferences(callback: ((root: FileStat) => unknown)): Promise<void>

- Defined in packages/preferences/src/browser/preferences-contribution.ts:224
Prompts which workspace root folder to open the JSON settings.

Parameters
- callback: ((root: FileStat) => unknown)
  - - (root: FileStat): unknown
    - Parameters
      - root: FileStat
      Returns unknown
Returns Promise<void>

Protected openJson

openJson(scope: PreferenceScope, resource?: string): Promise<void>

- Defined in packages/preferences/src/browser/preferences-contribution.ts:214
Parameters
- scope: PreferenceScope
- Optional resource: string
Returns Promise<void>

Protected openPreferencesJSON

openPreferencesJSON(opener: string | PreferencesWidget): Promise<void>

- Defined in packages/preferences/src/browser/preferences-contribution.ts:187
Parameters
- opener: string | PreferencesWidget
Returns Promise<void>

registerCommands

registerCommands(commands: CommandRegistry): void

Overrides AbstractViewContribution.registerCommands
- Defined in packages/preferences/src/browser/preferences-contribution.ts:68
Parameters
- commands: CommandRegistry
Returns void

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void

Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/preferences/src/browser/preferences-contribution.ts:171
Parameters
- keybindings: KeybindingRegistry
Returns void

registerMenus

registerMenus(menus: MenuModelRegistry): void

Overrides AbstractViewContribution.registerMenus
- Defined in packages/preferences/src/browser/preferences-contribution.ts:143
Parameters
- menus: MenuModelRegistry
Returns void

registerToolbarItems

registerToolbarItems(toolbar: TabBarToolbarRegistry): void

- Defined in packages/preferences/src/browser/preferences-contribution.ts:178
Parameters
- toolbar: TabBarToolbarRegistry
Returns void

Protected withWidget

withWidget<T>(widget?: undefined | Widget, fn: ((widget: PreferencesWidget) => T)): false | T

- Defined in packages/preferences/src/browser/preferences-contribution.ts:257
Determine if the current widget is the PreferencesWidget.

Type Parameters
- T
Parameters
- widget: undefined | Widget = ...
- fn: ((widget: PreferencesWidget) => T)
  - - (widget: PreferencesWidget): T
    - Parameters
      - widget: PreferencesWidget
      Returns T
Returns false | T