Class QuickOpenExtImpl

Implements

QuickOpenExt

Index

Constructors

Methods

$acceptDidChangeValue $acceptOnDidAccept $acceptOnDidHide $acceptOnDidTriggerButton $onDidChangeActive $onDidChangeSelection $onDidTriggerItemButton $onItemSelected $validateInput createInputBox createQuickPick hide showInput showInputBox showQuickPick

Constructors

constructor

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

Methods

$acceptDidChangeValue

$acceptDidChangeValue(sessionId: number, changedValue: string): 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: number): 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: number): 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: number,
btn: QuickInputButtonHandle,
): 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: number, handles: number[]): 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: number, handles: number[]): 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: number,
    itemHandle: number,
    buttonHandle: number,
): 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: number): void
Parameters
- handle: number
Returns void
Implementation of QuickOpenExt.$onItemSelected
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:121

$validateInput

$validateInput(
    input: string,
): 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: 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 extends QuickPickItem>(plugin: Plugin): QuickPick<T>
---- QuickInput
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?: InputBoxOptions,
token?: CancellationToken,
): PromiseLike<undefined | string>
---- input
Parameters
- Optionaloptions: 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: TransferInputBox): Promise<undefined | string>
Parameters
- options: TransferInputBox
Returns Promise<undefined | string>
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:135

showQuickPick

showQuickPick(
    plugin: Plugin,
    itemsOrItemsPromise: QuickPickItem[] | Promise<QuickPickItem[]>,
    options: QuickPickOptions & { canPickMany: true },
    token?: CancellationToken,
): Promise<undefined | QuickPickItem[]>
eslint-disable max-len
Parameters
- plugin: Plugin
- itemsOrItemsPromise: QuickPickItem[] | Promise<QuickPickItem[]>
- options: QuickPickOptions & { canPickMany: true }
- Optionaltoken: CancellationToken
Returns Promise<undefined | QuickPickItem[]>
Implementation of QuickOpenExt.showQuickPick
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:59
showQuickPick(
    plugin: Plugin,
    itemsOrItemsPromise: string[] | Promise<string[]>,
    options?: QuickPickOptions,
    token?: CancellationToken,
): Promise<undefined | string>
eslint-disable max-len
Parameters
- plugin: Plugin
- itemsOrItemsPromise: string[] | Promise<string[]>
- Optionaloptions: QuickPickOptions
- Optionaltoken: CancellationToken
Returns Promise<undefined | string>
Implementation of QuickOpenExt.showQuickPick
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:60
showQuickPick(
    plugin: Plugin,
    itemsOrItemsPromise: QuickPickItem[] | Promise<QuickPickItem[]>,
    options?: QuickPickOptions,
    token?: CancellationToken,
): Promise<undefined | QuickPickItem>
eslint-disable max-len
Parameters
- plugin: Plugin
- itemsOrItemsPromise: QuickPickItem[] | Promise<QuickPickItem[]>
- Optionaloptions: QuickPickOptions
- Optionaltoken: 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

Methods

Constructors

constructor

Parameters

Returns QuickOpenExtImpl

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

On This Page