runtime(doc): add return type info for Vim function descriptions
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
File diff suppressed because it is too large
Load Diff
@ -1,4 +1,4 @@
|
|||||||
*channel.txt* For Vim version 9.1. Last change: 2023 Aug 15
|
*channel.txt* For Vim version 9.1. Last change: 2024 Jun 06
|
||||||
|
|
||||||
|
|
||||||
VIM REFERENCE MANUAL by Bram Moolenaar
|
VIM REFERENCE MANUAL by Bram Moolenaar
|
||||||
@ -502,6 +502,8 @@ ch_canread({handle}) *ch_canread()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_canread()
|
GetChannel()->ch_canread()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
ch_close({handle}) *ch_close()*
|
ch_close({handle}) *ch_close()*
|
||||||
Close {handle}. See |channel-close|.
|
Close {handle}. See |channel-close|.
|
||||||
@ -510,6 +512,8 @@ ch_close({handle}) *ch_close()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_close()
|
GetChannel()->ch_close()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
ch_close_in({handle}) *ch_close_in()*
|
ch_close_in({handle}) *ch_close_in()*
|
||||||
Close the "in" part of {handle}. See |channel-close-in|.
|
Close the "in" part of {handle}. See |channel-close-in|.
|
||||||
@ -518,6 +522,8 @@ ch_close_in({handle}) *ch_close_in()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_close_in()
|
GetChannel()->ch_close_in()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()*
|
ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()*
|
||||||
@ -541,6 +547,8 @@ ch_evalexpr({handle}, {expr} [, {options}]) *ch_evalexpr()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_evalexpr(expr)
|
GetChannel()->ch_evalexpr(expr)
|
||||||
|
<
|
||||||
|
Return type: dict<any> or |String|
|
||||||
|
|
||||||
|
|
||||||
ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*
|
ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*
|
||||||
@ -559,6 +567,8 @@ ch_evalraw({handle}, {string} [, {options}]) *ch_evalraw()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_evalraw(rawstring)
|
GetChannel()->ch_evalraw(rawstring)
|
||||||
|
<
|
||||||
|
Return type: dict<any> or |String|
|
||||||
|
|
||||||
ch_getbufnr({handle}, {what}) *ch_getbufnr()*
|
ch_getbufnr({handle}, {what}) *ch_getbufnr()*
|
||||||
Get the buffer number that {handle} is using for String {what}.
|
Get the buffer number that {handle} is using for String {what}.
|
||||||
@ -569,6 +579,8 @@ ch_getbufnr({handle}, {what}) *ch_getbufnr()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_getbufnr(what)
|
GetChannel()->ch_getbufnr(what)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
ch_getjob({channel}) *ch_getjob()*
|
ch_getjob({channel}) *ch_getjob()*
|
||||||
Get the Job associated with {channel}.
|
Get the Job associated with {channel}.
|
||||||
@ -577,7 +589,8 @@ ch_getjob({channel}) *ch_getjob()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_getjob()
|
GetChannel()->ch_getjob()
|
||||||
|
<
|
||||||
|
Return type: |job| or |String|
|
||||||
|
|
||||||
ch_info({handle}) *ch_info()*
|
ch_info({handle}) *ch_info()*
|
||||||
Returns a Dictionary with information about {handle}. The
|
Returns a Dictionary with information about {handle}. The
|
||||||
@ -613,7 +626,8 @@ ch_info({handle}) *ch_info()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_info()
|
GetChannel()->ch_info()
|
||||||
|
<
|
||||||
|
Return type: dict<any>
|
||||||
|
|
||||||
ch_log({msg} [, {handle}]) *ch_log()*
|
ch_log({msg} [, {handle}]) *ch_log()*
|
||||||
Write String {msg} in the channel log file, if it was opened
|
Write String {msg} in the channel log file, if it was opened
|
||||||
@ -628,7 +642,8 @@ ch_log({msg} [, {handle}]) *ch_log()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
'did something'->ch_log()
|
'did something'->ch_log()
|
||||||
|
<
|
||||||
|
Return type: dict<any>
|
||||||
|
|
||||||
ch_logfile({fname} [, {mode}]) *ch_logfile()*
|
ch_logfile({fname} [, {mode}]) *ch_logfile()*
|
||||||
Start logging channel activity to {fname}.
|
Start logging channel activity to {fname}.
|
||||||
@ -655,7 +670,8 @@ ch_logfile({fname} [, {mode}]) *ch_logfile()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
'logfile'->ch_logfile('w')
|
'logfile'->ch_logfile('w')
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
ch_open({address} [, {options}]) *ch_open()*
|
ch_open({address} [, {options}]) *ch_open()*
|
||||||
Open a channel to {address}. See |channel|.
|
Open a channel to {address}. See |channel|.
|
||||||
@ -669,7 +685,8 @@ ch_open({address} [, {options}]) *ch_open()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetAddress()->ch_open()
|
GetAddress()->ch_open()
|
||||||
|
<
|
||||||
|
Return type: |channel|
|
||||||
|
|
||||||
ch_read({handle} [, {options}]) *ch_read()*
|
ch_read({handle} [, {options}]) *ch_read()*
|
||||||
Read from {handle} and return the received message.
|
Read from {handle} and return the received message.
|
||||||
@ -680,7 +697,8 @@ ch_read({handle} [, {options}]) *ch_read()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_read()
|
GetChannel()->ch_read()
|
||||||
|
<
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
ch_readblob({handle} [, {options}]) *ch_readblob()*
|
ch_readblob({handle} [, {options}]) *ch_readblob()*
|
||||||
Like ch_read() but reads binary data and returns a |Blob|.
|
Like ch_read() but reads binary data and returns a |Blob|.
|
||||||
@ -688,7 +706,8 @@ ch_readblob({handle} [, {options}]) *ch_readblob()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_readblob()
|
GetChannel()->ch_readblob()
|
||||||
|
<
|
||||||
|
Return type: |Blob|
|
||||||
|
|
||||||
ch_readraw({handle} [, {options}]) *ch_readraw()*
|
ch_readraw({handle} [, {options}]) *ch_readraw()*
|
||||||
Like ch_read() but for a JS and JSON channel does not decode
|
Like ch_read() but for a JS and JSON channel does not decode
|
||||||
@ -698,7 +717,8 @@ ch_readraw({handle} [, {options}]) *ch_readraw()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_readraw()
|
GetChannel()->ch_readraw()
|
||||||
|
<
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*
|
ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*
|
||||||
Send {expr} over {handle}. The {expr} is encoded
|
Send {expr} over {handle}. The {expr} is encoded
|
||||||
@ -720,6 +740,8 @@ ch_sendexpr({handle}, {expr} [, {options}]) *ch_sendexpr()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_sendexpr(expr)
|
GetChannel()->ch_sendexpr(expr)
|
||||||
|
<
|
||||||
|
Return type: dict<any> or |String|
|
||||||
|
|
||||||
|
|
||||||
ch_sendraw({handle}, {expr} [, {options}]) *ch_sendraw()*
|
ch_sendraw({handle}, {expr} [, {options}]) *ch_sendraw()*
|
||||||
@ -733,7 +755,8 @@ ch_sendraw({handle}, {expr} [, {options}]) *ch_sendraw()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_sendraw(rawexpr)
|
GetChannel()->ch_sendraw(rawexpr)
|
||||||
|
<
|
||||||
|
Return type: dict<any> or |String|
|
||||||
|
|
||||||
ch_setoptions({handle}, {options}) *ch_setoptions()*
|
ch_setoptions({handle}, {options}) *ch_setoptions()*
|
||||||
Set options on {handle}:
|
Set options on {handle}:
|
||||||
@ -751,7 +774,8 @@ ch_setoptions({handle}, {options}) *ch_setoptions()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_setoptions(options)
|
GetChannel()->ch_setoptions(options)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
ch_status({handle} [, {options}]) *ch_status()*
|
ch_status({handle} [, {options}]) *ch_status()*
|
||||||
Return the status of {handle}:
|
Return the status of {handle}:
|
||||||
@ -770,6 +794,8 @@ ch_status({handle} [, {options}]) *ch_status()*
|
|||||||
<
|
<
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetChannel()->ch_status()
|
GetChannel()->ch_status()
|
||||||
|
<
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
9. Starting a job with a channel *job-start* *job*
|
9. Starting a job with a channel *job-start* *job*
|
||||||
@ -900,6 +926,8 @@ job_getchannel({job}) *job_getchannel()*
|
|||||||
<
|
<
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetJob()->job_getchannel()
|
GetJob()->job_getchannel()
|
||||||
|
<
|
||||||
|
Return type: |channel|
|
||||||
|
|
||||||
job_info([{job}]) *job_info()*
|
job_info([{job}]) *job_info()*
|
||||||
Returns a Dictionary with information about {job}:
|
Returns a Dictionary with information about {job}:
|
||||||
@ -927,6 +955,9 @@ job_info([{job}]) *job_info()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetJob()->job_info()
|
GetJob()->job_info()
|
||||||
|
<
|
||||||
|
Return type: dict<any> or list<any> depending on whether {job}
|
||||||
|
was given
|
||||||
|
|
||||||
|
|
||||||
job_setoptions({job}, {options}) *job_setoptions()*
|
job_setoptions({job}, {options}) *job_setoptions()*
|
||||||
@ -936,6 +967,8 @@ job_setoptions({job}, {options}) *job_setoptions()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetJob()->job_setoptions(options)
|
GetJob()->job_setoptions(options)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
job_start({command} [, {options}]) *job_start()*
|
job_start({command} [, {options}]) *job_start()*
|
||||||
@ -997,6 +1030,8 @@ job_start({command} [, {options}]) *job_start()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
BuildCommand()->job_start()
|
BuildCommand()->job_start()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
job_status({job}) *job_status()* *E916*
|
job_status({job}) *job_status()* *E916*
|
||||||
@ -1020,6 +1055,8 @@ job_status({job}) *job_status()* *E916*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetJob()->job_status()
|
GetJob()->job_status()
|
||||||
|
<
|
||||||
|
Return type: |job|
|
||||||
|
|
||||||
|
|
||||||
job_stop({job} [, {how}]) *job_stop()*
|
job_stop({job} [, {how}]) *job_stop()*
|
||||||
@ -1066,6 +1103,8 @@ job_stop({job} [, {how}]) *job_stop()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetJob()->job_stop()
|
GetJob()->job_stop()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
*popup.txt* For Vim version 9.1. Last change: 2022 Oct 07
|
*popup.txt* For Vim version 9.1. Last change: 2024 Jun 08
|
||||||
|
|
||||||
|
|
||||||
VIM REFERENCE MANUAL by Bram Moolenaar
|
VIM REFERENCE MANUAL by Bram Moolenaar
|
||||||
@ -219,6 +219,8 @@ popup_atcursor({what}, {options}) *popup_atcursor()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetText()->popup_atcursor({})
|
GetText()->popup_atcursor({})
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_beval({what}, {options}) *popup_beval()*
|
popup_beval({what}, {options}) *popup_beval()*
|
||||||
@ -237,6 +239,8 @@ popup_beval({what}, {options}) *popup_beval()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetText()->popup_beval({})
|
GetText()->popup_beval({})
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
*popup_clear()*
|
*popup_clear()*
|
||||||
popup_clear([{force}])
|
popup_clear([{force}])
|
||||||
Emergency solution to a misbehaving plugin: close all popup
|
Emergency solution to a misbehaving plugin: close all popup
|
||||||
@ -248,6 +252,8 @@ popup_clear([{force}])
|
|||||||
when it is the current window. If a terminal is running in a
|
when it is the current window. If a terminal is running in a
|
||||||
popup it is killed.
|
popup it is killed.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_close({id} [, {result}]) *popup_close()*
|
popup_close({id} [, {result}]) *popup_close()*
|
||||||
Close popup {id}. The window and the associated buffer will
|
Close popup {id}. The window and the associated buffer will
|
||||||
@ -260,6 +266,8 @@ popup_close({id} [, {result}]) *popup_close()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPopup()->popup_close()
|
GetPopup()->popup_close()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_create({what}, {options}) *popup_create()*
|
popup_create({what}, {options}) *popup_create()*
|
||||||
@ -290,6 +298,8 @@ popup_create({what}, {options}) *popup_create()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetText()->popup_create({})
|
GetText()->popup_create({})
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_dialog({what}, {options}) *popup_dialog()*
|
popup_dialog({what}, {options}) *popup_dialog()*
|
||||||
@ -314,6 +324,8 @@ popup_dialog({what}, {options}) *popup_dialog()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetText()->popup_dialog({})
|
GetText()->popup_dialog({})
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_filter_menu({id}, {key}) *popup_filter_menu()*
|
popup_filter_menu({id}, {key}) *popup_filter_menu()*
|
||||||
@ -336,6 +348,8 @@ popup_filter_menu({id}, {key}) *popup_filter_menu()*
|
|||||||
To add shortcut keys, see the example here:
|
To add shortcut keys, see the example here:
|
||||||
|popup_menu-shortcut-example|
|
|popup_menu-shortcut-example|
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_filter_yesno({id}, {key}) *popup_filter_yesno()*
|
popup_filter_yesno({id}, {key}) *popup_filter_yesno()*
|
||||||
Filter that can be used for a popup. It handles only the keys
|
Filter that can be used for a popup. It handles only the keys
|
||||||
@ -346,12 +360,16 @@ popup_filter_yesno({id}, {key}) *popup_filter_yesno()*
|
|||||||
keys are ignored.
|
keys are ignored.
|
||||||
See the example here: |popup_dialog-example|
|
See the example here: |popup_dialog-example|
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_findecho() *popup_findecho()*
|
popup_findecho() *popup_findecho()*
|
||||||
Get the |window-ID| for the popup that shows messages for the
|
Get the |window-ID| for the popup that shows messages for the
|
||||||
`:echowindow` command. Return zero if there is none.
|
`:echowindow` command. Return zero if there is none.
|
||||||
Mainly useful to hide the popup.
|
Mainly useful to hide the popup.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_findinfo() *popup_findinfo()*
|
popup_findinfo() *popup_findinfo()*
|
||||||
Get the |window-ID| for the popup info window, as it used by
|
Get the |window-ID| for the popup info window, as it used by
|
||||||
@ -361,11 +379,16 @@ popup_findinfo() *popup_findinfo()*
|
|||||||
the item in the popup menu.
|
the item in the popup menu.
|
||||||
Returns zero if there is none.
|
Returns zero if there is none.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_findpreview() *popup_findpreview()*
|
popup_findpreview() *popup_findpreview()*
|
||||||
Get the |window-ID| for the popup preview window.
|
Get the |window-ID| for the popup preview window.
|
||||||
Return zero if there is none.
|
Return zero if there is none.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_getoptions({id}) *popup_getoptions()*
|
popup_getoptions({id}) *popup_getoptions()*
|
||||||
Return the {options} for popup {id} in a Dict.
|
Return the {options} for popup {id} in a Dict.
|
||||||
A zero value means the option was not set. For "zindex" the
|
A zero value means the option was not set. For "zindex" the
|
||||||
@ -399,6 +422,8 @@ popup_getoptions({id}) *popup_getoptions()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPopup()->popup_getoptions()
|
GetPopup()->popup_getoptions()
|
||||||
|
<
|
||||||
|
Return type: dict<any>
|
||||||
|
|
||||||
|
|
||||||
popup_getpos({id}) *popup_getpos()*
|
popup_getpos({id}) *popup_getpos()*
|
||||||
@ -428,6 +453,8 @@ popup_getpos({id}) *popup_getpos()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPopup()->popup_getpos()
|
GetPopup()->popup_getpos()
|
||||||
|
<
|
||||||
|
Return type: dict<number> or dict<any>
|
||||||
|
|
||||||
|
|
||||||
popup_hide({id}) *popup_hide()*
|
popup_hide({id}) *popup_hide()*
|
||||||
@ -440,11 +467,15 @@ popup_hide({id}) *popup_hide()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPopup()->popup_hide()
|
GetPopup()->popup_hide()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_list() *popup_list()*
|
popup_list() *popup_list()*
|
||||||
Return a List with the |window-ID| of all existing popups.
|
Return a List with the |window-ID| of all existing popups.
|
||||||
|
|
||||||
|
Return type: list<number> or list<any>
|
||||||
|
|
||||||
|
|
||||||
popup_locate({row}, {col}) *popup_locate()*
|
popup_locate({row}, {col}) *popup_locate()*
|
||||||
Return the |window-ID| of the popup at screen position {row}
|
Return the |window-ID| of the popup at screen position {row}
|
||||||
@ -452,6 +483,8 @@ popup_locate({row}, {col}) *popup_locate()*
|
|||||||
highest zindex is returned. If there are no popups at this
|
highest zindex is returned. If there are no popups at this
|
||||||
position then zero is returned.
|
position then zero is returned.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_menu({what}, {options}) *popup_menu()*
|
popup_menu({what}, {options}) *popup_menu()*
|
||||||
Show the {what} near the cursor, handle selecting one of the
|
Show the {what} near the cursor, handle selecting one of the
|
||||||
@ -484,6 +517,8 @@ popup_menu({what}, {options}) *popup_menu()*
|
|||||||
|
|
||||||
< Can also be used as a |method|: >
|
< Can also be used as a |method|: >
|
||||||
GetChoices()->popup_menu({})
|
GetChoices()->popup_menu({})
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_move({id}, {options}) *popup_move()*
|
popup_move({id}, {options}) *popup_move()*
|
||||||
@ -503,6 +538,8 @@ popup_move({id}, {options}) *popup_move()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPopup()->popup_move(options)
|
GetPopup()->popup_move(options)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_notification({what}, {options}) *popup_notification()*
|
popup_notification({what}, {options}) *popup_notification()*
|
||||||
@ -533,6 +570,8 @@ popup_notification({what}, {options}) *popup_notification()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetText()->popup_notification({})
|
GetText()->popup_notification({})
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_setoptions({id}, {options}) *popup_setoptions()*
|
popup_setoptions({id}, {options}) *popup_setoptions()*
|
||||||
@ -569,6 +608,8 @@ popup_setoptions({id}, {options}) *popup_setoptions()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPopup()->popup_setoptions(options)
|
GetPopup()->popup_setoptions(options)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_settext({id}, {text}) *popup_settext()*
|
popup_settext({id}, {text}) *popup_settext()*
|
||||||
@ -580,6 +621,8 @@ popup_settext({id}, {text}) *popup_settext()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPopup()->popup_settext('hello')
|
GetPopup()->popup_settext('hello')
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
popup_show({id}) *popup_show()*
|
popup_show({id}) *popup_show()*
|
||||||
@ -588,6 +631,8 @@ popup_show({id}) *popup_show()*
|
|||||||
If {id} is the info popup it will be positioned next to the
|
If {id} is the info popup it will be positioned next to the
|
||||||
current popup menu item.
|
current popup menu item.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
3. Usage *popup-usage*
|
3. Usage *popup-usage*
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
*sign.txt* For Vim version 9.1. Last change: 2023 Feb 21
|
*sign.txt* For Vim version 9.1. Last change: 2024 Jun 08
|
||||||
|
|
||||||
|
|
||||||
VIM REFERENCE MANUAL by Gordon Prieur
|
VIM REFERENCE MANUAL by Gordon Prieur
|
||||||
@ -435,6 +435,9 @@ sign_define({list})
|
|||||||
<
|
<
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetSignList()->sign_define()
|
GetSignList()->sign_define()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
sign_getdefined([{name}]) *sign_getdefined()*
|
sign_getdefined([{name}]) *sign_getdefined()*
|
||||||
Get a list of defined signs and their attributes.
|
Get a list of defined signs and their attributes.
|
||||||
@ -473,6 +476,9 @@ sign_getdefined([{name}]) *sign_getdefined()*
|
|||||||
<
|
<
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetSignList()->sign_getdefined()
|
GetSignList()->sign_getdefined()
|
||||||
|
<
|
||||||
|
Return type: list<dict<string>> or list<any>
|
||||||
|
|
||||||
|
|
||||||
sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
|
sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
|
||||||
Return a list of signs placed in a buffer or all the buffers.
|
Return a list of signs placed in a buffer or all the buffers.
|
||||||
@ -537,8 +543,10 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufname()->sign_getplaced()
|
GetBufname()->sign_getplaced()
|
||||||
<
|
<
|
||||||
*sign_jump()*
|
Return type: list<dict<any>>
|
||||||
sign_jump({id}, {group}, {buf})
|
|
||||||
|
|
||||||
|
sign_jump({id}, {group}, {buf}) *sign_jump()*
|
||||||
Open the buffer {buf} or jump to the window that contains
|
Open the buffer {buf} or jump to the window that contains
|
||||||
{buf} and position the cursor at sign {id} in group {group}.
|
{buf} and position the cursor at sign {id} in group {group}.
|
||||||
This is similar to the |:sign-jump| command.
|
This is similar to the |:sign-jump| command.
|
||||||
@ -556,6 +564,9 @@ sign_jump({id}, {group}, {buf})
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetSignid()->sign_jump()
|
GetSignid()->sign_jump()
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
*sign_place()*
|
*sign_place()*
|
||||||
sign_place({id}, {group}, {name}, {buf} [, {dict}])
|
sign_place({id}, {group}, {name}, {buf} [, {dict}])
|
||||||
Place the sign defined as {name} at line {lnum} in file or
|
Place the sign defined as {name} at line {lnum} in file or
|
||||||
@ -608,8 +619,10 @@ sign_place({id}, {group}, {name}, {buf} [, {dict}])
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetSignid()->sign_place(group, name, expr)
|
GetSignid()->sign_place(group, name, expr)
|
||||||
<
|
<
|
||||||
*sign_placelist()*
|
Return type: |Number|
|
||||||
sign_placelist({list})
|
|
||||||
|
|
||||||
|
sign_placelist({list}) *sign_placelist()*
|
||||||
Place one or more signs. This is similar to the
|
Place one or more signs. This is similar to the
|
||||||
|sign_place()| function. The {list} argument specifies the
|
|sign_place()| function. The {list} argument specifies the
|
||||||
List of signs to place. Each list item is a dict with the
|
List of signs to place. Each list item is a dict with the
|
||||||
@ -669,6 +682,9 @@ sign_placelist({list})
|
|||||||
<
|
<
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetSignlist()->sign_placelist()
|
GetSignlist()->sign_placelist()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
sign_undefine([{name}]) *sign_undefine()*
|
sign_undefine([{name}]) *sign_undefine()*
|
||||||
sign_undefine({list})
|
sign_undefine({list})
|
||||||
@ -695,6 +711,9 @@ sign_undefine({list})
|
|||||||
<
|
<
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetSignlist()->sign_undefine()
|
GetSignlist()->sign_undefine()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
sign_unplace({group} [, {dict}]) *sign_unplace()*
|
sign_unplace({group} [, {dict}]) *sign_unplace()*
|
||||||
Remove a previously placed sign in one or more buffers. This
|
Remove a previously placed sign in one or more buffers. This
|
||||||
@ -741,6 +760,9 @@ sign_unplace({group} [, {dict}]) *sign_unplace()*
|
|||||||
< Can also be used as a |method|: >
|
< Can also be used as a |method|: >
|
||||||
GetSigngroup()->sign_unplace()
|
GetSigngroup()->sign_unplace()
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
sign_unplacelist({list}) *sign_unplacelist()*
|
sign_unplacelist({list}) *sign_unplacelist()*
|
||||||
Remove previously placed signs from one or more buffers. This
|
Remove previously placed signs from one or more buffers. This
|
||||||
is similar to the |sign_unplace()| function.
|
is similar to the |sign_unplace()| function.
|
||||||
@ -772,5 +794,6 @@ sign_unplacelist({list}) *sign_unplacelist()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetSignlist()->sign_unplacelist()
|
GetSignlist()->sign_unplacelist()
|
||||||
<
|
<
|
||||||
|
Return type: list<number> or list<any>
|
||||||
|
|
||||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||||
|
|||||||
@ -10695,6 +10695,7 @@ text-objects motion.txt /*text-objects*
|
|||||||
text-objects-changed version5.txt /*text-objects-changed*
|
text-objects-changed version5.txt /*text-objects-changed*
|
||||||
text-prop-changes textprop.txt /*text-prop-changes*
|
text-prop-changes textprop.txt /*text-prop-changes*
|
||||||
text-prop-functions textprop.txt /*text-prop-functions*
|
text-prop-functions textprop.txt /*text-prop-functions*
|
||||||
|
text-prop-functions-details textprop.txt /*text-prop-functions-details*
|
||||||
text-prop-intro textprop.txt /*text-prop-intro*
|
text-prop-intro textprop.txt /*text-prop-intro*
|
||||||
text-properties textprop.txt /*text-properties*
|
text-properties textprop.txt /*text-properties*
|
||||||
text-property-functions usr_41.txt /*text-property-functions*
|
text-property-functions usr_41.txt /*text-property-functions*
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
*terminal.txt* For Vim version 9.1. Last change: 2024 Jun 05
|
*terminal.txt* For Vim version 9.1. Last change: 2024 Jun 08
|
||||||
|
|
||||||
|
|
||||||
VIM REFERENCE MANUAL by Bram Moolenaar
|
VIM REFERENCE MANUAL by Bram Moolenaar
|
||||||
@ -536,8 +536,10 @@ term_dumpdiff({filename}, {filename} [, {options}])
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetFilename()->term_dumpdiff(otherfile)
|
GetFilename()->term_dumpdiff(otherfile)
|
||||||
<
|
<
|
||||||
*term_dumpload()*
|
Return type: |Number|
|
||||||
term_dumpload({filename} [, {options}])
|
|
||||||
|
|
||||||
|
term_dumpload({filename} [, {options}]) *term_dumpload()*
|
||||||
Open a new window displaying the contents of {filename}
|
Open a new window displaying the contents of {filename}
|
||||||
The file must have been created with |term_dumpwrite()|.
|
The file must have been created with |term_dumpwrite()|.
|
||||||
Returns the buffer number or zero when it fails.
|
Returns the buffer number or zero when it fails.
|
||||||
@ -548,8 +550,10 @@ term_dumpload({filename} [, {options}])
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetFilename()->term_dumpload()
|
GetFilename()->term_dumpload()
|
||||||
<
|
<
|
||||||
*term_dumpwrite()*
|
Return type: |Number|
|
||||||
term_dumpwrite({buf}, {filename} [, {options}])
|
|
||||||
|
|
||||||
|
term_dumpwrite({buf}, {filename} [, {options}]) *term_dumpwrite()*
|
||||||
Dump the contents of the terminal screen of {buf} in the file
|
Dump the contents of the terminal screen of {buf} in the file
|
||||||
{filename}. This uses a format that can be used with
|
{filename}. This uses a format that can be used with
|
||||||
|term_dumpload()| and |term_dumpdiff()|.
|
|term_dumpload()| and |term_dumpdiff()|.
|
||||||
@ -565,6 +569,9 @@ term_dumpwrite({buf}, {filename} [, {options}])
|
|||||||
Can also be used as a |method|, the base is used for the file
|
Can also be used as a |method|, the base is used for the file
|
||||||
name: >
|
name: >
|
||||||
GetFilename()->term_dumpwrite(bufnr)
|
GetFilename()->term_dumpwrite(bufnr)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_getaltscreen({buf}) *term_getaltscreen()*
|
term_getaltscreen({buf}) *term_getaltscreen()*
|
||||||
Returns 1 if the terminal of {buf} is using the alternate
|
Returns 1 if the terminal of {buf} is using the alternate
|
||||||
@ -573,6 +580,8 @@ term_getaltscreen({buf}) *term_getaltscreen()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getaltscreen()
|
GetBufnr()->term_getaltscreen()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_getansicolors({buf}) *term_getansicolors()*
|
term_getansicolors({buf}) *term_getansicolors()*
|
||||||
@ -587,8 +596,10 @@ term_getansicolors({buf}) *term_getansicolors()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getansicolors()
|
GetBufnr()->term_getansicolors()
|
||||||
|
<
|
||||||
|
Return type: list<string> or list<any>
|
||||||
|
|
||||||
< {only available when compiled with GUI enabled and/or the
|
{only available when compiled with GUI enabled and/or the
|
||||||
|+termguicolors| feature}
|
|+termguicolors| feature}
|
||||||
|
|
||||||
term_getattr({attr}, {what}) *term_getattr()*
|
term_getattr({attr}, {what}) *term_getattr()*
|
||||||
@ -602,6 +613,8 @@ term_getattr({attr}, {what}) *term_getattr()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetAttr()->term_getattr()
|
GetAttr()->term_getattr()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_getcursor({buf}) *term_getcursor()*
|
term_getcursor({buf}) *term_getcursor()*
|
||||||
@ -627,6 +640,9 @@ term_getcursor({buf}) *term_getcursor()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getcursor()
|
GetBufnr()->term_getcursor()
|
||||||
|
<
|
||||||
|
Return type: list<any>
|
||||||
|
|
||||||
|
|
||||||
term_getjob({buf}) *term_getjob()*
|
term_getjob({buf}) *term_getjob()*
|
||||||
Get the Job associated with terminal window {buf}.
|
Get the Job associated with terminal window {buf}.
|
||||||
@ -635,6 +651,8 @@ term_getjob({buf}) *term_getjob()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getjob()
|
GetBufnr()->term_getjob()
|
||||||
|
<
|
||||||
|
Return type: |job|
|
||||||
|
|
||||||
|
|
||||||
term_getline({buf}, {row}) *term_getline()*
|
term_getline({buf}, {row}) *term_getline()*
|
||||||
@ -649,6 +667,8 @@ term_getline({buf}, {row}) *term_getline()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getline(row)
|
GetBufnr()->term_getline(row)
|
||||||
|
<
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
|
|
||||||
term_getscrolled({buf}) *term_getscrolled()*
|
term_getscrolled({buf}) *term_getscrolled()*
|
||||||
@ -664,6 +684,8 @@ term_getscrolled({buf}) *term_getscrolled()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getscrolled()
|
GetBufnr()->term_getscrolled()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_getsize({buf}) *term_getsize()*
|
term_getsize({buf}) *term_getsize()*
|
||||||
@ -677,6 +699,8 @@ term_getsize({buf}) *term_getsize()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getsize()
|
GetBufnr()->term_getsize()
|
||||||
|
<
|
||||||
|
Return type: list<number> or list<any>
|
||||||
|
|
||||||
|
|
||||||
term_getstatus({buf}) *term_getstatus()*
|
term_getstatus({buf}) *term_getstatus()*
|
||||||
@ -693,6 +717,8 @@ term_getstatus({buf}) *term_getstatus()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_getstatus()
|
GetBufnr()->term_getstatus()
|
||||||
|
<
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
|
|
||||||
term_gettitle({buf}) *term_gettitle()*
|
term_gettitle({buf}) *term_gettitle()*
|
||||||
@ -705,6 +731,8 @@ term_gettitle({buf}) *term_gettitle()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_gettitle()
|
GetBufnr()->term_gettitle()
|
||||||
|
<
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
|
|
||||||
term_gettty({buf} [, {input}]) *term_gettty()*
|
term_gettty({buf} [, {input}]) *term_gettty()*
|
||||||
@ -717,12 +745,16 @@ term_gettty({buf} [, {input}]) *term_gettty()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_gettty()
|
GetBufnr()->term_gettty()
|
||||||
|
<
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
|
|
||||||
term_list() *term_list()*
|
term_list() *term_list()*
|
||||||
Return a list with the buffer numbers of all buffers for
|
Return a list with the buffer numbers of all buffers for
|
||||||
terminal windows.
|
terminal windows.
|
||||||
|
|
||||||
|
Return type: list<number> or list<any>
|
||||||
|
|
||||||
|
|
||||||
term_scrape({buf}, {row}) *term_scrape()*
|
term_scrape({buf}, {row}) *term_scrape()*
|
||||||
Get the contents of {row} of terminal screen of {buf}.
|
Get the contents of {row} of terminal screen of {buf}.
|
||||||
@ -744,6 +776,8 @@ term_scrape({buf}, {row}) *term_scrape()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_scrape(row)
|
GetBufnr()->term_scrape(row)
|
||||||
|
<
|
||||||
|
Return type: list<dict<any>> or list<any>
|
||||||
|
|
||||||
|
|
||||||
term_sendkeys({buf}, {keys}) *term_sendkeys()*
|
term_sendkeys({buf}, {keys}) *term_sendkeys()*
|
||||||
@ -755,6 +789,8 @@ term_sendkeys({buf}, {keys}) *term_sendkeys()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_sendkeys(keys)
|
GetBufnr()->term_sendkeys(keys)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_setansicolors({buf}, {colors}) *term_setansicolors()*
|
term_setansicolors({buf}, {colors}) *term_setansicolors()*
|
||||||
@ -788,8 +824,10 @@ term_setansicolors({buf}, {colors}) *term_setansicolors()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_setansicolors(colors)
|
GetBufnr()->term_setansicolors(colors)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
< {only available with GUI enabled and/or the |+termguicolors|
|
{only available with GUI enabled and/or the |+termguicolors|
|
||||||
feature}
|
feature}
|
||||||
|
|
||||||
|
|
||||||
@ -804,6 +842,8 @@ term_setapi({buf}, {expr}) *term_setapi()*
|
|||||||
|
|
||||||
When used as a method the base is used for {buf}: >
|
When used as a method the base is used for {buf}: >
|
||||||
GetBufnr()->term_setapi({expr})
|
GetBufnr()->term_setapi({expr})
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_setkill({buf}, {how}) *term_setkill()*
|
term_setkill({buf}, {how}) *term_setkill()*
|
||||||
@ -820,6 +860,8 @@ term_setkill({buf}, {how}) *term_setkill()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_setkill(how)
|
GetBufnr()->term_setkill(how)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_setrestore({buf}, {command}) *term_setrestore()*
|
term_setrestore({buf}, {command}) *term_setrestore()*
|
||||||
@ -833,6 +875,8 @@ term_setrestore({buf}, {command}) *term_setrestore()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_setrestore(command)
|
GetBufnr()->term_setrestore(command)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955*
|
term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955*
|
||||||
@ -847,6 +891,8 @@ term_setsize({buf}, {rows}, {cols}) *term_setsize()* *E955*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_setsize(rows, cols)
|
GetBufnr()->term_setsize(rows, cols)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_start({cmd} [, {options}]) *term_start()*
|
term_start({cmd} [, {options}]) *term_start()*
|
||||||
@ -922,6 +968,8 @@ term_start({cmd} [, {options}]) *term_start()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetCommand()->term_start()
|
GetCommand()->term_start()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
term_wait({buf} [, {time}]) *term_wait()*
|
term_wait({buf} [, {time}]) *term_wait()*
|
||||||
@ -932,6 +980,8 @@ term_wait({buf} [, {time}]) *term_wait()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetBufnr()->term_wait()
|
GetBufnr()->term_wait()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
3. Terminal communication *terminal-communication*
|
3. Terminal communication *terminal-communication*
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
*testing.txt* For Vim version 9.1. Last change: 2024 May 05
|
*testing.txt* For Vim version 9.1. Last change: 2024 Jun 06
|
||||||
|
|
||||||
|
|
||||||
VIM REFERENCE MANUAL by Bram Moolenaar
|
VIM REFERENCE MANUAL by Bram Moolenaar
|
||||||
@ -45,12 +45,16 @@ test_alloc_fail({id}, {countdown}, {repeat}) *test_alloc_fail()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetAllocId()->test_alloc_fail()
|
GetAllocId()->test_alloc_fail()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
test_autochdir() *test_autochdir()*
|
test_autochdir() *test_autochdir()*
|
||||||
Set a flag to enable the effect of 'autochdir' before Vim
|
Set a flag to enable the effect of 'autochdir' before Vim
|
||||||
startup has finished.
|
startup has finished.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
test_feedinput({string}) *test_feedinput()*
|
test_feedinput({string}) *test_feedinput()*
|
||||||
Characters in {string} are queued for processing as if they
|
Characters in {string} are queued for processing as if they
|
||||||
@ -59,6 +63,8 @@ test_feedinput({string}) *test_feedinput()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetText()->test_feedinput()
|
GetText()->test_feedinput()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
test_garbagecollect_now() *test_garbagecollect_now()*
|
test_garbagecollect_now() *test_garbagecollect_now()*
|
||||||
@ -69,11 +75,13 @@ test_garbagecollect_now() *test_garbagecollect_now()*
|
|||||||
This will not work when called from a :def function, because
|
This will not work when called from a :def function, because
|
||||||
variables on the stack will be freed.
|
variables on the stack will be freed.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_garbagecollect_soon() *test_garbagecollect_soon()*
|
test_garbagecollect_soon() *test_garbagecollect_soon()*
|
||||||
Set the flag to call the garbagecollector as if in the main
|
Set the flag to call the garbagecollector as if in the main
|
||||||
loop. Only to be used in tests.
|
loop. Only to be used in tests.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_getvalue({name}) *test_getvalue()*
|
test_getvalue({name}) *test_getvalue()*
|
||||||
Get the value of an internal variable. These values for
|
Get the value of an internal variable. These values for
|
||||||
@ -83,6 +91,8 @@ test_getvalue({name}) *test_getvalue()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetName()->test_getvalue()
|
GetName()->test_getvalue()
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
*test_gui_event()*
|
*test_gui_event()*
|
||||||
test_gui_event({event}, {args})
|
test_gui_event({event}, {args})
|
||||||
Generate a GUI {event} with arguments {args} for testing Vim
|
Generate a GUI {event} with arguments {args} for testing Vim
|
||||||
@ -212,6 +222,8 @@ test_gui_event({event}, {args})
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetEvent()->test_gui_event({args})
|
GetEvent()->test_gui_event({args})
|
||||||
<
|
<
|
||||||
|
Return type: |vim9-boolean|
|
||||||
|
|
||||||
test_ignore_error({expr}) *test_ignore_error()*
|
test_ignore_error({expr}) *test_ignore_error()*
|
||||||
Ignore any error containing {expr}. A normal message is given
|
Ignore any error containing {expr}. A normal message is given
|
||||||
instead.
|
instead.
|
||||||
@ -224,7 +236,8 @@ test_ignore_error({expr}) *test_ignore_error()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetErrorText()->test_ignore_error()
|
GetErrorText()->test_ignore_error()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_mswin_event({event}, {args}) *test_mswin_event()*
|
test_mswin_event({event}, {args}) *test_mswin_event()*
|
||||||
Generate a low-level MS-Windows {event} with arguments {args}
|
Generate a low-level MS-Windows {event} with arguments {args}
|
||||||
@ -307,40 +320,49 @@ test_mswin_event({event}, {args}) *test_mswin_event()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetEvent()->test_mswin_event({args})
|
GetEvent()->test_mswin_event({args})
|
||||||
<
|
<
|
||||||
|
Return type: |vim9-boolean|
|
||||||
|
|
||||||
test_null_blob() *test_null_blob()*
|
test_null_blob() *test_null_blob()*
|
||||||
Return a |Blob| that is null. Only useful for testing.
|
Return a |Blob| that is null. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: |Blob|
|
||||||
|
|
||||||
test_null_channel() *test_null_channel()*
|
test_null_channel() *test_null_channel()*
|
||||||
Return a |Channel| that is null. Only useful for testing.
|
Return a |Channel| that is null. Only useful for testing.
|
||||||
{only available when compiled with the +channel feature}
|
{only available when compiled with the +channel feature}
|
||||||
|
|
||||||
|
Return type: |Channel|
|
||||||
|
|
||||||
test_null_dict() *test_null_dict()*
|
test_null_dict() *test_null_dict()*
|
||||||
Return a |Dict| that is null. Only useful for testing.
|
Return a |Dict| that is null. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: dict<any>
|
||||||
|
|
||||||
test_null_function() *test_null_function()*
|
test_null_function() *test_null_function()*
|
||||||
Return a |Funcref| that is null. Only useful for testing.
|
Return a |Funcref| that is null. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: func(...): unknown
|
||||||
|
|
||||||
test_null_job() *test_null_job()*
|
test_null_job() *test_null_job()*
|
||||||
Return a |Job| that is null. Only useful for testing.
|
Return a |Job| that is null. Only useful for testing.
|
||||||
{only available when compiled with the +job feature}
|
{only available when compiled with the +job feature}
|
||||||
|
|
||||||
|
Return type: |job|
|
||||||
|
|
||||||
test_null_list() *test_null_list()*
|
test_null_list() *test_null_list()*
|
||||||
Return a |List| that is null. Only useful for testing.
|
Return a |List| that is null. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: list<any>
|
||||||
|
|
||||||
test_null_partial() *test_null_partial()*
|
test_null_partial() *test_null_partial()*
|
||||||
Return a |Partial| that is null. Only useful for testing.
|
Return a |Partial| that is null. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: func(...): unknown
|
||||||
|
|
||||||
test_null_string() *test_null_string()*
|
test_null_string() *test_null_string()*
|
||||||
Return a |String| that is null. Only useful for testing.
|
Return a |String| that is null. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: |String|
|
||||||
|
|
||||||
test_option_not_set({name}) *test_option_not_set()*
|
test_option_not_set({name}) *test_option_not_set()*
|
||||||
Reset the flag that indicates option {name} was set. Thus it
|
Reset the flag that indicates option {name} was set. Thus it
|
||||||
@ -353,7 +375,8 @@ test_option_not_set({name}) *test_option_not_set()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetOptionName()->test_option_not_set()
|
GetOptionName()->test_option_not_set()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_override({name}, {val}) *test_override()*
|
test_override({name}, {val}) *test_override()*
|
||||||
Overrides certain parts of Vim's internal processing to be able
|
Overrides certain parts of Vim's internal processing to be able
|
||||||
@ -409,7 +432,8 @@ test_override({name}, {val}) *test_override()*
|
|||||||
|
|
||||||
< Can also be used as a |method|: >
|
< Can also be used as a |method|: >
|
||||||
GetOverrideVal()-> test_override('starting')
|
GetOverrideVal()-> test_override('starting')
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_refcount({expr}) *test_refcount()*
|
test_refcount({expr}) *test_refcount()*
|
||||||
Return the reference count of {expr}. When {expr} is of a
|
Return the reference count of {expr}. When {expr} is of a
|
||||||
@ -418,7 +442,8 @@ test_refcount({expr}) *test_refcount()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetVarname()->test_refcount()
|
GetVarname()->test_refcount()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_setmouse({row}, {col}) *test_setmouse()*
|
test_setmouse({row}, {col}) *test_setmouse()*
|
||||||
Set the mouse position to be used for the next mouse action.
|
Set the mouse position to be used for the next mouse action.
|
||||||
@ -426,6 +451,8 @@ test_setmouse({row}, {col}) *test_setmouse()*
|
|||||||
For example: >
|
For example: >
|
||||||
call test_setmouse(4, 20)
|
call test_setmouse(4, 20)
|
||||||
call feedkeys("\<LeftMouse>", "xt")
|
call feedkeys("\<LeftMouse>", "xt")
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
test_settime({expr}) *test_settime()*
|
test_settime({expr}) *test_settime()*
|
||||||
@ -439,20 +466,25 @@ test_settime({expr}) *test_settime()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetTime()->test_settime()
|
GetTime()->test_settime()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_srand_seed([{seed}]) *test_srand_seed()*
|
test_srand_seed([{seed}]) *test_srand_seed()*
|
||||||
When {seed} is given this sets the seed value used by
|
When {seed} is given this sets the seed value used by
|
||||||
`srand()`. When omitted the test seed is removed.
|
`srand()`. When omitted the test seed is removed.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
test_unknown() *test_unknown()*
|
test_unknown() *test_unknown()*
|
||||||
Return a value with unknown type. Only useful for testing.
|
Return a value with unknown type. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: unknown
|
||||||
|
|
||||||
test_void() *test_void()*
|
test_void() *test_void()*
|
||||||
Return a value with void type. Only useful for testing.
|
Return a value with void type. Only useful for testing.
|
||||||
|
|
||||||
|
Return type: unknown
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
3. Assert functions *assert-functions-details*
|
3. Assert functions *assert-functions-details*
|
||||||
|
|
||||||
@ -466,6 +498,7 @@ assert_beeps({cmd}) *assert_beeps()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetCmd()->assert_beeps()
|
GetCmd()->assert_beeps()
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
*assert_equal()*
|
*assert_equal()*
|
||||||
assert_equal({expected}, {actual} [, {msg}])
|
assert_equal({expected}, {actual} [, {msg}])
|
||||||
When {expected} and {actual} are not equal an error message is
|
When {expected} and {actual} are not equal an error message is
|
||||||
@ -486,6 +519,8 @@ assert_equal({expected}, {actual} [, {msg}])
|
|||||||
Can also be used as a |method|, the base is passed as the
|
Can also be used as a |method|, the base is passed as the
|
||||||
second argument: >
|
second argument: >
|
||||||
mylist->assert_equal([1, 2, 3])
|
mylist->assert_equal([1, 2, 3])
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
< *assert_equalfile()*
|
< *assert_equalfile()*
|
||||||
assert_equalfile({fname-one}, {fname-two} [, {msg}])
|
assert_equalfile({fname-one}, {fname-two} [, {msg}])
|
||||||
@ -498,6 +533,8 @@ assert_equalfile({fname-one}, {fname-two} [, {msg}])
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetLog()->assert_equalfile('expected.log')
|
GetLog()->assert_equalfile('expected.log')
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
assert_exception({error} [, {msg}]) *assert_exception()*
|
assert_exception({error} [, {msg}]) *assert_exception()*
|
||||||
When v:exception does not contain the string {error} an error
|
When v:exception does not contain the string {error} an error
|
||||||
@ -512,6 +549,7 @@ assert_exception({error} [, {msg}]) *assert_exception()*
|
|||||||
call assert_exception('E492:')
|
call assert_exception('E492:')
|
||||||
endtry
|
endtry
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
*assert_fails()*
|
*assert_fails()*
|
||||||
assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
|
assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
|
||||||
Run {cmd} and add an error message to |v:errors| if it does
|
Run {cmd} and add an error message to |v:errors| if it does
|
||||||
@ -552,6 +590,8 @@ assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetCmd()->assert_fails('E99:')
|
GetCmd()->assert_fails('E99:')
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
assert_false({actual} [, {msg}]) *assert_false()*
|
assert_false({actual} [, {msg}]) *assert_false()*
|
||||||
When {actual} is not false an error message is added to
|
When {actual} is not false an error message is added to
|
||||||
@ -565,6 +605,8 @@ assert_false({actual} [, {msg}]) *assert_false()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetResult()->assert_false()
|
GetResult()->assert_false()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()*
|
assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()*
|
||||||
This asserts number and |Float| values. When {actual} is lower
|
This asserts number and |Float| values. When {actual} is lower
|
||||||
@ -574,6 +616,8 @@ assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()*
|
|||||||
but got {actual}". When {msg} is present it is prefixed to
|
but got {actual}". When {msg} is present it is prefixed to
|
||||||
that.
|
that.
|
||||||
|
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
*assert_match()*
|
*assert_match()*
|
||||||
assert_match({pattern}, {actual} [, {msg}])
|
assert_match({pattern}, {actual} [, {msg}])
|
||||||
When {pattern} does not match {actual} an error message is
|
When {pattern} does not match {actual} an error message is
|
||||||
@ -597,6 +641,8 @@ assert_match({pattern}, {actual} [, {msg}])
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
getFile()->assert_match('foo.*')
|
getFile()->assert_match('foo.*')
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
assert_nobeep({cmd}) *assert_nobeep()*
|
assert_nobeep({cmd}) *assert_nobeep()*
|
||||||
Run {cmd} and add an error message to |v:errors| if it
|
Run {cmd} and add an error message to |v:errors| if it
|
||||||
produces a beep or visual bell.
|
produces a beep or visual bell.
|
||||||
@ -605,6 +651,8 @@ assert_nobeep({cmd}) *assert_nobeep()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetCmd()->assert_nobeep()
|
GetCmd()->assert_nobeep()
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
*assert_notequal()*
|
*assert_notequal()*
|
||||||
assert_notequal({expected}, {actual} [, {msg}])
|
assert_notequal({expected}, {actual} [, {msg}])
|
||||||
The opposite of `assert_equal()`: add an error message to
|
The opposite of `assert_equal()`: add an error message to
|
||||||
@ -613,8 +661,10 @@ assert_notequal({expected}, {actual} [, {msg}])
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
mylist->assert_notequal([1, 2, 3])
|
mylist->assert_notequal([1, 2, 3])
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
< *assert_notmatch()*
|
*assert_notmatch()*
|
||||||
assert_notmatch({pattern}, {actual} [, {msg}])
|
assert_notmatch({pattern}, {actual} [, {msg}])
|
||||||
The opposite of `assert_match()`: add an error message to
|
The opposite of `assert_match()`: add an error message to
|
||||||
|v:errors| when {pattern} matches {actual}.
|
|v:errors| when {pattern} matches {actual}.
|
||||||
@ -622,7 +672,8 @@ assert_notmatch({pattern}, {actual} [, {msg}])
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
getFile()->assert_notmatch('bar.*')
|
getFile()->assert_notmatch('bar.*')
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
assert_report({msg}) *assert_report()*
|
assert_report({msg}) *assert_report()*
|
||||||
Report a test failure directly, using String {msg}.
|
Report a test failure directly, using String {msg}.
|
||||||
@ -630,6 +681,8 @@ assert_report({msg}) *assert_report()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetMessage()->assert_report()
|
GetMessage()->assert_report()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
assert_true({actual} [, {msg}]) *assert_true()*
|
assert_true({actual} [, {msg}]) *assert_true()*
|
||||||
@ -643,5 +696,7 @@ assert_true({actual} [, {msg}]) *assert_true()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetResult()->assert_true()
|
GetResult()->assert_true()
|
||||||
<
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
*textprop.txt* For Vim version 9.1. Last change: 2023 Apr 23
|
*textprop.txt* For Vim version 9.1. Last change: 2024 Jun 08
|
||||||
|
|
||||||
|
|
||||||
VIM REFERENCE MANUAL by Bram Moolenaar
|
VIM REFERENCE MANUAL by Bram Moolenaar
|
||||||
@ -118,6 +118,8 @@ prop_list({lnum} [, {props}]) text properties in {lnum}
|
|||||||
prop_remove({props} [, {lnum} [, {lnum-end}]])
|
prop_remove({props} [, {lnum} [, {lnum-end}]])
|
||||||
remove a text property
|
remove a text property
|
||||||
|
|
||||||
|
*text-prop-functions-details*
|
||||||
|
|
||||||
*prop_add()* *E965*
|
*prop_add()* *E965*
|
||||||
prop_add({lnum}, {col}, {props})
|
prop_add({lnum}, {col}, {props})
|
||||||
Attach a text property at position {lnum}, {col}. {col} is
|
Attach a text property at position {lnum}, {col}. {col} is
|
||||||
@ -234,8 +236,10 @@ prop_add({lnum}, {col}, {props})
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetLnum()->prop_add(col, props)
|
GetLnum()->prop_add(col, props)
|
||||||
<
|
<
|
||||||
*prop_add_list()*
|
Return type: |Number|
|
||||||
prop_add_list({props}, [{item}, ...])
|
|
||||||
|
|
||||||
|
prop_add_list({props}, [{item}, ...]) *prop_add_list()*
|
||||||
Similar to prop_add(), but attaches a text property at
|
Similar to prop_add(), but attaches a text property at
|
||||||
multiple positions in a buffer.
|
multiple positions in a buffer.
|
||||||
|
|
||||||
@ -284,8 +288,10 @@ prop_clear({lnum} [, {lnum-end} [, {props}]]) *prop_clear()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetLnum()->prop_clear()
|
GetLnum()->prop_clear()
|
||||||
<
|
<
|
||||||
*prop_find()*
|
Return type: |Number|
|
||||||
prop_find({props} [, {direction}])
|
|
||||||
|
|
||||||
|
prop_find({props} [, {direction}]) *prop_find()*
|
||||||
Search for a text property as specified with {props}:
|
Search for a text property as specified with {props}:
|
||||||
id property with this ID
|
id property with this ID
|
||||||
type property with this type name
|
type property with this type name
|
||||||
@ -310,6 +316,8 @@ prop_find({props} [, {direction}])
|
|||||||
as with prop_list(), and additionally an "lnum" entry.
|
as with prop_list(), and additionally an "lnum" entry.
|
||||||
If no match is found then an empty Dict is returned.
|
If no match is found then an empty Dict is returned.
|
||||||
|
|
||||||
|
Return type: dict<any>
|
||||||
|
|
||||||
|
|
||||||
prop_list({lnum} [, {props}]) *prop_list()*
|
prop_list({lnum} [, {props}]) *prop_list()*
|
||||||
Returns a List with all the text properties in line {lnum}.
|
Returns a List with all the text properties in line {lnum}.
|
||||||
@ -380,6 +388,8 @@ prop_list({lnum} [, {props}]) *prop_list()*
|
|||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetLnum()->prop_list()
|
GetLnum()->prop_list()
|
||||||
<
|
<
|
||||||
|
Return type: list<dict<any>> or list<any>
|
||||||
|
|
||||||
*prop_remove()* *E968* *E860*
|
*prop_remove()* *E968* *E860*
|
||||||
prop_remove({props} [, {lnum} [, {lnum-end}]])
|
prop_remove({props} [, {lnum} [, {lnum-end}]])
|
||||||
Remove a matching text property from line {lnum}. When
|
Remove a matching text property from line {lnum}. When
|
||||||
@ -409,6 +419,8 @@ prop_remove({props} [, {lnum} [, {lnum-end}]])
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetProps()->prop_remove()
|
GetProps()->prop_remove()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
|
prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
|
||||||
@ -436,6 +448,9 @@ prop_type_add({name}, {props}) *prop_type_add()* *E969* *E970*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPropName()->prop_type_add(props)
|
GetPropName()->prop_type_add(props)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
prop_type_change({name}, {props}) *prop_type_change()*
|
prop_type_change({name}, {props}) *prop_type_change()*
|
||||||
Change properties of an existing text property type. If a
|
Change properties of an existing text property type. If a
|
||||||
@ -444,6 +459,9 @@ prop_type_change({name}, {props}) *prop_type_change()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPropName()->prop_type_change(props)
|
GetPropName()->prop_type_change(props)
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
prop_type_delete({name} [, {props}]) *prop_type_delete()*
|
prop_type_delete({name} [, {props}]) *prop_type_delete()*
|
||||||
Remove the text property type {name}. When text properties
|
Remove the text property type {name}. When text properties
|
||||||
@ -458,6 +476,9 @@ prop_type_delete({name} [, {props}]) *prop_type_delete()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPropName()->prop_type_delete()
|
GetPropName()->prop_type_delete()
|
||||||
|
<
|
||||||
|
Return type: |Number|
|
||||||
|
|
||||||
|
|
||||||
prop_type_get({name} [, {props}]) *prop_type_get()*
|
prop_type_get({name} [, {props}]) *prop_type_get()*
|
||||||
Returns the properties of property type {name}. This is a
|
Returns the properties of property type {name}. This is a
|
||||||
@ -471,6 +492,9 @@ prop_type_get({name} [, {props}]) *prop_type_get()*
|
|||||||
|
|
||||||
Can also be used as a |method|: >
|
Can also be used as a |method|: >
|
||||||
GetPropName()->prop_type_get()
|
GetPropName()->prop_type_get()
|
||||||
|
<
|
||||||
|
Return type: dict<any>
|
||||||
|
|
||||||
|
|
||||||
prop_type_list([{props}]) *prop_type_list()*
|
prop_type_list([{props}]) *prop_type_list()*
|
||||||
Returns a list with all property type names.
|
Returns a list with all property type names.
|
||||||
@ -478,6 +502,8 @@ prop_type_list([{props}]) *prop_type_list()*
|
|||||||
{props} can contain a "bufnr" item. When it is given, use
|
{props} can contain a "bufnr" item. When it is given, use
|
||||||
this buffer instead of the global property types.
|
this buffer instead of the global property types.
|
||||||
|
|
||||||
|
Return type: list<string> or list<any>
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
3. When text changes *text-prop-changes*
|
3. When text changes *text-prop-changes*
|
||||||
|
|||||||
Reference in New Issue
Block a user