Theia API Documentation v1.77.0
    Preparing search index...

    Base implementation of QuickPick that uses QuickOpenExt. Missing functionality is going to be implemented in the scope of https://github.com/eclipse-theia/theia/issues/5059

    Type Parameters

    Hierarchy (View Summary)

    Implements

    Index
    _id: number = ...
    disposableCollection: DisposableCollection
    expectingHide: boolean = false
    onDidChangeActive: Event<T[]> = ...

    An event signaling when the active items have changed.

    onDidChangeSelection: Event<T[]> = ...

    An event signaling when the selected items have changed.

    onDidTriggerItemButton: Event<QuickPickItemButtonEvent<T>> = ...

    An event signaling when a button in a particular QuickPickItem was triggered.

    This event does not fire for buttons in the title bar which are part of buttons.

    plugin: Plugin
    quickOpen: QuickOpenExtImpl
    quickOpenMain: QuickOpenMain
    visible: boolean
    • get busy(): boolean

      Determines if the UI should show a progress indicator. Defaults to false.

      Change this to true, for example, while loading more data or validating user input.

      Returns boolean

    • set busy(busy: boolean): void

      Determines if the UI should show a progress indicator. Defaults to false.

      Change this to true, for example, while loading more data or validating user input.

      Parameters

      • busy: boolean

      Returns void

    • get enabled(): boolean

      Determines if the UI should allow for user input. Defaults to true.

      Change this to false, for example, while validating user input or loading data for the next step in user input.

      Returns boolean

    • set enabled(enabled: boolean): void

      Determines if the UI should allow for user input. Defaults to true.

      Change this to false, for example, while validating user input or loading data for the next step in user input.

      Parameters

      • enabled: boolean

      Returns void

    • get ignoreFocusOut(): boolean

      Determines if the UI should stay open even when losing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

      Returns boolean

    • set ignoreFocusOut(ignoreFocusOut: boolean): void

      Determines if the UI should stay open even when losing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

      Parameters

      • ignoreFocusOut: boolean

      Returns void

    • get onDidHide(): Event<void>

      An event signaling when this input UI is hidden.

      There are several reasons why this UI might have to be hidden and the extension will be notified through onDidHide. Examples include: an explicit call to hide, the user pressing Esc, some other input UI opening, etc.

      Returns Event<void>

    • get prompt(): string | undefined

      Optional text that provides instructions or context to the user.

      The prompt is displayed below the input box and above the list of items.

      Returns string | undefined

    • set prompt(prompt: string | undefined): void

      Optional text that provides instructions or context to the user.

      The prompt is displayed below the input box and above the list of items.

      Parameters

      • prompt: string | undefined

      Returns void

    • Dispose of this input UI and any associated resources.

      If it is still visible, it is first hidden. After this call the input UI is no longer functional and no additional methods or properties on it should be accessed. Instead a new input UI should be created.

      Returns void