Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
徽霖
Vscode
提交
060f00b1
V
Vscode
项目概览
徽霖
/
Vscode
通知
9
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
V
Vscode
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
060f00b1
编写于
3月 21, 2018
作者:
D
Daniel Imms
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update vscode-xterm.d.ts
上级
fc288d29
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
62 addition
and
21 deletion
+62
-21
src/typings/vscode-xterm.d.ts
src/typings/vscode-xterm.d.ts
+62
-21
未找到文件。
src/typings/vscode-xterm.d.ts
浏览文件 @
060f00b1
...
@@ -17,6 +17,13 @@ declare module 'vscode-xterm' {
...
@@ -17,6 +17,13 @@ declare module 'vscode-xterm' {
* An object containing start up options for the terminal.
* An object containing start up options for the terminal.
*/
*/
export
interface
ITerminalOptions
{
export
interface
ITerminalOptions
{
/**
* Whether background should support non-opaque color. It must be set before
* executing open() method and can't be changed later without excuting it again.
* Warning: Enabling this option can reduce performances somewhat.
*/
allowTransparency
?:
boolean
;
/**
/**
* A data uri of the sound to use for the bell (needs bellStyle = 'sound').
* A data uri of the sound to use for the bell (needs bellStyle = 'sound').
*/
*/
...
@@ -49,6 +56,8 @@ declare module 'vscode-xterm' {
...
@@ -49,6 +56,8 @@ declare module 'vscode-xterm' {
/**
/**
* Whether to enable the rendering of bold text.
* Whether to enable the rendering of bold text.
*
* @deprecated Use fontWeight and fontWeightBold instead.
*/
*/
enableBold
?:
boolean
;
enableBold
?:
boolean
;
...
@@ -181,8 +190,8 @@ declare module 'vscode-xterm' {
...
@@ -181,8 +190,8 @@ declare module 'vscode-xterm' {
matchIndex
?:
number
;
matchIndex
?:
number
;
/**
/**
* A callback that validates
an individual link, returning true if valid and
* A callback that validates
whether to create an individual link, pass
*
false if invalid
.
*
whether the link is valid to the callback
.
*/
*/
validationCallback
?:
(
uri
:
string
,
callback
:
(
isValid
:
boolean
)
=>
void
)
=>
void
;
validationCallback
?:
(
uri
:
string
,
callback
:
(
isValid
:
boolean
)
=>
void
)
=>
void
;
...
@@ -227,6 +236,12 @@ declare module 'vscode-xterm' {
...
@@ -227,6 +236,12 @@ declare module 'vscode-xterm' {
dispose
():
void
;
dispose
():
void
;
}
}
export
interface
IMarker
extends
IDisposable
{
readonly
id
:
number
;
readonly
isDisposed
:
boolean
;
readonly
line
:
number
;
}
export
interface
ILocalizableStrings
{
export
interface
ILocalizableStrings
{
blankLine
:
string
;
blankLine
:
string
;
promptLabel
:
string
;
promptLabel
:
string
;
...
@@ -236,7 +251,7 @@ declare module 'vscode-xterm' {
...
@@ -236,7 +251,7 @@ declare module 'vscode-xterm' {
/**
/**
* The class that represents an xterm.js terminal.
* The class that represents an xterm.js terminal.
*/
*/
export
class
Terminal
{
export
class
Terminal
implements
IEventEmitter
{
/**
/**
* The element containing the terminal.
* The element containing the terminal.
*/
*/
...
@@ -257,6 +272,12 @@ declare module 'vscode-xterm' {
...
@@ -257,6 +272,12 @@ declare module 'vscode-xterm' {
*/
*/
cols
:
number
;
cols
:
number
;
/**
* (EXPERIMENTAL) Get all markers registered against the buffer. If the alt
* buffer is active this will always return [].
*/
markers
:
IMarker
[];
/**
/**
* Natural language strings that can be localized.
* Natural language strings that can be localized.
*/
*/
...
@@ -290,7 +311,7 @@ declare module 'vscode-xterm' {
...
@@ -290,7 +311,7 @@ declare module 'vscode-xterm' {
* @param type The type of the event.
* @param type The type of the event.
* @param listener The listener.
* @param listener The listener.
*/
*/
on
(
type
:
'
data
'
,
listener
:
(
data
?:
string
)
=>
void
):
void
;
on
(
type
:
'
data
'
,
listener
:
(
...
args
:
any
[]
)
=>
void
):
void
;
/**
/**
* Registers an event listener.
* Registers an event listener.
* @param type The type of the event.
* @param type The type of the event.
...
@@ -341,6 +362,10 @@ declare module 'vscode-xterm' {
...
@@ -341,6 +362,10 @@ declare module 'vscode-xterm' {
*/
*/
off
(
type
:
'
blur
'
|
'
focus
'
|
'
linefeed
'
|
'
selection
'
|
'
data
'
|
'
key
'
|
'
keypress
'
|
'
keydown
'
|
'
refresh
'
|
'
resize
'
|
'
scroll
'
|
'
title
'
|
string
,
listener
:
(...
args
:
any
[])
=>
void
):
void
;
off
(
type
:
'
blur
'
|
'
focus
'
|
'
linefeed
'
|
'
selection
'
|
'
data
'
|
'
key
'
|
'
keypress
'
|
'
keydown
'
|
'
refresh
'
|
'
resize
'
|
'
scroll
'
|
'
title
'
|
string
,
listener
:
(...
args
:
any
[])
=>
void
):
void
;
emit
(
type
:
string
,
data
?:
any
):
void
;
addDisposableListener
(
type
:
string
,
handler
:
(...
args
:
any
[])
=>
void
):
IDisposable
;
/**
/**
* Resizes the terminal.
* Resizes the terminal.
* @param x The number of columns to resize to.
* @param x The number of columns to resize to.
...
@@ -383,7 +408,7 @@ declare module 'vscode-xterm' {
...
@@ -383,7 +408,7 @@ declare module 'vscode-xterm' {
* @param options Options for the link matcher.
* @param options Options for the link matcher.
* @return The ID of the new matcher, this can be used to deregister.
* @return The ID of the new matcher, this can be used to deregister.
*/
*/
registerLinkMatcher
(
regex
:
RegExp
,
handler
:
(
event
:
MouseEvent
,
uri
:
string
)
=>
boolean
|
void
,
options
?:
ILinkMatcherOptions
):
number
;
registerLinkMatcher
(
regex
:
RegExp
,
handler
:
(
event
:
MouseEvent
,
uri
:
string
)
=>
void
,
options
?:
ILinkMatcherOptions
):
number
;
/**
/**
* (EXPERIMENTAL) Deregisters a link matcher if it has been registered.
* (EXPERIMENTAL) Deregisters a link matcher if it has been registered.
...
@@ -391,6 +416,13 @@ declare module 'vscode-xterm' {
...
@@ -391,6 +416,13 @@ declare module 'vscode-xterm' {
*/
*/
deregisterLinkMatcher
(
matcherId
:
number
):
void
;
deregisterLinkMatcher
(
matcherId
:
number
):
void
;
/**
* (EXPERIMENTAL) Adds a marker to the normal buffer and returns it. If the
* alt buffer is active, undefined is returned.
* @param cursorYOffset The y position offset of the marker from the cursor.
*/
addMarker
(
cursorYOffset
:
number
):
IMarker
;
/**
/**
* Gets whether the terminal has an active selection.
* Gets whether the terminal has an active selection.
*/
*/
...
@@ -412,21 +444,12 @@ declare module 'vscode-xterm' {
...
@@ -412,21 +444,12 @@ declare module 'vscode-xterm' {
*/
*/
selectAll
():
void
;
selectAll
():
void
;
// /**
/**
// * Find the next instance of the term, then scroll to and select it. If it
* Selects text in the buffer between 2 lines.
// * doesn't exist, do nothing.
* @param start The 0-based line index to select from (inclusive).
// * @param term Tne search term.
* @param end The 0-based line index to select to (inclusive).
// * @return Whether a result was found.
*/
// */
selectLines
(
start
:
number
,
end
:
number
):
void
;
// findNext(term: string): boolean;
// /**
// * Find the previous instance of the term, then scroll to and select it. If it
// * doesn't exist, do nothing.
// * @param term Tne search term.
// * @return Whether a result was found.
// */
// findPrevious(term: string): boolean;
/**
/**
* Destroys the terminal and detaches it from the DOM.
* Destroys the terminal and detaches it from the DOM.
...
@@ -455,6 +478,12 @@ declare module 'vscode-xterm' {
...
@@ -455,6 +478,12 @@ declare module 'vscode-xterm' {
*/
*/
scrollToBottom
():
void
;
scrollToBottom
():
void
;
/**
* Scrolls to a line within the buffer.
* @param line The 0-based line index to scroll to.
*/
scrollToLine
(
line
:
number
):
void
;
/**
/**
* Clear the entire buffer, making the prompt line the new first line.
* Clear the entire buffer, making the prompt line the new first line.
*/
*/
...
@@ -470,7 +499,7 @@ declare module 'vscode-xterm' {
...
@@ -470,7 +499,7 @@ declare module 'vscode-xterm' {
* Retrieves an option's value from the terminal.
* Retrieves an option's value from the terminal.
* @param key The option key.
* @param key The option key.
*/
*/
getOption
(
key
:
'
bellSound
'
|
'
bellStyle
'
|
'
cursorStyle
'
|
'
fontFamily
'
|
'
termName
'
):
string
;
getOption
(
key
:
'
bellSound
'
|
'
bellStyle
'
|
'
cursorStyle
'
|
'
fontFamily
'
|
'
fontWeight
'
|
'
fontWeightBold
'
|
'
termName
'
):
string
;
/**
/**
* Retrieves an option's value from the terminal.
* Retrieves an option's value from the terminal.
* @param key The option key.
* @param key The option key.
...
@@ -503,6 +532,12 @@ declare module 'vscode-xterm' {
...
@@ -503,6 +532,12 @@ declare module 'vscode-xterm' {
* @param value The option value.
* @param value The option value.
*/
*/
setOption
(
key
:
'
fontFamily
'
|
'
termName
'
|
'
bellSound
'
,
value
:
string
):
void
;
setOption
(
key
:
'
fontFamily
'
|
'
termName
'
|
'
bellSound
'
,
value
:
string
):
void
;
/**
* Sets an option on the terminal.
* @param key The option key.
* @param value The option value.
*/
setOption
(
key
:
'
fontWeight
'
|
'
fontWeightBold
'
,
value
:
null
|
'
normal
'
|
'
bold
'
|
'
100
'
|
'
200
'
|
'
300
'
|
'
400
'
|
'
500
'
|
'
600
'
|
'
700
'
|
'
800
'
|
'
900
'
):
void
;
/**
/**
* Sets an option on the terminal.
* Sets an option on the terminal.
* @param key The option key.
* @param key The option key.
...
@@ -545,6 +580,12 @@ declare module 'vscode-xterm' {
...
@@ -545,6 +580,12 @@ declare module 'vscode-xterm' {
* @param value The option value.
* @param value The option value.
*/
*/
setOption
(
key
:
'
theme
'
,
value
:
ITheme
):
void
;
setOption
(
key
:
'
theme
'
,
value
:
ITheme
):
void
;
/**
* Sets an option on the terminal.
* @param key The option key.
* @param value The option value.
*/
setOption
(
key
:
'
cols
'
|
'
rows
'
,
value
:
number
):
void
;
/**
/**
* Sets an option on the terminal.
* Sets an option on the terminal.
* @param key The option key.
* @param key The option key.
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录