mirror of
https://github.com/neovim/neovim.git
synced 2024-12-19 10:45:16 -07:00
docs: add check_textlock attribute
This commit is contained in:
notomo
parent
356319f356
commit
93ba977793
@ -646,6 +646,9 @@ nvim_create_namespace({name}) *nvim_create_namespace()*
|
||||
nvim_del_current_line() *nvim_del_current_line()*
|
||||
Deletes the current line.
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
nvim_del_keymap({mode}, {lhs}) *nvim_del_keymap()*
|
||||
Unmaps a global |mapping| for the given mode.
|
||||
|
||||
@ -755,6 +758,15 @@ nvim_feedkeys({keys}, {mode}, {escape_csi}) *nvim_feedkeys()*
|
||||
feedkeys()
|
||||
vim_strsave_escape_csi
|
||||
|
||||
nvim_get_all_options_info() *nvim_get_all_options_info()*
|
||||
Gets the option information for all options.
|
||||
|
||||
The dictionary has the full option names as keys and option
|
||||
metadata dictionaries as detailed at |nvim_get_option_info|.
|
||||
|
||||
Return: ~
|
||||
dictionary of all options
|
||||
|
||||
nvim_get_api_info() *nvim_get_api_info()*
|
||||
Returns a 2-tuple (Array), where item 0 is the current channel
|
||||
id and item 1 is the |api-metadata| map (Dictionary).
|
||||
@ -937,22 +949,18 @@ nvim_get_option_info({name}) *nvim_get_option_info()*
|
||||
Gets the option information for one option
|
||||
|
||||
Resulting dictionary has keys:
|
||||
• name (string): Name of the option
|
||||
• shortname (shortname): Shortened name of the option
|
||||
• type (string): Name of the type of option
|
||||
• default (Any): The default value for the option
|
||||
|
||||
Script-Related Keys:
|
||||
• was_set (bool): Whether the option was set.
|
||||
• last_set_sid (int): Last set script id
|
||||
• last_set_linenr (int): Last set script id, -1 if invalid.
|
||||
• last_set_lchan (int): Last set script id, -1 if invalid.
|
||||
|
||||
Flag-Related Keys:
|
||||
• win (bool): Window-local option
|
||||
• buf (bool): Buffer-local option
|
||||
• global_local (bool): Global or Buffer local option
|
||||
• flaglist (bool): List of single char flags
|
||||
• name: Name of the option (like 'filetype')
|
||||
• shortname: Shortened name of the option (like 'ft')
|
||||
• type: type of option ("string", "integer" or "boolean")
|
||||
• default: The default value for the option
|
||||
• was_set: Whether the option was set.
|
||||
• last_set_sid: Last set script id (if any)
|
||||
• last_set_linenr: line number where option was set
|
||||
• last_set_chan: Channel where option was set (0 for local)
|
||||
• scope: one of "global", "win", or "buf"
|
||||
• global_local: whether win or buf option has a global value
|
||||
• commalist: List of comma separated values
|
||||
• flaglist: List of single char flags
|
||||
|
||||
Parameters: ~
|
||||
{name} Option name
|
||||
@ -960,12 +968,6 @@ nvim_get_option_info({name}) *nvim_get_option_info()*
|
||||
Return: ~
|
||||
Option Information
|
||||
|
||||
nvim_get_options_info() *nvim_get_options_info()*
|
||||
Gets the option information for all options.
|
||||
|
||||
Return: ~
|
||||
Map<option_name, option_info>
|
||||
|
||||
nvim_get_proc({pid}) *nvim_get_proc()*
|
||||
Gets info describing process `pid` .
|
||||
|
||||
@ -1174,6 +1176,9 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()*
|
||||
{relative='win', width=12, height=3, bufpos={100,10}})
|
||||
<
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{buffer} Buffer to display, or 0 for current buffer
|
||||
{enter} Enter the window (make it the current window)
|
||||
@ -1352,6 +1357,9 @@ nvim_paste({data}, {crlf}, {phase}) *nvim_paste()*
|
||||
calls are ignored ("drained") until the next paste is
|
||||
initiated (phase 1 or -1).
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{data} Multiline input. May be binary (containing NUL
|
||||
bytes).
|
||||
@ -1372,6 +1380,9 @@ nvim_put({lines}, {type}, {after}, {follow}) *nvim_put()*
|
||||
|
||||
Compare |:put| and |p| which are always linewise.
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{lines} |readfile()|-style list of lines.
|
||||
|channel-lines|
|
||||
@ -1489,6 +1500,9 @@ nvim_set_client_info({name}, {version}, {type}, {methods}, {attributes})
|
||||
nvim_set_current_buf({buffer}) *nvim_set_current_buf()*
|
||||
Sets the current buffer.
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{buffer} Buffer handle
|
||||
|
||||
@ -1501,18 +1515,27 @@ nvim_set_current_dir({dir}) *nvim_set_current_dir()*
|
||||
nvim_set_current_line({line}) *nvim_set_current_line()*
|
||||
Sets the current line.
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{line} Line contents
|
||||
|
||||
nvim_set_current_tabpage({tabpage}) *nvim_set_current_tabpage()*
|
||||
Sets the current tabpage.
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{tabpage} Tabpage handle
|
||||
|
||||
nvim_set_current_win({window}) *nvim_set_current_win()*
|
||||
Sets the current window.
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{window} Window handle
|
||||
|
||||
@ -1859,6 +1882,9 @@ nvim_buf_del_var({buffer}, {name}) *nvim_buf_del_var()*
|
||||
nvim_buf_delete({buffer}, {opts}) *nvim_buf_delete()*
|
||||
Deletes the buffer. See |:bwipeout|
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{buffer} Buffer handle, or 0 for current buffer
|
||||
{opts} Optional parameters. Keys:
|
||||
@ -2155,6 +2181,9 @@ nvim_buf_set_lines({buffer}, {start}, {end}, {strict_indexing}, {replacement})
|
||||
Out-of-bounds indices are clamped to the nearest valid value,
|
||||
unless `strict_indexing` is set.
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{buffer} Buffer handle, or 0 for current buffer
|
||||
{start} First line index
|
||||
@ -2232,6 +2261,9 @@ Window Functions *api-window*
|
||||
nvim_win_close({window}, {force}) *nvim_win_close()*
|
||||
Closes the window (like |:close| with a |window-ID|).
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{window} Window handle, or 0 for current window
|
||||
{force} Behave like `:close!` The last window of a
|
||||
@ -2357,6 +2389,9 @@ nvim_win_is_valid({window}) *nvim_win_is_valid()*
|
||||
nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()*
|
||||
Sets the current buffer in a window, without side-effects
|
||||
|
||||
Attributes: ~
|
||||
not allowed when |textlock| is active
|
||||
|
||||
Parameters: ~
|
||||
{window} Window handle, or 0 for current window
|
||||
{buffer} Buffer handle
|
||||
|
||||
@ -186,6 +186,7 @@ param_exclude = (
|
||||
# Annotations are displayed as line items after API function descriptions.
|
||||
annotation_map = {
|
||||
'FUNC_API_FAST': '{fast}',
|
||||
'FUNC_API_CHECK_TEXTLOCK': 'not allowed when |textlock| is active',
|
||||
}
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user