|
|
<!doctype html>
|
|
|
<html class="default no-js">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>window | VS Code API 中文文档</title>
|
|
|
<meta name="description" content="Documentation for VS Code API 中文文档">
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
<style>
|
|
|
a[title="站长统计"] {
|
|
|
display: none;
|
|
|
}
|
|
|
.github-corner svg {
|
|
|
z-index: 1;
|
|
|
}
|
|
|
.github-corner:hover .octo-arm {
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
@keyframes octocat-wave {
|
|
|
0%,100%{transform:rotate(0)}
|
|
|
20%,60%{transform:rotate(-25deg)}
|
|
|
40%,80%{transform:rotate(10deg)}
|
|
|
}
|
|
|
@media (max-width:500px) {
|
|
|
.github-corner:hover
|
|
|
.octo-arm{animation:none}
|
|
|
.github-corner .octo-arm{
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
}
|
|
|
.container-main {
|
|
|
padding-bottom: 50px;
|
|
|
}
|
|
|
</style>
|
|
|
</head>
|
|
|
<body>
|
|
|
<header>
|
|
|
<div class="tsd-page-toolbar">
|
|
|
<div class="container">
|
|
|
<div class="table-wrap">
|
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
|
<div class="field">
|
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
|
<input id="tsd-search-field" type="text" />
|
|
|
</div>
|
|
|
<ul class="results">
|
|
|
<li class="state loading">Preparing search index...</li>
|
|
|
<li class="state failure">The search index is not available</li>
|
|
|
</ul>
|
|
|
<a href="../index.html" class="title">VS Code API 中文文档</a>
|
|
|
</div>
|
|
|
<div class="table-cell" id="tsd-widgets">
|
|
|
<div id="tsd-filter">
|
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
|
<div class="tsd-filter-group">
|
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
|
<span class="tsd-select-label">All</span>
|
|
|
<ul class="tsd-select-list">
|
|
|
<li data-value="public">Public</li>
|
|
|
<li data-value="protected">Public/Protected</li>
|
|
|
<li data-value="private" class="selected">All</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
|
</div>
|
|
|
</div>
|
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="tsd-page-title">
|
|
|
<div class="container">
|
|
|
<ul class="tsd-breadcrumb">
|
|
|
<li>
|
|
|
<a href="../modules.html">VS Code API 中文文档</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="window.html">window</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1>Namespace window</h1>
|
|
|
</div>
|
|
|
</div>
|
|
|
</header>
|
|
|
<div class="container container-main">
|
|
|
<div class="row">
|
|
|
<div class="col-8 col-content">
|
|
|
<section class="tsd-panel tsd-comment">
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>用于处理编辑器当前窗口（window）的命名空间。就是可见和活动的编辑器以及显示信息、选择和要求用户输入的 UI 元素。</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>maintainer</dt>
|
|
|
<dd><p><a href="https://github.com/youngjuning" class="external">@youngjuning</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
|
<h2>索引</h2>
|
|
|
<section class="tsd-panel tsd-index-panel">
|
|
|
<div class="tsd-index-content">
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Variables（6）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="window.html#activeTextEditor" class="tsd-kind-icon">active<wbr>Text<wbr>Editor</a></li>
|
|
|
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="window.html#visibleTextEditors" class="tsd-kind-icon">visible<wbr>Text<wbr>Editors</a></li>
|
|
|
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="window.html#terminals" class="tsd-kind-icon">terminals</a></li>
|
|
|
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="window.html#activeTerminal" class="tsd-kind-icon">active<wbr>Terminal</a></li>
|
|
|
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="window.html#state" class="tsd-kind-icon">state</a></li>
|
|
|
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="window.html#activeColorTheme" class="tsd-kind-icon">active<wbr>Color<wbr>Theme</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Functions（39）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeActiveTextEditor" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Text<wbr>Editor</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeVisibleTextEditors" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Visible<wbr>Text<wbr>Editors</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeTextEditorSelection" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Selection</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeTextEditorVisibleRanges" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Visible<wbr>Ranges</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeTextEditorOptions" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Options</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeTextEditorViewColumn" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>View<wbr>Column</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeActiveTerminal" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Terminal</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidOpenTerminal" class="tsd-kind-icon">on<wbr>Did<wbr>Open<wbr>Terminal</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidCloseTerminal" class="tsd-kind-icon">on<wbr>Did<wbr>Close<wbr>Terminal</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeWindowState" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Window<wbr>State</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#showTextDocument" class="tsd-kind-icon">show<wbr>Text<wbr>Document</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#createTextEditorDecorationType" class="tsd-kind-icon">create<wbr>Text<wbr>Editor<wbr>Decoration<wbr>Type</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#showInformationMessage" class="tsd-kind-icon">show<wbr>Information<wbr>Message</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#showWarningMessage" class="tsd-kind-icon">show<wbr>Warning<wbr>Message</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#showErrorMessage" class="tsd-kind-icon">show<wbr>Error<wbr>Message</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#showQuickPick" class="tsd-kind-icon">show<wbr>Quick<wbr>Pick</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#showWorkspaceFolderPick" class="tsd-kind-icon">show<wbr>Workspace<wbr>Folder<wbr>Pick</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#showOpenDialog" class="tsd-kind-icon">show<wbr>Open<wbr>Dialog</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#showSaveDialog" class="tsd-kind-icon">show<wbr>Save<wbr>Dialog</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#showInputBox" class="tsd-kind-icon">show<wbr>Input<wbr>Box</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#createQuickPick" class="tsd-kind-icon">create<wbr>Quick<wbr>Pick</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#createInputBox" class="tsd-kind-icon">create<wbr>Input<wbr>Box</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#createOutputChannel" class="tsd-kind-icon">create<wbr>Output<wbr>Channel</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#createWebviewPanel" class="tsd-kind-icon">create<wbr>Webview<wbr>Panel</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#setStatusBarMessage" class="tsd-kind-icon">set<wbr>Status<wbr>Bar<wbr>Message</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#withScmProgress" class="tsd-kind-icon">with<wbr>Scm<wbr>Progress</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#withProgress" class="tsd-kind-icon">with<wbr>Progress</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#createStatusBarItem" class="tsd-kind-icon">create<wbr>Status<wbr>Bar<wbr>Item</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#createTerminal" class="tsd-kind-icon">create<wbr>Terminal</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#registerTreeDataProvider" class="tsd-kind-icon">register<wbr>Tree<wbr>Data<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="window.html#createTreeView" class="tsd-kind-icon">create<wbr>Tree<wbr>View</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#registerUriHandler" class="tsd-kind-icon">register<wbr>Uri<wbr>Handler</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#registerWebviewPanelSerializer" class="tsd-kind-icon">register<wbr>Webview<wbr>Panel<wbr>Serializer</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#registerWebviewViewProvider" class="tsd-kind-icon">register<wbr>Webview<wbr>View<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#registerCustomEditorProvider" class="tsd-kind-icon">register<wbr>Custom<wbr>Editor<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#registerTerminalLinkProvider" class="tsd-kind-icon">register<wbr>Terminal<wbr>Link<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#registerTerminalProfileProvider" class="tsd-kind-icon">register<wbr>Terminal<wbr>Profile<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#registerFileDecorationProvider" class="tsd-kind-icon">register<wbr>File<wbr>Decoration<wbr>Provider</a></li>
|
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="window.html#onDidChangeActiveColorTheme" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Color<wbr>Theme</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Variables（6）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a name="activeTextEditor" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> active<wbr>Text<wbr>Editor</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">active<wbr>Text<wbr>Editor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8454">vscode.d.ts:8454</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>当前活动的编辑器或 <code>undefined</code>。活动的编辑器是当前聚焦的编辑器，或者当没有聚焦时，是最近改变输入的编辑器。</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a name="visibleTextEditors" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> visible<wbr>Text<wbr>Editors</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">visible<wbr>Text<wbr>Editors<span class="tsd-signature-symbol">:</span> <a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">[]</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8459">vscode.d.ts:8459</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>当前可见的编辑器或者一个空数组。</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a name="terminals" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> terminals</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">terminals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">[]</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8496">vscode.d.ts:8496</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The currently opened terminals or an empty array.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a name="activeTerminal" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> active<wbr>Terminal</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">active<wbr>Terminal<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8502">vscode.d.ts:8502</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The currently active terminal or <code>undefined</code>. The active terminal is the one that
|
|
|
currently has focus or most recently had focus.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a name="state" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> state</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <a href="../interfaces/WindowState.html" class="tsd-signature-type" data-tsd-kind="Interface">WindowState</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8525">vscode.d.ts:8525</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Represents the current window's state.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a name="activeColorTheme" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagLet">Let</span> active<wbr>Color<wbr>Theme</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">active<wbr>Color<wbr>Theme<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ColorTheme.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorTheme</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9100">vscode.d.ts:9100</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The currently active color theme as configured in the settings. The active
|
|
|
theme can be changed via the <code>workbench.colorTheme</code> setting.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Functions（39）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeActiveTextEditor" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Active<wbr>Text<wbr>Editor</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Text<wbr>Editor<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8465">vscode.d.ts:8465</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>当 <a href="window.html#activeTextEditor">活动编辑器</a> 发生变化时，一个 <a href="../interfaces/Event.html">Event</a> 会被触发。
|
|
|
<em>注意</em>，当活动编辑器改变时，该事件也会发生。变成 <code>undefined</code> 时，事件也会触发。</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeVisibleTextEditors" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Visible<wbr>Text<wbr>Editors</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Visible<wbr>Text<wbr>Editors<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8471">vscode.d.ts:8471</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the array of <a href="window.html#visibleTextEditors">visible editors</a>
|
|
|
has changed.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeTextEditorSelection" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Selection</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Selection<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorSelectionChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorSelectionChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8476">vscode.d.ts:8476</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the selection in an editor has changed.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorSelectionChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorSelectionChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorSelectionChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorSelectionChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/TextEditorSelectionChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorSelectionChangeEvent</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeTextEditorVisibleRanges" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Visible<wbr>Ranges</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Visible<wbr>Ranges<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorVisibleRangesChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorVisibleRangesChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8481">vscode.d.ts:8481</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the visible ranges of an editor has changed.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorVisibleRangesChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorVisibleRangesChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorVisibleRangesChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorVisibleRangesChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/TextEditorVisibleRangesChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorVisibleRangesChangeEvent</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeTextEditorOptions" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Options</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Options<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorOptionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorOptionsChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8486">vscode.d.ts:8486</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the options of an editor have changed.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorOptionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorOptionsChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorOptionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorOptionsChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/TextEditorOptionsChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorOptionsChangeEvent</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeTextEditorViewColumn" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>View<wbr>Column</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>View<wbr>Column<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorViewColumnChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorViewColumnChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8491">vscode.d.ts:8491</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the view column of an editor has changed.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorViewColumnChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorViewColumnChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorViewColumnChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorViewColumnChangeEvent</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/TextEditorViewColumnChangeEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorViewColumnChangeEvent</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeActiveTerminal" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Active<wbr>Terminal</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Terminal<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8509">vscode.d.ts:8509</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the <a href="window.html#activeTerminal">active terminal</a>
|
|
|
has changed. <em>Note</em> that the event also fires when the active terminal changes
|
|
|
to <code>undefined</code>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidOpenTerminal" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Open<wbr>Terminal</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Open<wbr>Terminal<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8515">vscode.d.ts:8515</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when a terminal has been created, either through the
|
|
|
<a href="window.html#createTerminal">createTerminal</a> API or commands.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidCloseTerminal" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Close<wbr>Terminal</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Close<wbr>Terminal<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8520">vscode.d.ts:8520</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when a terminal is disposed.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeWindowState" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Window<wbr>State</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Window<wbr>State<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/WindowState.html" class="tsd-signature-type" data-tsd-kind="Interface">WindowState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8531">vscode.d.ts:8531</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the focus state of the current window
|
|
|
changes. The value of the event represents whether the window is focused.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/WindowState.html" class="tsd-signature-type" data-tsd-kind="Interface">WindowState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/WindowState.html" class="tsd-signature-type" data-tsd-kind="Interface">WindowState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/WindowState.html" class="tsd-signature-type" data-tsd-kind="Interface">WindowState</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="showTextDocument" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Text<wbr>Document</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Text<wbr>Document<span class="tsd-signature-symbol">(</span>document<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a>, column<span class="tsd-signature-symbol">?: </span><a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a>, preserveFocus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Text<wbr>Document<span class="tsd-signature-symbol">(</span>document<span class="tsd-signature-symbol">: </span><a href="../interfaces/TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/TextDocumentShowOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocumentShowOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Text<wbr>Document<span class="tsd-signature-symbol">(</span>uri<span class="tsd-signature-symbol">: </span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/TextDocumentShowOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocumentShowOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8544">vscode.d.ts:8544</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show the given document in a text editor. A <a href="../enums/ViewColumn.html">column</a> can be provided
|
|
|
to control where the editor is being shown. Might change the <a href="window.html#activeTextEditor">active editor</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>document: <a href="../interfaces/TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A text document to be shown.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> column: <a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A view column in which the <a href="../interfaces/TextEditor.html">editor</a> should be shown. The default is the <a href="../enums/ViewColumn.html#Active">active</a>, other values
|
|
|
are adjusted to be <code>Min(column, columnCount + 1)</code>, the <a href="../enums/ViewColumn.html#Active">active</a>-column is not adjusted. Use <a href="../enums/ViewColumn.html#Beside"><code>ViewColumn.Beside</code></a>
|
|
|
to open the editor to the side of the currently active one.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> preserveFocus: <span class="tsd-signature-type">boolean</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>When <code>true</code> the editor will not take focus.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to an <a href="../interfaces/TextEditor.html">editor</a>.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8554">vscode.d.ts:8554</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show the given document in a text editor. <a href="../interfaces/TextDocumentShowOptions.html">Options</a> can be provided
|
|
|
to control options of the editor is being shown. Might change the <a href="window.html#activeTextEditor">active editor</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>document: <a href="../interfaces/TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A text document to be shown.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/TextDocumentShowOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocumentShowOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p><a href="../interfaces/TextDocumentShowOptions.html">Editor options</a> to configure the behavior of showing the <a href="../interfaces/TextEditor.html">editor</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to an <a href="../interfaces/TextEditor.html">editor</a>.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8565">vscode.d.ts:8565</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A short-hand for <code>openTextDocument(uri).then(document => showTextDocument(document, options))</code>.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="workspace.html#openTextDocument">openTextDocument</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>uri: <a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A resource identifier.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/TextDocumentShowOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocumentShowOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p><a href="../interfaces/TextDocumentShowOptions.html">Editor options</a> to configure the behavior of showing the <a href="../interfaces/TextEditor.html">editor</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/TextEditor.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditor</a><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to an <a href="../interfaces/TextEditor.html">editor</a>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="createTextEditorDecorationType" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Text<wbr>Editor<wbr>Decoration<wbr>Type</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Text<wbr>Editor<wbr>Decoration<wbr>Type<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/DecorationRenderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DecorationRenderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/TextEditorDecorationType.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorDecorationType</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8573">vscode.d.ts:8573</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Create a TextEditorDecorationType that can be used to add decorations to text editors.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/DecorationRenderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DecorationRenderOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Rendering options for the decoration type.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/TextEditorDecorationType.html" class="tsd-signature-type" data-tsd-kind="Interface">TextEditorDecorationType</a></h4>
|
|
|
<p>A new decoration type instance.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="showInformationMessage" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Information<wbr>Message</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Information<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Information<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Information<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Information<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8583">vscode.d.ts:8583</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an information message to users. Optionally provide an array of items which will be presented as
|
|
|
clickable buttons.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8594">vscode.d.ts:8594</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an information message to users. Optionally provide an array of items which will be presented as
|
|
|
clickable buttons.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behaviour of the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8605">vscode.d.ts:8605</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an information message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageItem.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8617">vscode.d.ts:8617</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an information message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageItem.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behaviour of the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="showWarningMessage" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Warning<wbr>Message</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Warning<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Warning<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Warning<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Warning<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8628">vscode.d.ts:8628</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show a warning message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8640">vscode.d.ts:8640</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show a warning message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behaviour of the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8651">vscode.d.ts:8651</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show a warning message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageItem.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8663">vscode.d.ts:8663</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show a warning message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageItem.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behaviour of the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="showErrorMessage" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Error<wbr>Message</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Error<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Error<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Error<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Error<wbr>Message<T><span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a>, <span class="tsd-signature-symbol">...</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8674">vscode.d.ts:8674</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an error message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8686">vscode.d.ts:8686</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an error message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behaviour of the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8697">vscode.d.ts:8697</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an error message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageItem.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8709">vscode.d.ts:8709</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show an error message.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>see</dt>
|
|
|
<dd><p><a href="window.html#showInformationMessage">showInformationMessage</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/MessageItem.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>message: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/MessageOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behaviour of the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>items: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A set of items that will be rendered as actions in the message.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A thenable that resolves to the selected item or <code>undefined</code> when being dismissed.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="showQuickPick" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Quick<wbr>Pick</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Quick<wbr>Pick<span class="tsd-signature-symbol">(</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>canPickMany<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> }</span>, token<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Quick<wbr>Pick<span class="tsd-signature-symbol">(</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a>, token<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Quick<wbr>Pick<T><span class="tsd-signature-symbol">(</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>canPickMany<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> }</span>, token<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Quick<wbr>Pick<T><span class="tsd-signature-symbol">(</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a>, token<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8719">vscode.d.ts:8719</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Shows a selection list allowing multiple selections.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>items: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An array of strings, or a promise that resolves to an array of strings.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>canPickMany<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behavior of the selection list.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A token that can be used to signal cancellation.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to the selected items or <code>undefined</code>.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8729">vscode.d.ts:8729</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Shows a selection list.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>items: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An array of strings, or a promise that resolves to an array of strings.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behavior of the selection list.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A token that can be used to signal cancellation.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to the selection or <code>undefined</code>.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8739">vscode.d.ts:8739</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Shows a selection list allowing multiple selections.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/QuickPickItem.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>items: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An array of items, or a promise that resolves to an array of items.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>canPickMany<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behavior of the selection list.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A token that can be used to signal cancellation.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to the selected items or <code>undefined</code>.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8749">vscode.d.ts:8749</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Shows a selection list.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/QuickPickItem.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>items: <span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An array of items, or a promise that resolves to an array of items.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/QuickPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behavior of the selection list.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A token that can be used to signal cancellation.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to the selected item or <code>undefined</code>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="showWorkspaceFolderPick" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Workspace<wbr>Folder<wbr>Pick</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Workspace<wbr>Folder<wbr>Pick<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WorkspaceFolderPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolderPickOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8758">vscode.d.ts:8758</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Shows a selection list of <a href="workspace.html#workspaceFolders">workspace folders</a> to pick from.
|
|
|
Returns <code>undefined</code> if no folder is open.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/WorkspaceFolderPickOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolderPickOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behavior of the workspace folder list.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/WorkspaceFolder.html" class="tsd-signature-type" data-tsd-kind="Interface">WorkspaceFolder</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to the workspace folder or <code>undefined</code>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="showOpenDialog" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Open<wbr>Dialog</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Open<wbr>Dialog<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/OpenDialogOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">OpenDialogOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8767">vscode.d.ts:8767</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Shows a file open dialog to the user which allows to select a file
|
|
|
for opening-purposes.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/OpenDialogOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">OpenDialogOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Options that control the dialog.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to the selected resources or <code>undefined</code>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="showSaveDialog" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Save<wbr>Dialog</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Save<wbr>Dialog<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/SaveDialogOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SaveDialogOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8776">vscode.d.ts:8776</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Shows a file save dialog to the user which allows to select a file
|
|
|
for saving-purposes.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/SaveDialogOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SaveDialogOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Options that control the dialog.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to the selected resource or <code>undefined</code>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="showInputBox" class="tsd-anchor"></a>
|
|
|
<h3>show<wbr>Input<wbr>Box</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">show<wbr>Input<wbr>Box<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/InputBoxOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">InputBoxOptions</a>, token<span class="tsd-signature-symbol">?: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8789">vscode.d.ts:8789</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Opens an input box to ask the user for input.</p>
|
|
|
</div>
|
|
|
<p>The returned value will be <code>undefined</code> 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.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/InputBoxOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">InputBoxOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Configures the behavior of the input box.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> token: <a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A token that can be used to signal cancellation.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A promise that resolves to a string the user provided or to <code>undefined</code> in case of dismissal.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="createQuickPick" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Quick<wbr>Pick</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Quick<wbr>Pick<T><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/QuickPick.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPick</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8801">vscode.d.ts:8801</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a <a href="../interfaces/QuickPick.html">QuickPick</a> to let the user pick an item from a list
|
|
|
of items of type T.</p>
|
|
|
</div>
|
|
|
<p>Note that in many cases the more convenient <a href="window.html#showQuickPick">window.showQuickPick</a>
|
|
|
is easier to use. <a href="window.html#createQuickPick">window.createQuickPick</a> should be used
|
|
|
when <a href="window.html#showQuickPick">window.showQuickPick</a> does not offer the required flexibility.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/QuickPickItem.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/QuickPick.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPick</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>A new <a href="../interfaces/QuickPick.html">QuickPick</a>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="createInputBox" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Input<wbr>Box</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Input<wbr>Box<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/InputBox.html" class="tsd-signature-type" data-tsd-kind="Interface">InputBox</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8812">vscode.d.ts:8812</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a <a href="../interfaces/InputBox.html">InputBox</a> to let the user enter some text input.</p>
|
|
|
</div>
|
|
|
<p>Note that in many cases the more convenient <a href="window.html#showInputBox">window.showInputBox</a>
|
|
|
is easier to use. <a href="window.html#createInputBox">window.createInputBox</a> should be used
|
|
|
when <a href="window.html#showInputBox">window.showInputBox</a> does not offer the required flexibility.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/InputBox.html" class="tsd-signature-type" data-tsd-kind="Interface">InputBox</a></h4>
|
|
|
<p>A new <a href="../interfaces/InputBox.html">InputBox</a>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="createOutputChannel" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Output<wbr>Channel</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Output<wbr>Channel<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/OutputChannel.html" class="tsd-signature-type" data-tsd-kind="Interface">OutputChannel</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8819">vscode.d.ts:8819</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a new <a href="../interfaces/OutputChannel.html">output channel</a> with the given name.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Human-readable string which will be used to represent the channel in the UI.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/OutputChannel.html" class="tsd-signature-type" data-tsd-kind="Interface">OutputChannel</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="createWebviewPanel" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Webview<wbr>Panel</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Webview<wbr>Panel<span class="tsd-signature-symbol">(</span>viewType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, showOptions<span class="tsd-signature-symbol">: </span><a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>viewColumn<span class="tsd-signature-symbol">: </span><a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a><span class="tsd-signature-symbol">; </span>preserveFocus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WebviewPanelOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelOptions</a><span class="tsd-signature-symbol"> & </span><a href="../interfaces/WebviewOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/WebviewPanel.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanel</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8831">vscode.d.ts:8831</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Create and show a new webview panel.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>viewType: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Identifies the type of the webview panel.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>title: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Title of the panel.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>showOptions: <a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>viewColumn<span class="tsd-signature-symbol">: </span><a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a><span class="tsd-signature-symbol">; </span>preserveFocus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Where to show the webview in the editor. If preserveFocus is set, the new webview will not take focus.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/WebviewPanelOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelOptions</a><span class="tsd-signature-symbol"> & </span><a href="../interfaces/WebviewOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Settings for the new panel.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/WebviewPanel.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanel</a></h4>
|
|
|
<p>New webview panel.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="setStatusBarMessage" class="tsd-anchor"></a>
|
|
|
<h3>set<wbr>Status<wbr>Bar<wbr>Message</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Status<wbr>Bar<wbr>Message<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hideAfterTimeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Status<wbr>Bar<wbr>Message<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, hideWhenDone<span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Status<wbr>Bar<wbr>Message<span class="tsd-signature-symbol">(</span>text<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8841">vscode.d.ts:8841</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Set a message to the status bar. This is a short hand for the more powerful
|
|
|
status bar <a href="window.html#createStatusBarItem">items</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>text: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show, supports icon substitution as in status bar <a href="../interfaces/StatusBarItem.html#text">items</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>hideAfterTimeout: <span class="tsd-signature-type">number</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Timeout in milliseconds after which the message will be disposed.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
<p>A disposable which hides the status bar message.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8851">vscode.d.ts:8851</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Set a message to the status bar. This is a short hand for the more powerful
|
|
|
status bar <a href="window.html#createStatusBarItem">items</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>text: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show, supports icon substitution as in status bar <a href="../interfaces/StatusBarItem.html#text">items</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>hideWhenDone: <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Thenable on which completion (resolve or reject) the message will be disposed.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
<p>A disposable which hides the status bar message.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8863">vscode.d.ts:8863</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Set a message to the status bar. This is a short hand for the more powerful
|
|
|
status bar <a href="window.html#createStatusBarItem">items</a>.</p>
|
|
|
</div>
|
|
|
<p><em>Note</em> that status bar messages stack and that they must be disposed when no
|
|
|
longer used.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>text: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The message to show, supports icon substitution as in status bar <a href="../interfaces/StatusBarItem.html#text">items</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
<p>A disposable which hides the status bar message.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="withScmProgress" class="tsd-anchor"></a>
|
|
|
<h3>with<wbr>Scm<wbr>Progress</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Scm<wbr>Progress<R><span class="tsd-signature-symbol">(</span>task<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8875">vscode.d.ts:8875</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show progress in the Source Control viewlet while running the given callback and while
|
|
|
its returned promise isn't resolve or rejected.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>deprecated</dt>
|
|
|
<dd><p>Use <code>withProgress</code> instead.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>R</h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>task: <span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A callback returning a promise. Progress increments can be reported with
|
|
|
the provided <a href="../interfaces/Progress.html">Progress</a>-object.</p>
|
|
|
</div>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>progress: <a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>The thenable the task did return.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="withProgress" class="tsd-anchor"></a>
|
|
|
<h3>with<wbr>Progress</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">with<wbr>Progress<R><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ProgressOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProgressOptions</a>, task<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>increment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span>, token<span class="tsd-signature-symbol">: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8896">vscode.d.ts:8896</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Show progress in the editor. Progress is shown while running the given callback
|
|
|
and while the promise it returned isn't resolved nor rejected. The location at which
|
|
|
progress should show (and other details) is defined via the passed <a href="../interfaces/ProgressOptions.html"><code>ProgressOptions</code></a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>R</h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/ProgressOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProgressOptions</a></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>task: <span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>increment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span>, token<span class="tsd-signature-symbol">: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A callback returning a promise. Progress state can be reported with
|
|
|
the provided <a href="../interfaces/Progress.html">Progress</a>-object.</p>
|
|
|
<p>To report discrete progress, use <code>increment</code> to indicate how much work has been completed. Each call with
|
|
|
a <code>increment</code> value will be summed up and reflected as overall progress until 100% is reached (a value of
|
|
|
e.g. <code>10</code> accounts for <code>10%</code> of work done).
|
|
|
Note that currently only <code>ProgressLocation.Notification</code> is capable of showing discrete progress.</p>
|
|
|
<p>To monitor if the operation has been cancelled by the user, use the provided <a href="../interfaces/CancellationToken.html"><code>CancellationToken</code></a>.
|
|
|
Note that currently only <code>ProgressLocation.Notification</code> is supporting to show a cancel button to cancel the
|
|
|
long running operation.</p>
|
|
|
</div>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>progress<span class="tsd-signature-symbol">: </span><a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>increment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span>, token<span class="tsd-signature-symbol">: </span><a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>progress: <a href="../interfaces/Progress.html" class="tsd-signature-type" data-tsd-kind="Interface">Progress</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>increment<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>token: <a href="../interfaces/CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">R</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>The thenable the task-callback returned.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="createStatusBarItem" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Status<wbr>Bar<wbr>Item</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Status<wbr>Bar<wbr>Item<span class="tsd-signature-symbol">(</span>alignment<span class="tsd-signature-symbol">?: </span><a href="../enums/StatusBarAlignment.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StatusBarAlignment</a>, priority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/StatusBarItem.html" class="tsd-signature-type" data-tsd-kind="Interface">StatusBarItem</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Status<wbr>Bar<wbr>Item<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, alignment<span class="tsd-signature-symbol">?: </span><a href="../enums/StatusBarAlignment.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StatusBarAlignment</a>, priority<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/StatusBarItem.html" class="tsd-signature-type" data-tsd-kind="Interface">StatusBarItem</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8905">vscode.d.ts:8905</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a status bar <a href="../interfaces/StatusBarItem.html">item</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> alignment: <a href="../enums/StatusBarAlignment.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StatusBarAlignment</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The alignment of the item.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> priority: <span class="tsd-signature-type">number</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The priority of the item. Higher values mean the item should be shown more to the left.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/StatusBarItem.html" class="tsd-signature-type" data-tsd-kind="Interface">StatusBarItem</a></h4>
|
|
|
<p>A new status bar item.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8915">vscode.d.ts:8915</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a status bar <a href="../interfaces/StatusBarItem.html">item</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The unique identifier of the item.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> alignment: <a href="../enums/StatusBarAlignment.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StatusBarAlignment</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The alignment of the item.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> priority: <span class="tsd-signature-type">number</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The priority of the item. Higher values mean the item should be shown more to the left.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/StatusBarItem.html" class="tsd-signature-type" data-tsd-kind="Interface">StatusBarItem</a></h4>
|
|
|
<p>A new status bar item.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="createTerminal" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Terminal</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Terminal<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, shellPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, shellArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Terminal<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/TerminalOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TerminalOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Terminal<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/ExtensionTerminalOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ExtensionTerminalOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8929">vscode.d.ts:8929</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a <a href="../interfaces/Terminal.html">Terminal</a> with a backing shell process. The cwd of the terminal will be the workspace
|
|
|
directory if it exists.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>throws</dt>
|
|
|
<dd><p>When running in an environment where a new process cannot be started.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Optional human-readable string which will be used to represent the terminal in the UI.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> shellPath: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Optional path to a custom shell executable to be used in the terminal.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> shellArgs: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Optional args for the custom shell executable. A string can be used on Windows only which
|
|
|
allows specifying shell args in
|
|
|
<a href="https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6">command-line format</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></h4>
|
|
|
<p>A new Terminal.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8938">vscode.d.ts:8938</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a <a href="../interfaces/Terminal.html">Terminal</a> with a backing shell process.</p>
|
|
|
</div>
|
|
|
<dl class="tsd-comment-tags">
|
|
|
<dt>throws</dt>
|
|
|
<dd><p>When running in an environment where a new process cannot be started.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/TerminalOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TerminalOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A TerminalOptions object describing the characteristics of the new terminal.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></h4>
|
|
|
<p>A new Terminal.</p>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8947">vscode.d.ts:8947</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Creates a <a href="../interfaces/Terminal.html">Terminal</a> where an extension controls its input and output.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/ExtensionTerminalOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ExtensionTerminalOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>An <a href="../interfaces/ExtensionTerminalOptions.html">ExtensionTerminalOptions</a> object describing
|
|
|
the characteristics of the new terminal.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Terminal.html" class="tsd-signature-type" data-tsd-kind="Interface">Terminal</a></h4>
|
|
|
<p>A new Terminal.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="registerTreeDataProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Tree<wbr>Data<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Tree<wbr>Data<wbr>Provider<T><span class="tsd-signature-symbol">(</span>viewId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, treeDataProvider<span class="tsd-signature-symbol">: </span><a href="../interfaces/TreeDataProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeDataProvider</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8958">vscode.d.ts:8958</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a <a href="../interfaces/TreeDataProvider.html">TreeDataProvider</a> for the view contributed using the extension point <code>views</code>.
|
|
|
This will allow you to contribute data to the <a href="../interfaces/TreeView.html">TreeView</a> and update if the data changes.</p>
|
|
|
</div>
|
|
|
<p><strong>Note:</strong> To get access to the <a href="../interfaces/TreeView.html">TreeView</a> and perform operations on it, use <a href="window.html#createTreeView">createTreeView</a>.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T</h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>viewId: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Id of the view contributed using the extension point <code>views</code>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>treeDataProvider: <a href="../interfaces/TreeDataProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeDataProvider</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A <a href="../interfaces/TreeDataProvider.html">TreeDataProvider</a> that provides tree data for the view</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a name="createTreeView" class="tsd-anchor"></a>
|
|
|
<h3>create<wbr>Tree<wbr>View</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Tree<wbr>View<T><span class="tsd-signature-symbol">(</span>viewId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/TreeViewOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeViewOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/TreeView.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeView</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8966">vscode.d.ts:8966</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Create a <a href="../interfaces/TreeView.html">TreeView</a> for the view contributed using the extension point <code>views</code>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-type-parameters-title">Type parameters</h4>
|
|
|
<ul class="tsd-type-parameters">
|
|
|
<li>
|
|
|
<h4>T</h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>viewId: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Id of the view contributed using the extension point <code>views</code>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>options: <a href="../interfaces/TreeViewOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeViewOptions</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Options for creating the <a href="../interfaces/TreeView.html">TreeView</a></p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/TreeView.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeView</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h4>
|
|
|
<p>a <a href="../interfaces/TreeView.html">TreeView</a>.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerUriHandler" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Uri<wbr>Handler</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Uri<wbr>Handler<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">: </span><a href="../interfaces/UriHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">UriHandler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L8989">vscode.d.ts:8989</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Registers a <a href="../interfaces/UriHandler.html">uri handler</a> capable of handling system-wide <a href="../classes/Uri.html">uris</a>.
|
|
|
In case there are multiple windows open, the topmost window will handle the uri.
|
|
|
A uri handler is scoped to the extension it is contributed from; it will only
|
|
|
be able to handle uris which are directed to the extension itself. A uri must respect
|
|
|
the following rules:</p>
|
|
|
</div>
|
|
|
<ul>
|
|
|
<li>The uri-scheme must be <code>vscode.env.uriScheme</code>;</li>
|
|
|
<li>The uri-authority must be the extension id (e.g. <code>my.extension</code>);</li>
|
|
|
<li>The uri-path, -query and -fragment parts are arbitrary.</li>
|
|
|
</ul>
|
|
|
<p>For example, if the <code>my.extension</code> extension registers a uri handler, it will only
|
|
|
be allowed to handle uris with the prefix <code>product-name://my.extension</code>.</p>
|
|
|
<p>An extension can only register a single uri handler in its entire activation lifetime.</p>
|
|
|
<ul>
|
|
|
<li><em>Note:</em> There is an activation event <code>onUri</code> that fires when a uri directed for
|
|
|
the current extension is about to be handled.</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>handler: <a href="../interfaces/UriHandler.html" class="tsd-signature-type" data-tsd-kind="Interface">UriHandler</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The uri handler to register for this extension.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerWebviewPanelSerializer" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Webview<wbr>Panel<wbr>Serializer</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Webview<wbr>Panel<wbr>Serializer<span class="tsd-signature-symbol">(</span>viewType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, serializer<span class="tsd-signature-symbol">: </span><a href="../interfaces/WebviewPanelSerializer.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelSerializer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9002">vscode.d.ts:9002</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Registers a webview panel serializer.</p>
|
|
|
</div>
|
|
|
<p>Extensions that support reviving should have an <code>"onWebviewPanel:viewType"</code> activation event and
|
|
|
make sure that <a href="window.html#registerWebviewPanelSerializer">registerWebviewPanelSerializer</a> is called during activation.</p>
|
|
|
<p>Only a single serializer may be registered at a time for a given <code>viewType</code>.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>viewType: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Type of the webview panel that can be serialized.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>serializer: <a href="../interfaces/WebviewPanelSerializer.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelSerializer</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Webview serializer.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerWebviewViewProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Webview<wbr>View<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Webview<wbr>View<wbr>Provider<span class="tsd-signature-symbol">(</span>viewId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/WebviewViewProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewViewProvider</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>webviewOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>retainContextWhenHidden<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9013">vscode.d.ts:9013</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a new provider for webview views.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>viewId: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Unique id of the view. This should match the <code>id</code> from the
|
|
|
<code>views</code> contribution in the package.json.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/WebviewViewProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewViewProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Provider for the webview views.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>webviewOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>retainContextWhenHidden<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter">
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> webview<wbr>Options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>retainContextWhenHidden<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Content settings for the webview created for this view.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter">
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> retain<wbr>Context<wbr>When<wbr>Hidden<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Controls if the webview element itself (iframe) is kept around even when the view
|
|
|
is no longer visible.</p>
|
|
|
</div>
|
|
|
<p>Normally the webview's html context is created when the view becomes visible
|
|
|
and destroyed when it is hidden. Extensions that have complex state
|
|
|
or UI can set the <code>retainContextWhenHidden</code> to make the editor keep the webview
|
|
|
context around, even when the webview moves to a background tab. When a webview using
|
|
|
<code>retainContextWhenHidden</code> becomes hidden, its scripts and other dynamic content are suspended.
|
|
|
When the view becomes visible again, the context is automatically restored
|
|
|
in the exact same state it was in originally. You cannot send messages to a
|
|
|
hidden webview, even with <code>retainContextWhenHidden</code> enabled.</p>
|
|
|
<p><code>retainContextWhenHidden</code> has a high memory overhead and should only be used if
|
|
|
your view's context cannot be quickly saved and restored.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
<p>Disposable that unregisters the provider.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerCustomEditorProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Custom<wbr>Editor<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Custom<wbr>Editor<wbr>Provider<span class="tsd-signature-symbol">(</span>viewType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/CustomTextEditorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CustomTextEditorProvider</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CustomReadonlyEditorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CustomReadonlyEditorProvider</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CustomEditorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CustomEditorProvider</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>webviewOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WebviewPanelOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelOptions</a><span class="tsd-signature-symbol">; </span>supportsMultipleEditorsPerDocument<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9052">vscode.d.ts:9052</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a provider for custom editors for the <code>viewType</code> contributed by the <code>customEditors</code> extension point.</p>
|
|
|
</div>
|
|
|
<p>When a custom editor is opened, an <code>onCustomEditor:viewType</code> activation event is fired. Your extension
|
|
|
must register a <a href="../interfaces/CustomTextEditorProvider.html"><code>CustomTextEditorProvider</code></a>, <a href="../interfaces/CustomReadonlyEditorProvider.html"><code>CustomReadonlyEditorProvider</code></a>,
|
|
|
<a href="../interfaces/CustomEditorProvider.html"><code>CustomEditorProvider</code></a>for <code>viewType</code> as part of activation.</p>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>viewType: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Unique identifier for the custom editor provider. This should match the <code>viewType</code> from the
|
|
|
<code>customEditors</code> contribution point.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/CustomTextEditorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CustomTextEditorProvider</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CustomReadonlyEditorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CustomReadonlyEditorProvider</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CustomEditorProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">CustomEditorProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Provider that resolves custom editors.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>webviewOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WebviewPanelOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelOptions</a><span class="tsd-signature-symbol">; </span>supportsMultipleEditorsPerDocument<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>Options for the provider.</p>
|
|
|
</div>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter">
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> webview<wbr>Options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/WebviewPanelOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelOptions</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Content settings for the webview panels created for this custom editor.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li class="tsd-parameter">
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> supports<wbr>Multiple<wbr>Editors<wbr>Per<wbr>Document<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Only applies to <code>CustomReadonlyEditorProvider | CustomEditorProvider</code>.</p>
|
|
|
</div>
|
|
|
<p>Indicates that the provider allows multiple editor instances to be open at the same time for
|
|
|
the same resource.</p>
|
|
|
<p>By default, the editor only allows one editor instance to be open at a time for each resource. If the
|
|
|
user tries to open a second editor instance for the resource, the first one is instead moved to where
|
|
|
the second one was to be opened.</p>
|
|
|
<p>When <code>supportsMultipleEditorsPerDocument</code> is enabled, users can split and create copies of the custom
|
|
|
editor. In this case, the custom editor must make sure it can properly synchronize the states of all
|
|
|
editor instances for a resource so that they are consistent.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
<p>Disposable that unregisters the provider.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerTerminalLinkProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Terminal<wbr>Link<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Terminal<wbr>Link<wbr>Provider<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/TerminalLinkProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TerminalLinkProvider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9080">vscode.d.ts:9080</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register provider that enables the detection and handling of links within the terminal.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/TerminalLinkProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TerminalLinkProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The provider that provides the terminal links.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
<p>Disposable that unregisters the provider.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerTerminalProfileProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>Terminal<wbr>Profile<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Terminal<wbr>Profile<wbr>Provider<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/TerminalProfileProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TerminalProfileProvider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9087">vscode.d.ts:9087</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Registers a provider for a contributed terminal profile.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The ID of the contributed terminal profile.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/TerminalProfileProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">TerminalProfileProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The terminal profile provider.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="registerFileDecorationProvider" class="tsd-anchor"></a>
|
|
|
<h3>register<wbr>File<wbr>Decoration<wbr>Provider</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>File<wbr>Decoration<wbr>Provider<span class="tsd-signature-symbol">(</span>provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/FileDecorationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">FileDecorationProvider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9094">vscode.d.ts:9094</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Register a file decoration provider.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>provider: <a href="../interfaces/FileDecorationProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">FileDecorationProvider</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>A <a href="../interfaces/FileDecorationProvider.html">FileDecorationProvider</a>.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
<p>A <a href="../classes/Disposable.html">Disposable</a> that unregisters the provider.</p>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a name="onDidChangeActiveColorTheme" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagConst">Const</span> on<wbr>Did<wbr>Change<wbr>Active<wbr>Color<wbr>Theme</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<li class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Color<wbr>Theme<span class="tsd-signature-symbol">(</span>listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/ColorTheme.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorTheme</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span>, thisArgs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, disposables<span class="tsd-signature-symbol">?: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/29a9fb5/vscode.d.ts#L9105">vscode.d.ts:9105</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>An <a href="../interfaces/Event.html">Event</a> which fires when the active color theme is changed or has changes.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>listener: <span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/ColorTheme.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorTheme</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span></h5>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-signature">
|
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>e<span class="tsd-signature-symbol">: </span><a href="../interfaces/ColorTheme.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorTheme</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-descriptions">
|
|
|
<li class="tsd-description">
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>e: <a href="../interfaces/ColorTheme.html" class="tsd-signature-type" data-tsd-kind="Interface">ColorTheme</a></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thisArgs: <span class="tsd-signature-type">any</span></h5>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> disposables: <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</section>
|
|
|
</div>
|
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
|
<nav class="tsd-navigation primary">
|
|
|
<ul>
|
|
|
<li class=" ">
|
|
|
<a href="../modules.html">Exports</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="authentication.html">authentication</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="commands.html">commands</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="comments.html">comments</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="debug.html">debug</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="env.html">env</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="extensions.html">extensions</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="languages.html">languages</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="notebooks.html">notebooks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="scm.html">scm</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="tasks.html">tasks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="tests.html">tests</a>
|
|
|
</li>
|
|
|
<li class="current tsd-kind-namespace">
|
|
|
<a href="window.html">window</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace">
|
|
|
<a href="workspace.html">workspace</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
<ul class="before-current">
|
|
|
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a href="window.html#activeTextEditor" class="tsd-kind-icon">active<wbr>Text<wbr>Editor</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a href="window.html#visibleTextEditors" class="tsd-kind-icon">visible<wbr>Text<wbr>Editors</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeActiveTextEditor" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Text<wbr>Editor</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeVisibleTextEditors" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Visible<wbr>Text<wbr>Editors</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeTextEditorSelection" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Selection</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeTextEditorVisibleRanges" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Visible<wbr>Ranges</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeTextEditorOptions" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>Options</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeTextEditorViewColumn" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Text<wbr>Editor<wbr>View<wbr>Column</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a href="window.html#terminals" class="tsd-kind-icon">terminals</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a href="window.html#activeTerminal" class="tsd-kind-icon">active<wbr>Terminal</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeActiveTerminal" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Terminal</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidOpenTerminal" class="tsd-kind-icon">on<wbr>Did<wbr>Open<wbr>Terminal</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidCloseTerminal" class="tsd-kind-icon">on<wbr>Did<wbr>Close<wbr>Terminal</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a href="window.html#state" class="tsd-kind-icon">state</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeWindowState" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Window<wbr>State</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#showTextDocument" class="tsd-kind-icon">show<wbr>Text<wbr>Document</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#createTextEditorDecorationType" class="tsd-kind-icon">create<wbr>Text<wbr>Editor<wbr>Decoration<wbr>Type</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#showInformationMessage" class="tsd-kind-icon">show<wbr>Information<wbr>Message</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#showWarningMessage" class="tsd-kind-icon">show<wbr>Warning<wbr>Message</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#showErrorMessage" class="tsd-kind-icon">show<wbr>Error<wbr>Message</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#showQuickPick" class="tsd-kind-icon">show<wbr>Quick<wbr>Pick</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#showWorkspaceFolderPick" class="tsd-kind-icon">show<wbr>Workspace<wbr>Folder<wbr>Pick</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#showOpenDialog" class="tsd-kind-icon">show<wbr>Open<wbr>Dialog</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#showSaveDialog" class="tsd-kind-icon">show<wbr>Save<wbr>Dialog</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#showInputBox" class="tsd-kind-icon">show<wbr>Input<wbr>Box</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#createQuickPick" class="tsd-kind-icon">create<wbr>Quick<wbr>Pick</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#createInputBox" class="tsd-kind-icon">create<wbr>Input<wbr>Box</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#createOutputChannel" class="tsd-kind-icon">create<wbr>Output<wbr>Channel</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#createWebviewPanel" class="tsd-kind-icon">create<wbr>Webview<wbr>Panel</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#setStatusBarMessage" class="tsd-kind-icon">set<wbr>Status<wbr>Bar<wbr>Message</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#withScmProgress" class="tsd-kind-icon">with<wbr>Scm<wbr>Progress</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#withProgress" class="tsd-kind-icon">with<wbr>Progress</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#createStatusBarItem" class="tsd-kind-icon">create<wbr>Status<wbr>Bar<wbr>Item</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#createTerminal" class="tsd-kind-icon">create<wbr>Terminal</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#registerTreeDataProvider" class="tsd-kind-icon">register<wbr>Tree<wbr>Data<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter">
|
|
|
<a href="window.html#createTreeView" class="tsd-kind-icon">create<wbr>Tree<wbr>View</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#registerUriHandler" class="tsd-kind-icon">register<wbr>Uri<wbr>Handler</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#registerWebviewPanelSerializer" class="tsd-kind-icon">register<wbr>Webview<wbr>Panel<wbr>Serializer</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#registerWebviewViewProvider" class="tsd-kind-icon">register<wbr>Webview<wbr>View<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#registerCustomEditorProvider" class="tsd-kind-icon">register<wbr>Custom<wbr>Editor<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#registerTerminalLinkProvider" class="tsd-kind-icon">register<wbr>Terminal<wbr>Link<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#registerTerminalProfileProvider" class="tsd-kind-icon">register<wbr>Terminal<wbr>Profile<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#registerFileDecorationProvider" class="tsd-kind-icon">register<wbr>File<wbr>Decoration<wbr>Provider</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
|
|
|
<a href="window.html#activeColorTheme" class="tsd-kind-icon">active<wbr>Color<wbr>Theme</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
|
<a href="window.html#onDidChangeActiveColorTheme" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<wbr>Color<wbr>Theme</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<footer class="with-border-bottom">
|
|
|
<div class="container">
|
|
|
<h2>图例</h2>
|
|
|
<div class="tsd-legend-group">
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</footer>
|
|
|
<div class="container tsd-generator">
|
|
|
<p><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <a href="https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target="_blank">VS Code 中文文档</a> | <a href="https://code.visualstudio.com/docs" target="_blank">VS Code 官网文档</a> | <a href="https://marketplace.visualstudio.com/" target="_blank">VS Code 扩展市场</a></p>
|
|
|
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a> | <a href="https://www.cnzz.com/stat/website.php?web_id=1280241129" target="_blank" title="VS Code 官网文档站长统计">站长统计</a></p>
|
|
|
</div>
|
|
|
<div class="overlay"></div>
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
<script type="text/javascript">document.write(unescape("%3Cspan id='cnzz_stat_icon_1280241129'%3E%3C/span%3E%3Cscript src='https://s9.cnzz.com/z_stat.php%3Fid%3D1280241129' type='text/javascript'%3E%3C/script%3E"));</script>
|
|
|
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: fixed; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
|
|
|
</body>
|
|
|
</html> |
