Class: PassthroughIDEBase
libs/common/ide/PassthroughIDEBase.PassthroughIDEBase
Hierarchy
PassthroughIDEBase↳
SpyIDE
Implements
Constructors
constructor
• new PassthroughIDEBase(original)
Parameters
| Name | Type |
|---|---|
original | IDE |
Defined in
libs/common/ide/PassthroughIDEBase.ts:27
Properties
capabilities
• capabilities: Capabilities
The capabilities of the IDE
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:24
clipboard
• clipboard: Clipboard
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:22
configuration
• configuration: Configuration
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:20
globalState
• globalState: State
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:21
hats
• hats: Hats
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:25
messages
• messages: Messages
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:23
Accessors
activeEditableTextEditor
• get activeEditableTextEditor(): undefined | EditableTextEditor
Same as activeTextEditor but editable
Returns
undefined | EditableTextEditor
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:115
activeTextEditor
• get activeTextEditor(): undefined | TextEditor
The currently active editor or undefined. The active editor is the one
that currently has focus or, when none has focus, the one that has changed
input most recently.
Returns
undefined | TextEditor
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:111
assetsRoot
• get assetsRoot(): string
The root directory of this shipped code. Can be used to access bundled assets.
Returns
string
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:123
runMode
• get runMode(): RunMode
Whether we are running in development, test, or production
Returns
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:127
visibleTextEditors
• get visibleTextEditors(): TextEditor[]
The currently visible editors or an empty array.
Returns
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:119
workspaceFolders
• get workspaceFolders(): undefined | readonly WorkspaceFolder[]
A list of workspace folders for the currently active workspace
Returns
undefined | readonly WorkspaceFolder[]
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:131
Methods
disposeOnExit
▸ disposeOnExit(...disposables): () => void
Register disposables to be disposed of on IDE exit.
Parameters
| Name | Type |
|---|---|
...disposables | Disposable[] |
Returns
fn
▸ (): void
Returns
void
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:168
executeCommand
▸ executeCommand<T>(command, ...args): Promise<undefined | T>
Executes the built-in ide command denoted by the given command identifier.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
command | string |
...args | any[] |
Returns
Promise<undefined | T>
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:158
findInWorkspace
▸ findInWorkspace(query): Promise<void>
Find occurrences of query string in all files in the workspace
Parameters
| Name | Type |
|---|---|
query | string |
Returns
Promise<void>
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:135
flashRanges
▸ flashRanges(flashDescriptors): Promise<void>
Temporarily emphasize the given ranges to the user. This function is used to show ranges that eg are about to be deleted, are the source of a bring, etc. The promise should resolve when the flash is complete.
Parameters
| Name | Type |
|---|---|
flashDescriptors | FlashDescriptor[] |
Returns
Promise<void>
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:36
getEditableTextEditor
▸ getEditableTextEditor(editor): EditableTextEditor
Get an editable version of the text editor.
Parameters
| Name | Type |
|---|---|
editor | TextEditor |
Returns
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:154
onDidChangeActiveTextEditor
▸ onDidChangeActiveTextEditor(listener, thisArgs?, disposables?): Disposable
Parameters
| Name | Type |
|---|---|
listener | (e: undefined | TextEditor) => any |
thisArgs? | any |
disposables? | Disposable[] |
Returns
Implementation of
IDE.onDidChangeActiveTextEditor
Defined in
libs/common/ide/PassthroughIDEBase.ts:66
onDidChangeTextDocument
▸ onDidChangeTextDocument(listener): Disposable
An event that is emitted when a text document is changed. This usually happens when the contents changes but also when other things like the {@link TextDocument.isDirty dirty}-state changes.
Parameters
| Name | Type |
|---|---|
listener | (event: TextDocumentChangeEvent) => void |
Returns
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:162
onDidChangeTextEditorSelection
▸ onDidChangeTextEditorSelection(listener, thisArgs?, disposables?): Disposable
Parameters
| Name | Type |
|---|---|
listener | (e: TextEditorSelectionChangeEvent) => any |
thisArgs? | any |
disposables? | Disposable[] |
Returns
Implementation of
IDE.onDidChangeTextEditorSelection
Defined in
libs/common/ide/PassthroughIDEBase.ts:88
onDidChangeTextEditorVisibleRanges
▸ onDidChangeTextEditorVisibleRanges(listener, thisArgs?, disposables?): Disposable
Parameters
| Name | Type |
|---|---|
listener | (e: TextEditorVisibleRangesChangeEvent) => any |
thisArgs? | any |
disposables? | Disposable[] |
Returns
Implementation of
IDE.onDidChangeTextEditorVisibleRanges
Defined in
libs/common/ide/PassthroughIDEBase.ts:99
onDidChangeVisibleTextEditors
▸ onDidChangeVisibleTextEditors(listener, thisArgs?, disposables?): Disposable
Parameters
| Name | Type |
|---|---|
listener | (e: TextEditor[]) => any |
thisArgs? | any |
disposables? | Disposable[] |
Returns
Implementation of
IDE.onDidChangeVisibleTextEditors
Defined in
libs/common/ide/PassthroughIDEBase.ts:77
onDidCloseTextDocument
▸ onDidCloseTextDocument(listener, thisArgs?, disposables?): Disposable
Parameters
| Name | Type |
|---|---|
listener | (e: TextDocument) => any |
thisArgs? | any |
disposables? | Disposable[] |
Returns
Implementation of
IDE.onDidCloseTextDocument
Defined in
libs/common/ide/PassthroughIDEBase.ts:55
onDidOpenTextDocument
▸ onDidOpenTextDocument(listener, thisArgs?, disposables?): Disposable
Parameters
| Name | Type |
|---|---|
listener | (e: TextDocument) => any |
thisArgs? | any |
disposables? | Disposable[] |
Returns
Implementation of
IDE.onDidOpenTextDocument
Defined in
libs/common/ide/PassthroughIDEBase.ts:48
openTextDocument
▸ openTextDocument(path): Promise<TextEditor>
Opens a document.
Parameters
| Name | Type |
|---|---|
path | string |
Returns
Promise<TextEditor>
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:139
setHighlightRanges
▸ setHighlightRanges(highlightId, editor, ranges): Promise<void>
Set the ranges in {@link editor} to which {@link highlightId} should be applied. Removes the given highlight from all other ranges in {@link editor}.
Parameters
| Name | Type |
|---|---|
highlightId | undefined | string |
editor | TextEditor |
ranges | GeneralizedRange[] |
Returns
Promise<void>
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:40
showInputBox
▸ showInputBox(options?): Promise<undefined | string>
Opens an input box to ask the user for input.
The returned value will be undefined if the input box was canceled (e.g. pressing ESC). Otherwise the
returned value will be the string typed by the user or an empty string if the user did not type
anything but dismissed the input box with OK.
Parameters
| Name | Type |
|---|---|
options? | any |
Returns
Promise<undefined | string>
Implementation of
Defined in
libs/common/ide/PassthroughIDEBase.ts:150
showQuickPick
▸ showQuickPick(items, options?): Promise<undefined | string>
Shows a selection list.
Parameters
| Name | Type |
|---|---|
items | readonly string[] |
options? | QuickPickOptions |
Returns
Promise<undefined | string>