bingyi/vscode-extension-samples
1
0
Fork 0
mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-06-13 07:10:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update vscode.proposed.d.ts

Browse Source
This commit is contained in:
Sandeep Somavarapu
2017-06-01 10:30:02 +02:00
parent b60e9be60d
commit f271d1c015
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
tree-explorer-sample/typings/vscode.proposed.d.ts vendored
View File

@ -14,24 +14,25 @@ declare module 'vscode' {
export namespace window {
/**
* Register a [TreeDataProvider](#TreeDataProvider) for the registered view `id`.
* @param viewId View id.
* Register a [TreeDataProvider](#TreeDataProvider) for the view contributed using the extension point `views`.
* @param viewId Id of the view contributed using the extension point `views`.
* @param treeDataProvider A [TreeDataProvider](#TreeDataProvider) that provides tree data for the view
*/
export function registerTreeDataProvider<T>(viewId: string, treeDataProvider: TreeDataProvider<T>): Disposable;
}
/**
* A data provider that provides tree data for a view
* A data provider that provides tree data
*/
export interface TreeDataProvider<T> {
/**
* An optional event to signal that an element or root has changed.
* To signal that root has changed, do not pass any argument or pass `undefined` or `null`.
*/
onDidChangeTreeData?: Event<T | undefined | null>;
/**
* get [TreeItem](#TreeItem) representation of the `element`
* Get [TreeItem](#TreeItem) representation of the `element`
*
* @param element The element for which [TreeItem](#TreeItem) representation is asked for.
* @return [TreeItem](#TreeItem) representation of the element
@ -39,12 +40,12 @@ declare module 'vscode' {
getTreeItem(element: T): TreeItem | Thenable<TreeItem>;
/**
* get the children of `element` or root.
* Get the children of `element` or root if no element is passed.
*
* @param element The element from which the provider gets children for.
* @return Children of `element` or root.
* @param element The element from which the provider gets children. Can be `undefined`.
* @return Children of `element` or root if no element is passed.
*/
getChildren(element?: T): T[] | Thenable<T[]>;
getChildren(element?: T): ProviderResult<T[]>;
}
export class TreeItem {