Class QuickOpenExtImpl

Implements

QuickOpenExt

Constructors

constructor

new QuickOpenExtImpl(rpc): QuickOpenExtImpl
Parameters
- rpc: RPCProtocol
Returns QuickOpenExtImpl
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:54

Properties

`Private` _instances

_instances: number = 0

`Private` _sessions

_sessions: Map<number, QuickInputExt> = ...

`Private` onDidSelectItem

onDidSelectItem: undefined | ((handle) => void)

Type declaration

- (handle): void
- Parameters
  - handle: number
  Returns void

`Private` proxy

proxy: QuickOpenMain

`Private` `Optional` validateInputHandler

validateInputHandler?: ((input) => MaybePromise<undefined | null | string | InputBoxValidationMessage>)

Type declaration

- (input): MaybePromise<undefined | null | string | InputBoxValidationMessage>
- Parameters
  - input: string
  Returns MaybePromise<undefined | null | string | InputBoxValidationMessage>

Methods

$acceptDidChangeValue

$acceptDidChangeValue(sessionId, changedValue): Promise<void>
Parameters
- sessionId: number
- changedValue: string
Returns Promise<void>
Implementation of QuickOpenExt.$acceptDidChangeValue
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:197

$acceptOnDidAccept

$acceptOnDidAccept(sessionId): Promise<void>
Parameters
- sessionId: number
Returns Promise<void>
Implementation of QuickOpenExt.$acceptOnDidAccept
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:190

$acceptOnDidHide

$acceptOnDidHide(sessionId): Promise<void>
Parameters
- sessionId: number
Returns Promise<void>
Implementation of QuickOpenExt.$acceptOnDidHide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:204

$acceptOnDidTriggerButton

$acceptOnDidTriggerButton(sessionId, btn): Promise<void>
Parameters
- sessionId: number
- btn: QuickInputButtonHandle
Returns Promise<void>
Implementation of QuickOpenExt.$acceptOnDidTriggerButton
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:211

$onDidChangeActive

$onDidChangeActive(sessionId, handles): void
Parameters
- sessionId: number
- handles: number[]
Returns void
Implementation of QuickOpenExt.$onDidChangeActive
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:223

$onDidChangeSelection

$onDidChangeSelection(sessionId, handles): void
Parameters
- sessionId: number
- handles: number[]
Returns void
Implementation of QuickOpenExt.$onDidChangeSelection
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:230

$onDidTriggerItemButton

$onDidTriggerItemButton(sessionId, itemHandle, buttonHandle): void
Parameters
- sessionId: number
- itemHandle: number
- buttonHandle: number
Returns void
Implementation of QuickOpenExt.$onDidTriggerItemButton
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:237

$onItemSelected

$onItemSelected(handle): void
Parameters
- handle: number
Returns void
Implementation of QuickOpenExt.$onItemSelected
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:121

$validateInput

$validateInput(input): Promise<undefined | null | string | {
content: string;
severity: Severity;
}>
Parameters
- input: string
Returns Promise<undefined | null | string | {
content: string;
severity: Severity;
}>
Implementation of QuickOpenExt.$validateInput
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:140

createInputBox

createInputBox(plugin): InputBox
Parameters
- plugin: Plugin
Returns InputBox
Implementation of QuickOpenExt.createInputBox
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:180

createQuickPick

createQuickPick<T>(plugin): QuickPick<T>
Type Parameters
- T extends QuickPickItem
Parameters
- plugin: Plugin
Returns QuickPick<T>
Implementation of QuickOpenExt.createQuickPick
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:174

hide

hide(): void
Returns void
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:186

showInput

showInput(options?, token?): PromiseLike<undefined | string>
Parameters
- Optional options: InputBoxOptions
- token: CancellationToken = CancellationToken.None
Returns PromiseLike<undefined | string>
Implementation of QuickOpenExt.showInput
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:129

showInputBox

showInputBox(options): Promise<undefined | string>
Parameters
- options: TransferInputBox
Returns Promise<undefined | string>
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:135

showQuickPick

showQuickPick(plugin, itemsOrItemsPromise, options, token?): Promise<undefined | QuickPickItem[]>
Parameters
- plugin: Plugin
- itemsOrItemsPromise: QuickPickItem[] | Promise<QuickPickItem[]>
- options: QuickPickOptions & {
  canPickMany: true;
  }
- Optional token: CancellationToken
Returns Promise<undefined | QuickPickItem[]>
Implementation of QuickOpenExt.showQuickPick
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:59
showQuickPick(plugin, itemsOrItemsPromise, options?, token?): Promise<undefined | string>
Parameters
- plugin: Plugin
- itemsOrItemsPromise: string[] | Promise<string[]>
- Optional options: QuickPickOptions
- Optional token: CancellationToken
Returns Promise<undefined | string>
Implementation of QuickOpenExt.showQuickPick
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:60
showQuickPick(plugin, itemsOrItemsPromise, options?, token?): Promise<undefined | QuickPickItem>
Parameters
- plugin: Plugin
- itemsOrItemsPromise: QuickPickItem[] | Promise<QuickPickItem[]>
- Optional options: QuickPickOptions
- Optional token: CancellationToken
Returns Promise<undefined | QuickPickItem>
Implementation of QuickOpenExt.showQuickPick
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:61

Class QuickOpenExtImpl

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns QuickOpenExtImpl

Properties

Private _instances

Private _sessions

Private onDidSelectItem

Type declaration

Parameters

Returns void

Private proxy

Private Optional validateInputHandler

Type declaration

Parameters

Returns MaybePromise<undefined | null | string | InputBoxValidationMessage>

Methods

$acceptDidChangeValue

Parameters

Returns Promise<void>

$acceptOnDidAccept

Parameters

Returns Promise<void>

$acceptOnDidHide

Parameters

Returns Promise<void>

$acceptOnDidTriggerButton

Parameters

Returns Promise<void>

$onDidChangeActive

Parameters

Returns void

$onDidChangeSelection

Parameters

Returns void

$onDidTriggerItemButton

Parameters

Returns void

$onItemSelected

Parameters

Returns void

$validateInput

Parameters

Returns Promise<undefined | null | string | { content: string; severity: Severity; }>

createInputBox

Parameters

Returns InputBox

createQuickPick

Type Parameters

Parameters

Returns QuickPick<T>

hide

Returns void

showInput

Parameters

Returns PromiseLike<undefined | string>

showInputBox

Parameters

Returns Promise<undefined | string>

showQuickPick

Parameters

Returns Promise<undefined | QuickPickItem[]>

Parameters

Returns Promise<undefined | string>

Parameters

Returns Promise<undefined | QuickPickItem>

Settings

Member Visibility

Theme

On This Page

`Private` _instances

`Private` _sessions

`Private` onDidSelectItem

`Private` proxy

`Private` `Optional` validateInputHandler

Returns Promise<undefined | null | string | {
content: string;
severity: Severity;
}>