Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TerminalWidgetImpl

Hierarchy

Implements

  • StatefulWidget
  • ExtractableWidget

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _terminalId

_terminalId: number = -1

Protected closeOnDispose

closeOnDispose: boolean = true

Protected Readonly contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

Protected Readonly copyOnSelectionHandler

copyOnSelectionHandler: TerminalCopyOnSelectionHandler

Protected Readonly deviceStatusCodes

deviceStatusCodes: Set<string> = ...

exitStatus

exitStatus: undefined | TerminalExitStatus

Protected fitAddon

fitAddon: FitAddon

Readonly id

id: string

Protected initialData

initialData: string = ''

Protected isAttachedCloseListener

isAttachedCloseListener: boolean = false

Readonly isExtractable

isExtractable: boolean = true

lastCwd

lastCwd: URI = ...

The last CWD assigned to the terminal, useful when attempting getCwdURI on a task terminal fails

Protected lastMousePosition

lastMousePosition: undefined | { x: number; y: number }

Protected lastTouchEnd

lastTouchEnd: undefined | TouchEvent

Protected linkHover

linkHover: HTMLDivElement

Protected linkHoverButton

linkHoverButton: HTMLAnchorElement

location

location: TerminalLocationOptions

The position of the terminal widget.

Protected Readonly logger

logger: ILogger

Protected needsResize

needsResize: boolean = true

Readonly onData

onData: Event<string> = ...

Event that fires when the terminal input data

Protected Readonly onDataEmitter

onDataEmitter: Emitter<string> = ...

Readonly onDidOpen

onDidOpen: Event<void> = ...

Event that fires when the terminal is connected or reconnected

Protected Readonly onDidOpenEmitter

onDidOpenEmitter: Emitter<void> = ...

Readonly onDidOpenFailure

onDidOpenFailure: Event<void> = ...

Event that fires when the terminal fails to connect or reconnect

Protected Readonly onDidOpenFailureEmitter

onDidOpenFailureEmitter: Emitter<void> = ...

Readonly onKey

onKey: Event<{ domEvent: KeyboardEvent; key: string }> = ...

Event that fires when the terminal receives a key event.

Protected Readonly onKeyEmitter

onKeyEmitter: Emitter<{ domEvent: KeyboardEvent; key: string }> = ...

Readonly onMouseEnterLinkHover

onMouseEnterLinkHover: Event<MouseEvent> = ...

Protected Readonly onMouseEnterLinkHoverEmitter

onMouseEnterLinkHoverEmitter: Emitter<MouseEvent> = ...

Readonly onMouseLeaveLinkHover

onMouseLeaveLinkHover: Event<MouseEvent> = ...

Protected Readonly onMouseLeaveLinkHoverEmitter

onMouseLeaveLinkHoverEmitter: Emitter<MouseEvent> = ...

Readonly onSizeChanged

onSizeChanged: Event<{ cols: number; rows: number }> = ...

Event that fires when the terminal size changed

Protected Readonly onSizeChangedEmitter

onSizeChangedEmitter: Emitter<{ cols: number; rows: number }> = ...

Protected Readonly onTermDidClose

onTermDidClose: Emitter<TerminalWidget> = ...

options

options: TerminalWidgetOptions

Protected Readonly preferences

preferences: TerminalPreferences

Protected resizeTerminal

resizeTerminal: ((...arguments: []) => Promise<void>) = ...

Type declaration

    • (...arguments: []): Promise<void>

    • Debounce promise-returning & async functions.

      example
      import pDebounce = require('p-debounce');

      const expensiveCall = async input => input;

      const debouncedFn = pDebounce(expensiveCall, 200);

      for (const i of [1, 2, 3]) {
      debouncedFn(i).then(console.log);
      }
      //=> 3
      //=> 3
      //=> 3

      Parameters

      • Rest ...arguments: []

      Returns Promise<void>

      A function that delays calling fn until after wait milliseconds have elapsed since the last time it was called.

Protected restored

restored: boolean = false

Protected searchBox

searchBox: TerminalSearchWidget

secondaryWindow

secondaryWindow: undefined | Window

Protected Readonly shellCommandBuilder

shellCommandBuilder: ShellCommandBuilder

Protected Readonly shellTerminalServer

shellTerminalServer: ShellTerminalServerProxy

Protected shown

shown: boolean = false

Protected term

term: Terminal

Protected termOpened

termOpened: boolean = false

Protected Readonly terminalContributionProvider

terminalContributionProvider: ContributionProvider<TerminalContribution>

Protected terminalKind

terminalKind: string = 'user'

Protected Readonly terminalSearchBoxFactory

terminalSearchBoxFactory: TerminalSearchWidgetFactory

Protected Readonly terminalService

terminalService: TerminalService

Protected Readonly terminalWatcher

terminalWatcher: TerminalWatcher

Protected Readonly themeService

themeService: TerminalThemeService

Protected Readonly toDisposeOnConnect

toDisposeOnConnect: DisposableCollection = ...

Protected waitForConnection

waitForConnection: undefined | Deferred<Channel>

Protected Readonly webSocketConnectionProvider

webSocketConnectionProvider: WebSocketConnectionProvider

Protected Readonly workspaceService

workspaceService: WorkspaceService

Static LABEL

LABEL: string = ...

Accessors

Protected copyOnSelection

  • get copyOnSelection(): boolean

cwd

  • get cwd(): Promise<URI>

dimensions

Protected enableCopy

  • get enableCopy(): boolean

Protected enablePaste

  • get enablePaste(): boolean

hiddenFromUser

  • get hiddenFromUser(): boolean

kind

  • get kind(): string

lastTouchEndEvent

  • get lastTouchEndEvent(): undefined | TouchEvent

onTerminalDidClose

processId

  • get processId(): Promise<number>

processInfo

Protected shellPreferences

terminalId

  • get terminalId(): number

transient

  • get transient(): boolean

Methods

Protected attachCustomKeyEventHandler

  • attachCustomKeyEventHandler(): void

Private attachPressEnterKeyToCloseListener

  • attachPressEnterKeyToCloseListener(term: Terminal): void

Protected attachTerminal

  • attachTerminal(id: number): Promise<number>

clearOutput

  • clearOutput(): void

Protected connectTerminalProcess

  • connectTerminalProcess(): void

Protected createTerminal

  • createTerminal(): Promise<number>

Protected customKeyHandler

  • customKeyHandler(event: KeyboardEvent): boolean

Private disableEnterWhenAttachCloseListener

  • disableEnterWhenAttachCloseListener(): boolean

dispose

  • dispose(): void

Protected doResizeTerminal

  • doResizeTerminal(): void

executeCommand

  • executeCommand(commandOptions: CommandLineOptions): Promise<void>

  • Resolves when the command is successfully sent, this doesn't mean that it was evaluated. Might reject if terminal wasn't properly started yet.

    Note that this method will try to escape your arguments as if it was someone inputting everything in a shell.

    Supported shells: bash, cmd.exe, wsl.exe, pwsh/powershell.exe

    Parameters

    • commandOptions: CommandLineOptions

    Returns Promise<void>

Private getCursorStyle

getSearchBox

getTerminal

  • getTerminal(): Terminal

Private getTerminalRendererType

  • getTerminalRendererType(terminalRendererType?: string): RendererType

hasChildProcesses

  • hasChildProcesses(): Promise<boolean>

hideLinkHover

  • hideLinkHover(): void

Protected init

  • init(): void

Protected initializeLinkHover

  • initializeLinkHover(): void

Protected linkHoverMessage

  • linkHoverMessage(message?: string): string

Protected onActivateRequest

  • onActivateRequest(msg: Message): void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterShow

  • onAfterShow(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

onDispose

  • onDispose(onDispose: (() => void)): void

Protected onFitRequest

  • onFitRequest(msg: Message): void

Protected onResize

  • onResize(msg: ResizeMessage): void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

Protected open

  • open(): void

processMessage

  • processMessage(msg: Message): void

Protected reconnectTerminalProcess

  • reconnectTerminalProcess(): Promise<void>

resetTerminal

  • resetTerminal(): void

resize

  • resize(cols: number, rows: number): void

Protected resizeTerminalProcess

  • resizeTerminalProcess(): void

restoreState

  • restoreState(oldState: object): void

scrollLineDown

  • scrollLineDown(): void

scrollLineUp

  • scrollLineUp(): void

scrollPageDown

  • scrollPageDown(): void

scrollPageUp

  • scrollPageUp(): void

scrollToBottom

  • scrollToBottom(): void

scrollToTop

  • scrollToTop(): void

selectAll

  • selectAll(): void

sendText

  • sendText(text: string): void

setTitle

  • setTitle(title: string): void

showLinkHover

  • showLinkHover(invokeAction: ((event: MouseEvent) => void), x: number, y: number, message?: string): void

start

  • start(id?: number): Promise<number>

storeState

  • storeState(): object

waitOnExit

  • waitOnExit(waitOnExit?: string | boolean): void

write

  • write(data: string): void

writeLine

  • writeLine(text: string): void