Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides high level terminal plugin api to use in the Theia plugins. This service allow(with help proxy) create and use terminal emulator.

Hierarchy

  • TerminalServiceExtImpl

Implements

Index

Constructors

Properties

_pseudoTerminals: Map<string, PseudoTerminal> = ...
_terminals: Map<string, TerminalExtImpl> = ...
activeTerminalId: undefined | string
environmentVariableCollections: Map<string, EnvironmentVariableCollection> = ...
onDidChangeActiveTerminal: Event<undefined | Terminal> = ...
onDidChangeActiveTerminalEmitter: Emitter<undefined | Terminal> = ...
onDidChangeTerminalState: Event<Terminal> = ...
onDidChangeTerminalStateEmitter: Emitter<Terminal> = ...
onDidCloseTerminal: Event<Terminal> = ...
onDidCloseTerminalEmitter: Emitter<Terminal> = ...
onDidOpenTerminal: Event<Terminal> = ...
onDidOpenTerminalEmitter: Emitter<Terminal> = ...
terminalLinkProviders: Map<string, TerminalLinkProvider<TerminalLink>> = ...
terminalProfileProviders: Map<string, TerminalProfileProvider> = ...
nextProviderId: number = 0

Accessors

Methods

  • $currentTerminalChanged(id: undefined | string): void
  • $initEnvironmentVariableCollections(collections: [string, SerializableEnvironmentVariableCollection][]): void
  • $provideTerminalLinks(line: string, terminalId: string, token: CancellationToken): Promise<ProvidedTerminalLink[]>
  • $startProfile(profileId: string, cancellationToken: CancellationToken): Promise<string>
  • $terminalClosed(id: string, exitStatus: undefined | TerminalExitStatus): void
  • $terminalCreated(id: string, name: string): void
  • $terminalNameChanged(id: string, name: string): void
  • $terminalOnInput(id: string, data: string): void
  • $terminalOpened(id: string, processId: number, terminalId: number, cols: number, rows: number): void
  • $terminalSizeChanged(id: string, clos: number, rows: number): void
  • $terminalStateChanged(id: string): void
  • attachPtyToTerminal(terminalId: number, pty: Pseudoterminal): void
  • createTerminal(nameOrOptions: undefined | string | TerminalOptions | ExtensionTerminalOptions | PseudoTerminalOptions, shellPath?: string, shellArgs?: string | string[]): Terminal
  • Parameters

    • nameOrOptions: undefined | string | TerminalOptions | ExtensionTerminalOptions | PseudoTerminalOptions
    • Optional shellPath: string
    • Optional shellArgs: string | string[]

    Returns Terminal

  • getEnvironmentVariableCollection(extensionIdentifier: string): EnvironmentVariableCollection
  • isExtensionTerminalOptions(options: TerminalOptions | ExtensionTerminalOptions): options is ExtensionTerminalOptions
  • obtainTerminal(id: string, name: string, options?: TerminalOptions | ExtensionTerminalOptions): TerminalExtImpl
  • registerTerminalLinkProvider(provider: TerminalLinkProvider<TerminalLink>): Disposable
  • registerTerminalProfileProvider(id: string, provider: TerminalProfileProvider): Disposable
  • registerTerminalQuickFixProvider(id: string, provider: TerminalQuickFixProvider): Disposable