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 '29b6897912'
${ noResults }
vscode-api-cn.js/interfaces/SourceControl.html

428 lines
22 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>SourceControl | 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>
.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="SourceControl.html">SourceControl</a>
</li>
</ul>
<h1>Interface SourceControl</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>An source control is able to provide <a href="SourceControlResourceState.html">resource states</a>
to the editor and interact with the editor in several source control related ways.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>层级</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SourceControl</span>
</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（9）</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#rootUri" class="tsd-kind-icon">root<wbr>Uri</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#inputBox" class="tsd-kind-icon">input<wbr>Box</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#count" class="tsd-kind-icon">count</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#quickDiffProvider" class="tsd-kind-icon">quick<wbr>Diff<wbr>Provider</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#commitTemplate" class="tsd-kind-icon">commit<wbr>Template</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#acceptInputCommand" class="tsd-kind-icon">accept<wbr>Input<wbr>Command</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="SourceControl.html#statusBarCommands" class="tsd-kind-icon">status<wbr>Bar<wbr>Commands</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods（2）</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="SourceControl.html#createResourceGroup" class="tsd-kind-icon">create<wbr>Resource<wbr>Group</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="SourceControl.html#dispose" class="tsd-kind-icon">dispose</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties（9）</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<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/5de4f34/vscode.d.ts#L12516">vscode.d.ts:12516</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The id of this source control.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="label" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> label</h3>
<div class="tsd-signature tsd-kind-icon">label<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/5de4f34/vscode.d.ts#L12521">vscode.d.ts:12521</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The human-readable label of this source control.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="rootUri" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> root<wbr>Uri</h3>
<div class="tsd-signature tsd-kind-icon">root<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/5de4f34/vscode.d.ts#L12526">vscode.d.ts:12526</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The (optional) Uri of the root of this source control.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="inputBox" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> input<wbr>Box</h3>
<div class="tsd-signature tsd-kind-icon">input<wbr>Box<span class="tsd-signature-symbol">:</span> <a href="SourceControlInputBox.html" class="tsd-signature-type" data-tsd-kind="Interface">SourceControlInputBox</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/5de4f34/vscode.d.ts#L12531">vscode.d.ts:12531</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The <a href="SourceControlInputBox.html">input box</a> for this source control.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="count" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> count</h3>
<div class="tsd-signature tsd-kind-icon">count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/5de4f34/vscode.d.ts#L12540">vscode.d.ts:12540</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The UI-visible count of <a href="SourceControlResourceState.html">resource states</a> of
this source control.</p>
</div>
<p>Equals to the total number of <a href="SourceControlResourceState.html">resource state</a>
of this source control, if undefined.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="quickDiffProvider" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> quick<wbr>Diff<wbr>Provider</h3>
<div class="tsd-signature tsd-kind-icon">quick<wbr>Diff<wbr>Provider<span class="tsd-signature-symbol">:</span> <a href="QuickDiffProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">QuickDiffProvider</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/5de4f34/vscode.d.ts#L12545">vscode.d.ts:12545</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional <a href="QuickDiffProvider.html">quick diff provider</a>.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="commitTemplate" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> commit<wbr>Template</h3>
<div class="tsd-signature tsd-kind-icon">commit<wbr>Template<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/5de4f34/vscode.d.ts#L12553">vscode.d.ts:12553</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional commit template string.</p>
</div>
<p>The Source Control viewlet will populate the Source Control
input with this value when appropriate.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="acceptInputCommand" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> accept<wbr>Input<wbr>Command</h3>
<div class="tsd-signature tsd-kind-icon">accept<wbr>Input<wbr>Command<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Interface">Command</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/5de4f34/vscode.d.ts#L12561">vscode.d.ts:12561</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional accept input command.</p>
</div>
<p>This command will be invoked when the user accepts the value
in the Source Control input.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="statusBarCommands" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status<wbr>Bar<wbr>Commands</h3>
<div class="tsd-signature tsd-kind-icon">status<wbr>Bar<wbr>Commands<span class="tsd-signature-symbol">:</span> <a href="Command.html" class="tsd-signature-type" data-tsd-kind="Interface">Command</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/5de4f34/vscode.d.ts#L12568">vscode.d.ts:12568</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional status bar commands.</p>
</div>
<p>These commands will be displayed in the editor&#39;s status bar.</p>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods（2）</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="createResourceGroup" class="tsd-anchor"></a>
<h3>create<wbr>Resource<wbr>Group</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">create<wbr>Resource<wbr>Group<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, label<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="SourceControlResourceGroup.html" class="tsd-signature-type" data-tsd-kind="Interface">SourceControlResourceGroup</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/5de4f34/vscode.d.ts#L12573">vscode.d.ts:12573</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Create a new <a href="SourceControlResourceGroup.html">resource group</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>
</li>
<li>
<h5>label: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="SourceControlResourceGroup.html" class="tsd-signature-type" data-tsd-kind="Interface">SourceControlResourceGroup</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="dispose" class="tsd-anchor"></a>
<h3>dispose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<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">
<ul>
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/5de4f34/vscode.d.ts#L12578">vscode.d.ts:12578</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Dispose this source control.</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">
<a href="SourceControl.html" class="tsd-kind-icon">Source<wbr>Control</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#rootUri" class="tsd-kind-icon">root<wbr>Uri</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#inputBox" class="tsd-kind-icon">input<wbr>Box</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#count" class="tsd-kind-icon">count</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#quickDiffProvider" class="tsd-kind-icon">quick<wbr>Diff<wbr>Provider</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#commitTemplate" class="tsd-kind-icon">commit<wbr>Template</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#acceptInputCommand" class="tsd-kind-icon">accept<wbr>Input<wbr>Command</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="SourceControl.html#statusBarCommands" class="tsd-kind-icon">status<wbr>Bar<wbr>Commands</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="SourceControl.html#createResourceGroup" class="tsd-kind-icon">create<wbr>Resource<wbr>Group</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="SourceControl.html#dispose" class="tsd-kind-icon">dispose</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></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></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