QuickInputExt | Theia TypeDoc

Hierarchy

QuickInputExt
- InputBoxExt
- QuickPickExt

Implements

QuickInput

Constructors

constructor

new QuickInputExt(quickOpen: QuickOpenExtImpl, quickOpenMain: QuickOpenMain, plugin: Plugin, _onDidDispose: (() => void)): QuickInputExt

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:312
Parameters
- quickOpen: QuickOpenExtImpl
- quickOpenMain: QuickOpenMain
- plugin: Plugin
- _onDidDispose: (() => void)
  - - (): void
    - Returns void
Returns QuickInputExt

Properties

Private _busy

_busy: boolean

Private _buttons

_buttons: QuickInputButton[] = []

Private _disposed

_disposed: boolean = false

Private _enabled

_enabled: boolean

Private _handlesToButtons

_handlesToButtons: Map<number, QuickInputButton> = ...

_id

_id: number = ...

Private _ignoreFocusOut

_ignoreFocusOut: boolean

Private _onDidChangeValueEmitter

_onDidChangeValueEmitter: Emitter<string>

it has to be named _onDidChangeValueEmitter, since Gitlens extension relies on it https://github.com/eamodio/vscode-gitlens/blob/f22a9cd4199ac498c217643282a6a412e1fc01ae/src/commands/gitCommands.ts#L242-L243

Private _pendingUpdate

_pendingUpdate: TransferQuickInput = ...

Private _placeholder

_placeholder: undefined | string

Private _step

_step: undefined | number

Private _title

_title: undefined | string

Private _totalSteps

_totalSteps: undefined | number

Private _updateTimeout

_updateTimeout: any

Private _value

_value: string

Protected disposableCollection

disposableCollection: DisposableCollection

Protected expectingHide

expectingHide: boolean = false

Private onDidAcceptEmitter

onDidAcceptEmitter: Emitter<void>

Private onDidHideEmitter

onDidHideEmitter: Emitter<void>

Private onDidTriggerButtonEmitter

onDidTriggerButtonEmitter: Emitter<QuickInputButton>

Readonly plugin

plugin: Plugin

Readonly quickOpen

quickOpen: QuickOpenExtImpl

Readonly quickOpenMain

quickOpenMain: QuickOpenMain

Protected visible

visible: boolean

Static Private _nextId

_nextId: number = 1

Accessors

busy

get busy(): boolean
set busy(busy: boolean): void

Implementation of theia.QuickInput.busy
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:366
Returns boolean
Implementation of theia.QuickInput.busy
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:370
Parameters
- busy: boolean
Returns void

buttons

get buttons(): QuickInputButton[]
set buttons(buttons: QuickInputButton[]): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:402
Returns QuickInputButton[]
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:406
Parameters
- buttons: QuickInputButton[]
Returns void

enabled

get enabled(): boolean
set enabled(enabled: boolean): void

Implementation of theia.QuickInput.enabled
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:357
Returns boolean
Implementation of theia.QuickInput.enabled
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:361
Parameters
- enabled: boolean
Returns void

ignoreFocusOut

get ignoreFocusOut(): boolean
set ignoreFocusOut(ignoreFocusOut: boolean): void

Implementation of theia.QuickInput.ignoreFocusOut
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:375
Returns boolean
Implementation of theia.QuickInput.ignoreFocusOut
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:379
Parameters
- ignoreFocusOut: boolean
Returns void

onDidAccept

get onDidAccept(): Event<void>

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:525
Returns Event<void>

onDidChangeValue

get onDidChangeValue(): Event<string>

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:529
Returns Event<string>

onDidHide

get onDidHide(): Event<void>

Implementation of theia.QuickInput.onDidHide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:521
Returns Event<void>

onDidTriggerButton

get onDidTriggerButton(): Event<QuickInputButton>

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:533
Returns Event<QuickInputButton>

placeholder

get placeholder(): undefined | string
set placeholder(placeholder: undefined | string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:393
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:397
Parameters
- placeholder: undefined | string
Returns void

step

get step(): undefined | number
set step(step: undefined | number): void

Implementation of theia.QuickInput.step
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:339
Returns undefined | number
Implementation of theia.QuickInput.step
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:343
Parameters
- step: undefined | number
Returns void

title

get title(): undefined | string
set title(title: undefined | string): void

Implementation of theia.QuickInput.title
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:330
Returns undefined | string
Implementation of theia.QuickInput.title
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:334
Parameters
- title: undefined | string
Returns void

totalSteps

get totalSteps(): undefined | number
set totalSteps(totalSteps: undefined | number): void

Implementation of theia.QuickInput.totalSteps
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:348
Returns undefined | number
Implementation of theia.QuickInput.totalSteps
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:352
Parameters
- totalSteps: undefined | number
Returns void

value

get value(): string
set value(value: string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:384
Returns string
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:388
Parameters
- value: string
Returns void

Methods

_fireAccept

_fireAccept(): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:501
Returns void

_fireButtonTrigger

_fireButtonTrigger(btn: QuickInputButton): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:517
Parameters
- btn: QuickInputButton
Returns void

_fireChangedValue

_fireChangedValue(changedValue: string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:505
Parameters
- changedValue: string
Returns void

_fireHide

_fireHide(): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:510
Returns void

Protected convertURL

convertURL(iconPath: URI | { dark: string | URI; light: string | URI } | ThemeIcon): URI | ThemeIcon | { dark: string | URI; light: string | URI }

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:475
Parameters
- iconPath: URI | { dark: string | URI; light: string | URI } | ThemeIcon
Returns URI | ThemeIcon | { dark: string | URI; light: string | URI }

Private dispatchUpdate

dispatchUpdate(): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:465
Returns void

dispose

dispose(): void

Implementation of theia.QuickInput.dispose
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:429
Returns void

hide

hide(): void

Implementation of theia.QuickInput.hide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:470
Returns void

show

show(): void

Implementation of theia.QuickInput.show
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:423
Returns void

Protected update

update(properties: Record<string, any>): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:441
Parameters
- properties: Record<string, any>
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

quickOpen: QuickOpenExtImpl

quickOpenMain: QuickOpenMain

plugin: Plugin

_onDidDispose: (() => void)

Returns void

Returns QuickInputExt

Properties

Private _busy

Private _buttons

Private _disposed

Private _enabled

Private _handlesToButtons

_id

Private _ignoreFocusOut

Private _onDidChangeValueEmitter

Private _pendingUpdate

Private _placeholder

Private _step

Private _title

Private _totalSteps

Private _updateTimeout

Private _value

Protected disposableCollection

Protected expectingHide

Private onDidAcceptEmitter

Private onDidHideEmitter

Private onDidTriggerButtonEmitter

Readonly plugin

Readonly quickOpen

Readonly quickOpenMain

Protected visible

Static Private _nextId

Accessors

busy

Returns boolean

Parameters

busy: boolean

Returns void

buttons

Returns QuickInputButton[]

Parameters

buttons: QuickInputButton[]

Returns void

enabled

Returns boolean

Parameters

enabled: boolean

Returns void

ignoreFocusOut

Returns boolean

Parameters

ignoreFocusOut: boolean

Returns void

onDidAccept

Returns Event<void>

onDidChangeValue

Returns Event<string>

onDidHide

Returns Event<void>

onDidTriggerButton

Returns Event<QuickInputButton>

placeholder

Returns undefined | string

Parameters

placeholder: undefined | string

Returns void

step

Returns undefined | number

Parameters

step: undefined | number