Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

  • StatefulWidget

Index

Constructors

  • Construct a new widget.

    Parameters

    • Optional options: IOptions

      The options for initializing the widget.

    Returns TerminalWidgetImpl

Properties

_terminalId: number = -1
closeOnDispose: boolean = true
copyOnSelectionHandler: TerminalCopyOnSelectionHandler
deviceStatusCodes: Set<string> = ...
exitStatus: undefined | TerminalExitStatus
fitAddon: FitAddon
hoverMessage: HTMLDivElement
id: string
initialData: string = ''
isAttachedCloseListener: boolean = false
lastCwd: URI = ...

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

lastTouchEnd: undefined | TouchEvent
logger: ILogger
needsResize: boolean = true
onData: Event<string> = ...

Event that fires when the terminal input data

onDataEmitter: Emitter<string> = ...
onDidOpen: Event<void> = ...

Event that fires when the terminal is connected or reconnected

onDidOpenEmitter: Emitter<void> = ...
onDidOpenFailure: Event<void> = ...

Event that fires when the terminal fails to connect or reconnect

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

Event that fires when the terminal receives a key event.

onKeyEmitter: Emitter<{ domEvent: KeyboardEvent; key: string }> = ...
onSizeChanged: Event<{ cols: number; rows: number }> = ...

Event that fires when the terminal size changed

onSizeChangedEmitter: Emitter<{ cols: number; rows: number }> = ...
onTermDidClose: Emitter<TerminalWidget> = ...
preferences: TerminalPreferences
restored: boolean = false
shellCommandBuilder: ShellCommandBuilder
shellTerminalServer: ShellTerminalServerProxy
term: Terminal
termOpened: boolean = false
terminalContributionProvider: ContributionProvider<TerminalContribution>
terminalKind: string = 'user'
terminalSearchBoxFactory: TerminalSearchWidgetFactory
terminalService: TerminalService
terminalWatcher: TerminalWatcher
themeService: TerminalThemeService
toDisposeOnConnect: DisposableCollection = ...
waitForConnection: undefined | Deferred<RpcProtocol>
webSocketConnectionProvider: WebSocketConnectionProvider
workspaceService: WorkspaceService
LABEL: string = ...

Accessors

  • get copyOnSelection(): boolean
  • get cwd(): Promise<URI>
  • get enableCopy(): boolean
  • get enablePaste(): boolean
  • get kind(): string
  • get lastTouchEndEvent(): undefined | TouchEvent
  • get processId(): Promise<number>
  • get terminalId(): number

Methods

  • attachCustomKeyEventHandler(): void
  • attachPressEnterKeyToCloseListener(term: Terminal): void
  • attachTerminal(id: number): Promise<number>
  • clearOutput(): void
  • connectTerminalProcess(): void
  • createTerminal(): Promise<number>
  • customKeyHandler(event: KeyboardEvent): boolean
  • disableEnterWhenAttachCloseListener(): boolean
  • dispose(): void
  • 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>

  • getTerminal(): Terminal
  • getTerminalRendererType(terminalRendererType?: string): RendererType
  • hasChildProcesses(): Promise<boolean>
  • hideHover(): void
  • init(): void
  • onActivateRequest(msg: Message): void
  • onAfterAttach(msg: Message): void
  • onAfterShow(msg: Message): void
  • onBeforeDetach(msg: Message): void
  • onDispose(onDispose: (() => void)): void
  • onFitRequest(msg: Message): void
  • onResize(msg: ResizeMessage): void
  • onUpdateRequest(msg: Message): void
  • open(): void
  • processMessage(msg: Message): void
  • reconnectTerminalProcess(): Promise<void>
  • resetTerminal(): void
  • resize(cols: number, rows: number): void
  • resizeTerminal(): void
  • resizeTerminalProcess(): void
  • restoreState(oldState: object): void
  • scrollLineDown(): void
  • scrollLineUp(): void
  • scrollPageDown(): void
  • scrollPageUp(): void
  • scrollToBottom(): void
  • scrollToTop(): void
  • sendText(text: string): void
  • setTitle(title: string): void
  • showHoverMessage(x: number, y: number, message: string): void
  • start(id?: number): Promise<number>
  • storeState(): object
  • waitOnExit(waitOnExit?: string | boolean): void
  • write(data: string): void
  • writeLine(text: string): void
  • getFollowLinkHover(): string