yetao
/
vscode-api-cn.js
mirror of https://github.com/youngjuning/vscode-api-cn.js.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd9396ff9f4'
${ noResults }
vscode-api-cn.js/interfaces/QuickPick.html

711 lines
40 KiB
Raw Blame History Escape

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>QuickPick | 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="QuickPick.html">QuickPick</a>
</li>
</ul>
<h1>Interface QuickPick&lt;T&gt;</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>A concrete <a href="QuickInput.html">QuickInput</a> to let the user pick an item from a
list of items of type T. The items can be filtered through a filter text field and
there is an option <a href="QuickPick.html#canSelectMany">canSelectMany</a> to allow for
selecting multiple items.</p>
</div>
<p>Note that in many cases the more convenient <a href="../modules/window.html#showQuickPick">window.showQuickPick</a>
is easier to use. <a href="../modules/window.html#createQuickPick">window.createQuickPick</a> should be used
when <a href="../modules/window.html#showQuickPick">window.showQuickPick</a> does not offer the required flexibility.</p>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="QuickPickItem.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickPickItem</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>层级</h3>
<ul class="tsd-hierarchy">
<li>
<a href="QuickInput.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickInput</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">QuickPick</span>
</li>
</ul>
</li>
</ul>
</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>Properties（21）</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#title" class="tsd-kind-icon">title</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#step" class="tsd-kind-icon">step</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#totalSteps" class="tsd-kind-icon">total<wbr>Steps</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#enabled" class="tsd-kind-icon">enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#busy" class="tsd-kind-icon">busy</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#ignoreFocusOut" class="tsd-kind-icon">ignore<wbr>Focus<wbr>Out</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#onDidHide" class="tsd-kind-icon">on<wbr>Did<wbr>Hide</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#value" class="tsd-kind-icon">value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#placeholder" class="tsd-kind-icon">placeholder</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#onDidChangeValue" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Value</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#onDidAccept" class="tsd-kind-icon">on<wbr>Did<wbr>Accept</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#buttons" class="tsd-kind-icon">buttons</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#onDidTriggerButton" class="tsd-kind-icon">on<wbr>Did<wbr>Trigger<wbr>Button</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#items" class="tsd-kind-icon">items</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#canSelectMany" class="tsd-kind-icon">can<wbr>Select<wbr>Many</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#matchOnDescription" class="tsd-kind-icon">match<wbr>OnDescription</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#matchOnDetail" class="tsd-kind-icon">match<wbr>OnDetail</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#activeItems" class="tsd-kind-icon">active<wbr>Items</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#onDidChangeActive" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#selectedItems" class="tsd-kind-icon">selected<wbr>Items</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="QuickPick.html#onDidChangeSelection" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Selection</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Methods（3）</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#show" class="tsd-kind-icon">show</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#hide" class="tsd-kind-icon">hide</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="QuickPick.html#dispose" class="tsd-kind-icon">dispose</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties（21）</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="title" class="tsd-anchor"></a>
<h3>title</h3>
<div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#title">title</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9886">vscode.d.ts:9886</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional title.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="step" class="tsd-anchor"></a>
<h3>step</h3>
<div class="tsd-signature tsd-kind-icon">step<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#step">step</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9891">vscode.d.ts:9891</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional current step count.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="totalSteps" class="tsd-anchor"></a>
<h3>total<wbr>Steps</h3>
<div class="tsd-signature tsd-kind-icon">total<wbr>Steps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#totalSteps">totalSteps</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9896">vscode.d.ts:9896</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional total step count.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="enabled" class="tsd-anchor"></a>
<h3>enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#enabled">enabled</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9904">vscode.d.ts:9904</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the UI should allow for user input. Defaults to true.</p>
</div>
<p>Change this to false, e.g., while validating user input or
loading data for the next step in user input.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="busy" class="tsd-anchor"></a>
<h3>busy</h3>
<div class="tsd-signature tsd-kind-icon">busy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#busy">busy</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9912">vscode.d.ts:9912</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the UI should show a progress indicator. Defaults to false.</p>
</div>
<p>Change this to true, e.g., while loading more data or validating
user input.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ignoreFocusOut" class="tsd-anchor"></a>
<h3>ignore<wbr>Focus<wbr>Out</h3>
<div class="tsd-signature tsd-kind-icon">ignore<wbr>Focus<wbr>Out<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#ignoreFocusOut">ignoreFocusOut</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9918">vscode.d.ts:9918</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the UI should stay open even when loosing UI focus. Defaults to false.
This setting is ignored on iPad and is always false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="onDidHide" class="tsd-anchor"></a>
<h3>on<wbr>Did<wbr>Hide</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Hide<span class="tsd-signature-symbol">:</span> <a href="Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#onDidHide">onDidHide</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9940">vscode.d.ts:9940</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when this input UI is hidden.</p>
</div>
<p>There are several reasons why this UI might have to be hidden and
the extension will be notified through <a href="QuickInput.html#onDidHide">QuickInput.onDidHide</a>.
(Examples include: an explicit call to <a href="QuickInput.html#hide">QuickInput.hide</a>,
the user pressing Esc, some other input UI opening, etc.)</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="value" class="tsd-anchor"></a>
<h3>value</h3>
<div class="tsd-signature tsd-kind-icon">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9966">vscode.d.ts:9966</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Current value of the filter text.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="placeholder" class="tsd-anchor"></a>
<h3>placeholder</h3>
<div class="tsd-signature tsd-kind-icon">placeholder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9971">vscode.d.ts:9971</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional placeholder in the filter text.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidChangeValue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Change<wbr>Value</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Value<span class="tsd-signature-symbol">:</span> <a href="Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9976">vscode.d.ts:9976</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when the value of the filter text has changed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidAccept" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Accept</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Accept<span class="tsd-signature-symbol">:</span> <a href="Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9981">vscode.d.ts:9981</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when the user indicated acceptance of the selected item(s).</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="buttons" class="tsd-anchor"></a>
<h3>buttons</h3>
<div class="tsd-signature tsd-kind-icon">buttons<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="QuickInputButton.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickInputButton</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/1c96e8b/vscode.d.ts#L9986">vscode.d.ts:9986</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Buttons for actions in the UI.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidTriggerButton" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Trigger<wbr>Button</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Trigger<wbr>Button<span class="tsd-signature-symbol">:</span> <a href="Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><a href="QuickInputButton.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickInputButton</a><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9991">vscode.d.ts:9991</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when a button was triggered.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="items" class="tsd-anchor"></a>
<h3>items</h3>
<div class="tsd-signature tsd-kind-icon">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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9996">vscode.d.ts:9996</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Items to pick from. This can be read and updated by the extension.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="canSelectMany" class="tsd-anchor"></a>
<h3>can<wbr>Select<wbr>Many</h3>
<div class="tsd-signature tsd-kind-icon">can<wbr>Select<wbr>Many<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L10001">vscode.d.ts:10001</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If multiple items can be selected at the same time. Defaults to false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="matchOnDescription" class="tsd-anchor"></a>
<h3>match<wbr>OnDescription</h3>
<div class="tsd-signature tsd-kind-icon">match<wbr>OnDescription<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L10006">vscode.d.ts:10006</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the filter text should also be matched against the description of the items. Defaults to false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="matchOnDetail" class="tsd-anchor"></a>
<h3>match<wbr>OnDetail</h3>
<div class="tsd-signature tsd-kind-icon">match<wbr>OnDetail<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L10011">vscode.d.ts:10011</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the filter text should also be matched against the detail of the items. Defaults to false.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="activeItems" class="tsd-anchor"></a>
<h3>active<wbr>Items</h3>
<div class="tsd-signature tsd-kind-icon">active<wbr>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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L10016">vscode.d.ts:10016</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Active items. This can be read and updated by the extension.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidChangeActive" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Change<wbr>Active</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active<span class="tsd-signature-symbol">:</span> <a href="Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L10021">vscode.d.ts:10021</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when the active items have changed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="selectedItems" class="tsd-anchor"></a>
<h3>selected<wbr>Items</h3>
<div class="tsd-signature tsd-kind-icon">selected<wbr>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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L10026">vscode.d.ts:10026</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Selected items. This can be read and updated by the extension.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="onDidChangeSelection" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Change<wbr>Selection</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Selection<span class="tsd-signature-symbol">:</span> <a href="Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</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">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L10031">vscode.d.ts:10031</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An event signaling when the selected items have changed.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Methods（3）</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a name="show" class="tsd-anchor"></a>
<h3>show</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">show<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#show">show</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9924">vscode.d.ts:9924</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Makes the input UI visible in its current configuration. Any other input
UI will first fire an <a href="QuickInput.html#onDidHide">QuickInput.onDidHide</a> event.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a name="hide" class="tsd-anchor"></a>
<h3>hide</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">hide<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#hide">hide</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9930">vscode.d.ts:9930</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Hides this input UI. This will also fire an <a href="QuickInput.html#onDidHide">QuickInput.onDidHide</a>
event.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="QuickInput.html">QuickInput</a>.<a href="QuickInput.html#dispose">dispose</a></p>
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/1c96e8b/vscode.d.ts#L9948">vscode.d.ts:9948</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dispose of this input UI and any associated resources. If it is still
visible, it is first hidden. After this call the input UI is no longer
functional and no additional methods or properties on it should be
accessed. Instead a new input UI should be created.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="QuickPick.html" class="tsd-kind-icon">Quick<wbr>Pick</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#title" class="tsd-kind-icon">title</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#step" class="tsd-kind-icon">step</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#totalSteps" class="tsd-kind-icon">total<wbr>Steps</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#busy" class="tsd-kind-icon">busy</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#ignoreFocusOut" class="tsd-kind-icon">ignore<wbr>Focus<wbr>Out</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#show" class="tsd-kind-icon">show</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#hide" class="tsd-kind-icon">hide</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#onDidHide" class="tsd-kind-icon">on<wbr>Did<wbr>Hide</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface tsd-is-inherited">
<a href="QuickPick.html#dispose" class="tsd-kind-icon">dispose</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#value" class="tsd-kind-icon">value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#placeholder" class="tsd-kind-icon">placeholder</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#onDidChangeValue" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Value</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#onDidAccept" class="tsd-kind-icon">on<wbr>Did<wbr>Accept</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#buttons" class="tsd-kind-icon">buttons</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#onDidTriggerButton" class="tsd-kind-icon">on<wbr>Did<wbr>Trigger<wbr>Button</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#items" class="tsd-kind-icon">items</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#canSelectMany" class="tsd-kind-icon">can<wbr>Select<wbr>Many</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#matchOnDescription" class="tsd-kind-icon">match<wbr>OnDescription</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#matchOnDetail" class="tsd-kind-icon">match<wbr>OnDetail</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#activeItems" class="tsd-kind-icon">active<wbr>Items</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#onDidChangeActive" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Active</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#selectedItems" class="tsd-kind-icon">selected<wbr>Items</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="QuickPick.html#onDidChangeSelection" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Selection</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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>
Reference in new issue View Git Blame Copy Permalink