Interface SourceControl

An source control is able to provide resource states to the editor and interact with the editor in several source control related ways.

interface SourceControl {
    acceptInputCommand?: Command;
    commitTemplate?: string;
    count?: number;
    id: string;
    inputBox: SourceControlInputBox;
    label: string;
    onDidChangeSelection: Event<boolean>;
    quickDiffProvider?: QuickDiffProvider;
    rootUri: undefined | Uri;
    selected: boolean;
    statusBarCommands?: Command[];
    createResourceGroup(id, label): SourceControlResourceGroup;
    dispose(): void;
}

Properties

acceptInputCommand? commitTemplate? count? id inputBox label onDidChangeSelection quickDiffProvider? rootUri selected statusBarCommands?

Methods

createResourceGroup dispose

Properties

Optional acceptInputCommand

acceptInputCommand?: Command

Optional accept input command.

This command will be invoked when the user accepts the value in the Source Control input.

Optional commitTemplate

commitTemplate?: string

Optional commit template string.

The Source Control viewlet will populate the Source Control input with this value when appropriate.

Optional count

count?: number

The UI-visible count of resource states of this source control.

Equals to the total number of resource state of this source control, if undefined.

Readonly id

id: string

The id of this source control.

Readonly inputBox

inputBox: SourceControlInputBox

The input box for this source control.

Readonly label

label: string

The human-readable label of this source control.

Readonly onDidChangeSelection

onDidChangeSelection: Event<boolean>

An event signaling when the selection state changes.

Optional quickDiffProvider

quickDiffProvider?: QuickDiffProvider

An optional quick diff provider.

Readonly rootUri

rootUri: undefined | Uri

The (optional) Uri of the root of this source control.

Readonly selected

selected: boolean

Whether the source control is selected.

Optional statusBarCommands

statusBarCommands?: Command[]

Optional status bar commands.

These commands will be displayed in the editor's status bar.

Methods

createResourceGroup

dispose

Settings

Member Visibility

Theme

On This Page

acceptInputCommandcommitTemplatecountidinputBoxlabelonDidChangeSelectionquickDiffProviderrootUriselectedstatusBarCommandscreateResourceGroupdispose