Class GotoSymbolQuickAccess

Hierarchy

StandaloneGotoSymbolQuickAccessProvider
- GotoSymbolQuickAccess

Constructors

constructor

new GotoSymbolQuickAccess(...services: any[]): GotoSymbolQuickAccess
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- ...services: any[]
Returns GotoSymbolQuickAccess
Overrides StandaloneGotoSymbolQuickAccessProvider.constructor
- Defined in packages/monaco/src/browser/monaco-gotosymbol-quick-access.ts:29

Properties

`Protected` `Readonly`codeEditorService

codeEditorService: ICodeEditorService

`Protected` `Readonly`languageFeatures

languageFeatures: ILanguageFeaturesService

`Protected` `Readonly`onDidActiveTextEditorControlChange

onDidActiveTextEditorControlChange: Event<any>

Subclasses to provide an event when the active editor control changes.

`Protected` `Readonly`options

options: IGotoSymbolQuickAccessProviderOptions

`Protected` `Readonly`outlineService

outlineService: IOutlineModelService

`Static`PREFIX

PREFIX: string

`Static`PREFIX_BY_CATEGORY

PREFIX_BY_CATEGORY: string

`Static`SCOPE_PREFIX

SCOPE_PREFIX: string

Accessors

activeTextEditorControl

get activeTextEditorControl(): undefined | ICodeEditor
Returns undefined | ICodeEditor
Overrides StandaloneGotoSymbolQuickAccessProvider.activeTextEditorControl
- Defined in packages/monaco/src/browser/monaco-gotosymbol-quick-access.ts:38

Methods

addDecorations

addDecorations(editor: IEditor, range: IRange): void
Parameters
- editor: IEditor
- range: IRange
Returns void
Inherited from StandaloneGotoSymbolQuickAccessProvider.addDecorations
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/editorNavigationQuickAccess.d.ts:67

`Protected`canProvideWithTextEditor

canProvideWithTextEditor(editor: IEditor): boolean
Subclasses to implement if they can operate on the text editor.
Parameters
- editor: IEditor
Returns boolean
Inherited from StandaloneGotoSymbolQuickAccessProvider.canProvideWithTextEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/editorNavigationQuickAccess.d.ts:38

clearDecorations

clearDecorations(editor: IEditor): void
Parameters
- editor: IEditor
Returns void
Inherited from StandaloneGotoSymbolQuickAccessProvider.clearDecorations
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/editorNavigationQuickAccess.d.ts:68

`Protected`doGetSymbolPicks

doGetSymbolPicks(
    symbolsPromise: Promise<DocumentSymbol[]>,
    query: IPreparedQuery,
    options: undefined | { extraContainerLabel?: string },
    token: CancellationToken,
    model: ITextModel,
): Promise<(IGotoSymbolQuickPickItem | IQuickPickSeparator)[]>
Parameters
- symbolsPromise: Promise<DocumentSymbol[]>
- query: IPreparedQuery
- options: undefined | { extraContainerLabel?: string }
- token: CancellationToken
- model: ITextModel
Returns Promise<(IGotoSymbolQuickPickItem | IQuickPickSeparator)[]>
Inherited from StandaloneGotoSymbolQuickAccessProvider.doGetSymbolPicks
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/gotoSymbolQuickAccess.d.ts:51

`Protected`getDocumentSymbols

getDocumentSymbols(
document: ITextModel,
token: CancellationToken,
): Promise<DocumentSymbol[]>
Parameters
- document: ITextModel
- token: CancellationToken
Returns Promise<DocumentSymbol[]>
Inherited from StandaloneGotoSymbolQuickAccessProvider.getDocumentSymbols
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/gotoSymbolQuickAccess.d.ts:56

`Protected`getModel

getModel(editor: IEditor | IDiffEditor): undefined | ITextModel
Parameters
- editor: IEditor | IDiffEditor
Returns undefined | ITextModel
Inherited from StandaloneGotoSymbolQuickAccessProvider.getModel
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/editorNavigationQuickAccess.d.ts:57

`Protected`gotoLocation

gotoLocation(
    __namedParameters: IQuickAccessTextEditorContext,
    options: {
        forceSideBySide?: boolean;
        keyMods: IKeyMods;
        preserveFocus?: boolean;
        range: IRange;
    },
): void
Parameters
- __namedParameters: IQuickAccessTextEditorContext
- options: {
      forceSideBySide?: boolean;
      keyMods: IKeyMods;
      preserveFocus?: boolean;
      range: IRange;
  }
Returns void
Inherited from StandaloneGotoSymbolQuickAccessProvider.gotoLocation
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/editorNavigationQuickAccess.d.ts:51

provide

provide(
    picker: IQuickPick<IQuickPickItem, { useSeparators: true }>,
    token: CancellationToken,
    runOptions?: IQuickAccessProviderRunOptions,
): IDisposable
Called whenever a prefix was typed into quick pick that matches the provider.
Parameters
- picker: IQuickPick<IQuickPickItem, { useSeparators: true }>
  the picker to use for showing provider results. The picker is automatically shown after the method returns, no need to call show().
- token: CancellationToken
  providers have to check the cancellation token everytime after a long running operation or from event handlers because it could be that the picker has been closed or changed meanwhile. The token can be used to find out that the picker was closed without picking an entry (e.g. was canceled by the user).
- OptionalrunOptions: IQuickAccessProviderRunOptions
Returns IDisposable
a disposable that will automatically be disposed when the picker closes or is replaced by another picker.
Inherited from StandaloneGotoSymbolQuickAccessProvider.provide
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/editorNavigationQuickAccess.d.ts:31

`Protected`provideWithoutTextEditor

provideWithoutTextEditor(
picker: IQuickPick<IGotoSymbolQuickPickItem, { useSeparators: true }>,
): IDisposable
Subclasses to implement to provide picks for the picker when no editor is active.
Parameters
- picker: IQuickPick<IGotoSymbolQuickPickItem, { useSeparators: true }>
Returns IDisposable
Inherited from StandaloneGotoSymbolQuickAccessProvider.provideWithoutTextEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/gotoSymbolQuickAccess.d.ts:41

`Protected`provideWithTextEditor

provideWithTextEditor(
    context: IQuickAccessTextEditorContext,
    picker: IQuickPick<IGotoSymbolQuickPickItem, { useSeparators: true }>,
    token: CancellationToken,
    runOptions?: IQuickAccessProviderRunOptions,
): IDisposable
Subclasses to implement to provide picks for the picker when an editor is active.
Parameters
- context: IQuickAccessTextEditorContext
- picker: IQuickPick<IGotoSymbolQuickPickItem, { useSeparators: true }>
- token: CancellationToken
- OptionalrunOptions: IQuickAccessProviderRunOptions
Returns IDisposable
Inherited from StandaloneGotoSymbolQuickAccessProvider.provideWithTextEditor
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/gotoSymbolQuickAccess.d.ts:44

`Protected`waitForLanguageSymbolRegistry

waitForLanguageSymbolRegistry(
model: ITextModel,
disposables: DisposableStore,
): Promise<boolean>
Parameters
- model: ITextModel
- disposables: DisposableStore
Returns Promise<boolean>
Inherited from StandaloneGotoSymbolQuickAccessProvider.waitForLanguageSymbolRegistry
- Defined in node_modules/@theia/monaco-editor-core/esm/vs/editor/contrib/quickAccess/browser/gotoSymbolQuickAccess.d.ts:49

Class GotoSymbolQuickAccess

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GotoSymbolQuickAccess

Properties

Protected ReadonlycodeEditorService

Protected ReadonlylanguageFeatures

Protected ReadonlyonDidActiveTextEditorControlChange

Protected Readonlyoptions

Protected ReadonlyoutlineService

StaticPREFIX

StaticPREFIX_BY_CATEGORY

StaticSCOPE_PREFIX

Accessors

activeTextEditorControl

Returns undefined | ICodeEditor

Methods

addDecorations

Parameters

Returns void

ProtectedcanProvideWithTextEditor

Parameters

Returns boolean

clearDecorations

Parameters

Returns void

ProtecteddoGetSymbolPicks

Parameters

Returns Promise<(IGotoSymbolQuickPickItem | IQuickPickSeparator)[]>

ProtectedgetDocumentSymbols

Parameters

Returns Promise<DocumentSymbol[]>

ProtectedgetModel

Parameters

Returns undefined | ITextModel

ProtectedgotoLocation

Parameters

Returns void

provide

Parameters

Returns IDisposable

ProtectedprovideWithoutTextEditor

Parameters

Returns IDisposable

ProtectedprovideWithTextEditor

Parameters

Returns IDisposable

ProtectedwaitForLanguageSymbolRegistry

Parameters

Returns Promise<boolean>

Settings

On This Page

`Protected` `Readonly`codeEditorService

`Protected` `Readonly`languageFeatures

`Protected` `Readonly`onDidActiveTextEditorControlChange

`Protected` `Readonly`options

`Protected` `Readonly`outlineService

`Static`PREFIX

`Static`PREFIX_BY_CATEGORY

`Static`SCOPE_PREFIX

`Protected`canProvideWithTextEditor

`Protected`doGetSymbolPicks

`Protected`getDocumentSymbols

`Protected`getModel

`Protected`gotoLocation

`Protected`provideWithoutTextEditor

`Protected`provideWithTextEditor

`Protected`waitForLanguageSymbolRegistry