diff options
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 389 |
1 files changed, 389 insertions, 0 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 89f218c5be..a714034e50 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -566,6 +566,7 @@ nvim_chan_send({chan}, {data}) *nvim_chan_send()* Attributes: ~ |RPC| only Lua |vim.api| only + Since: 0.5.0 Parameters: ~ • {chan} id of the channel @@ -574,6 +575,9 @@ nvim_chan_send({chan}, {data}) *nvim_chan_send()* nvim_create_buf({listed}, {scratch}) *nvim_create_buf()* Creates a new, empty, unnamed buffer. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {listed} Sets 'buflisted' • {scratch} Creates a "throwaway" |scratch-buffer| for temporary work @@ -591,12 +595,16 @@ nvim_del_current_line() *nvim_del_current_line()* Attributes: ~ not allowed when |textlock| is active + Since: 0.1.0 nvim_del_keymap({mode}, {lhs}) *nvim_del_keymap()* Unmaps a global |mapping| for the given mode. To unmap a buffer-local mapping, use |nvim_buf_del_keymap()|. + Attributes: ~ + Since: 0.4.0 + See also: ~ • |nvim_set_keymap()| @@ -606,6 +614,9 @@ nvim_del_mark({name}) *nvim_del_mark()* Note: ~ • Lowercase name (or other buffer-local mark) is an error. + Attributes: ~ + Since: 0.6.0 + Parameters: ~ • {name} Mark name @@ -619,6 +630,9 @@ nvim_del_mark({name}) *nvim_del_mark()* nvim_del_var({name}) *nvim_del_var()* Removes a global (g:) variable. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {name} Variable name @@ -629,6 +643,9 @@ nvim_echo({chunks}, {history}, {opts}) *nvim_echo()* vim.api.nvim_echo({ { 'chunk1-line1\nchunk1-line2\n' }, { 'chunk2-line1' } }, true, {}) < + Attributes: ~ + Since: 0.5.0 + Parameters: ~ • {chunks} List of `[text, hl_group]` pairs, where each is a `text` string highlighted by the (optional) name or ID `hl_group`. @@ -645,6 +662,7 @@ nvim_eval_statusline({str}, {opts}) *nvim_eval_statusline()* Attributes: ~ |api-fast| + Since: 0.6.0 Parameters: ~ • {str} Statusline string (see 'statusline'). @@ -685,6 +703,7 @@ nvim_exec_lua({code}, {args}) *nvim_exec_lua()* Attributes: ~ |RPC| only + Since: 0.5.0 Parameters: ~ • {code} Lua code to execute @@ -708,6 +727,9 @@ nvim_feedkeys({keys}, {mode}, {escape_ks}) *nvim_feedkeys()* :call nvim_feedkeys(key, 'n', v:false) < + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {keys} to be typed • {mode} behavior flags, see |feedkeys()| @@ -726,6 +748,7 @@ nvim_get_api_info() *nvim_get_api_info()* Attributes: ~ |api-fast| |RPC| only + Since: 0.1.0 Return: ~ 2-tuple `[{channel-id}, {api-metadata}]` @@ -735,6 +758,9 @@ nvim_get_chan_info({chan}) *nvim_get_chan_info()* See |nvim_list_uis()| for an example of how to get channel info. + Attributes: ~ + Since: 0.3.0 + Parameters: ~ • {chan} channel_id, or 0 for current channel @@ -767,6 +793,9 @@ nvim_get_color_by_name({name}) *nvim_get_color_by_name()* :echo nvim_get_color_by_name("#cbcbcb") < + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {name} Color name or "#rrggbb" string @@ -779,12 +808,18 @@ nvim_get_color_map() *nvim_get_color_map()* Keys are color names (e.g. "Aqua") and values are 24-bit RGB color values (e.g. 65535). + Attributes: ~ + Since: 0.1.0 + Return: ~ Map of color names and RGB values. nvim_get_context({opts}) *nvim_get_context()* Gets a map of the current editor state. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {opts} Optional parameters. • types: List of |context-types| ("regs", "jumps", "bufs", @@ -796,24 +831,36 @@ nvim_get_context({opts}) *nvim_get_context()* nvim_get_current_buf() *nvim_get_current_buf()* Gets the current buffer. + Attributes: ~ + Since: 0.1.0 + Return: ~ Buffer handle nvim_get_current_line() *nvim_get_current_line()* Gets the current line. + Attributes: ~ + Since: 0.1.0 + Return: ~ Current line string nvim_get_current_tabpage() *nvim_get_current_tabpage()* Gets the current tabpage. + Attributes: ~ + Since: 0.1.0 + Return: ~ |tab-ID| nvim_get_current_win() *nvim_get_current_win()* Gets the current window. + Attributes: ~ + Since: 0.1.0 + Return: ~ |window-ID| @@ -824,6 +871,9 @@ nvim_get_hl({ns_id}, {opts}) *nvim_get_hl()* • When the `link` attribute is defined in the highlight definition map, other attributes will not be taking effect (see |:hi-link|). + Attributes: ~ + Since: 0.9.0 + Parameters: ~ • {ns_id} Get highlight groups for namespace ns_id |nvim_get_namespaces()|. Use 0 to get global highlight groups @@ -846,9 +896,15 @@ nvim_get_hl_id_by_name({name}) *nvim_get_hl_id_by_name()* similar to |hlID()|, but allocates a new ID if not present. + Attributes: ~ + Since: 0.5.0 + nvim_get_hl_ns({opts}) *nvim_get_hl_ns()* Gets the active highlight namespace. + Attributes: ~ + Since: 0.10.0 + Parameters: ~ • {opts} Optional parameters • winid: (number) |window-ID| for retrieving a window's @@ -862,6 +918,9 @@ nvim_get_hl_ns({opts}) *nvim_get_hl_ns()* nvim_get_keymap({mode}) *nvim_get_keymap()* Gets a list of global (non-buffer-local) |mapping| definitions. + Attributes: ~ + Since: 0.2.1 + Parameters: ~ • {mode} Mode short-name ("n", "i", "v", ...) @@ -879,6 +938,9 @@ nvim_get_mark({name}, {opts}) *nvim_get_mark()* Note: ~ • Lowercase name (or other buffer-local mark) is an error. + Attributes: ~ + Since: 0.6.0 + Parameters: ~ • {name} Mark name • {opts} Optional parameters. Reserved for future use. @@ -897,6 +959,7 @@ nvim_get_mode() *nvim_get_mode()* Attributes: ~ |api-fast| + Since: 0.2.0 Return: ~ Dict { "mode": String, "blocking": Boolean } @@ -904,12 +967,18 @@ nvim_get_mode() *nvim_get_mode()* nvim_get_proc({pid}) *nvim_get_proc()* Gets info describing process `pid`. + Attributes: ~ + Since: 0.3.0 + Return: ~ Map of process properties, or NIL if process not found. nvim_get_proc_children({pid}) *nvim_get_proc_children()* Gets the immediate children of process `pid`. + Attributes: ~ + Since: 0.3.0 + Return: ~ Array of child process ids, empty if process not found. @@ -925,6 +994,7 @@ nvim_get_runtime_file({name}, {all}) *nvim_get_runtime_file()* Attributes: ~ |api-fast| + Since: 0.5.0 Parameters: ~ • {name} pattern of files to search for @@ -936,6 +1006,9 @@ nvim_get_runtime_file({name}, {all}) *nvim_get_runtime_file()* nvim_get_var({name}) *nvim_get_var()* Gets a global (g:) variable. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {name} Variable name @@ -945,6 +1018,9 @@ nvim_get_var({name}) *nvim_get_var()* nvim_get_vvar({name}) *nvim_get_vvar()* Gets a v: variable. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {name} Variable name @@ -969,6 +1045,7 @@ nvim_input({keys}) *nvim_input()* Attributes: ~ |api-fast| + Since: 0.1.0 Parameters: ~ • {keys} to be typed @@ -993,6 +1070,7 @@ nvim_input_mouse({button}, {action}, {modifier}, {grid}, {row}, {col}) Attributes: ~ |api-fast| + Since: 0.4.0 Parameters: ~ • {button} Mouse button: one of "left", "right", "middle", "wheel", @@ -1014,12 +1092,18 @@ nvim_list_bufs() *nvim_list_bufs()* Includes unlisted (unloaded/deleted) buffers, like `:ls!`. Use |nvim_buf_is_loaded()| to check if a buffer is loaded. + Attributes: ~ + Since: 0.1.0 + Return: ~ List of buffer handles nvim_list_chans() *nvim_list_chans()* Get information about all open channels. + Attributes: ~ + Since: 0.3.0 + Return: ~ Array of Dictionaries, each describing a channel with the format specified at |nvim_get_chan_info()|. @@ -1027,12 +1111,18 @@ nvim_list_chans() *nvim_list_chans()* nvim_list_runtime_paths() *nvim_list_runtime_paths()* Gets the paths contained in |runtime-search-path|. + Attributes: ~ + Since: 0.1.0 + Return: ~ List of paths nvim_list_tabpages() *nvim_list_tabpages()* Gets the current list of |tab-ID|s. + Attributes: ~ + Since: 0.1.0 + Return: ~ List of |tab-ID|s @@ -1045,6 +1135,9 @@ nvim_list_uis() *nvim_list_uis()* vim.print(vim.api.nvim_get_chan_info(vim.api.nvim_list_uis()[1].chan).client.name) < + Attributes: ~ + Since: 0.3.0 + Return: ~ Array of UI dictionaries, each with these keys: • "height" Requested height of the UI @@ -1056,12 +1149,18 @@ nvim_list_uis() *nvim_list_uis()* nvim_list_wins() *nvim_list_wins()* Gets the current list of window handles. + Attributes: ~ + Since: 0.1.0 + Return: ~ List of |window-ID|s nvim_load_context({dict}) *nvim_load_context()* Sets the current editor state from the given |context| map. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {dict} |Context| map. @@ -1093,6 +1192,7 @@ nvim_open_term({buffer}, {opts}) *nvim_open_term()* Attributes: ~ not allowed when |textlock| is active + Since: 0.5.0 Parameters: ~ • {buffer} the buffer to use (expected to be empty) @@ -1135,6 +1235,7 @@ nvim_paste({data}, {crlf}, {phase}) *nvim_paste()* Attributes: ~ not allowed when |textlock| is active + Since: 0.4.0 Parameters: ~ • {data} Multiline input. Lines break at LF ("\n"). May be binary @@ -1159,6 +1260,7 @@ nvim_put({lines}, {type}, {after}, {follow}) *nvim_put()* Attributes: ~ not allowed when |textlock| is active + Since: 0.4.0 Parameters: ~ • {lines} |readfile()|-style list of lines. |channel-lines| @@ -1176,6 +1278,9 @@ nvim_replace_termcodes({str}, {from_part}, {do_lt}, {special}) Replaces terminal codes and |keycodes| (<CR>, <Esc>, ...) in a string with the internal representation. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {str} String to be converted. • {from_part} Legacy Vim parameter. Usually true. @@ -1196,6 +1301,9 @@ nvim_select_popupmenu_item({item}, {insert}, {finish}, {opts}) in a mapping; use <Cmd> |:map-cmd| or a Lua mapping to ensure the mapping doesn't end completion mode. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {item} Index (zero-based) of the item to select. Value of -1 selects nothing and restores the original text. @@ -1220,6 +1328,7 @@ nvim_set_client_info({name}, {version}, {type}, {methods}, {attributes}) Attributes: ~ |RPC| only + Since: 0.3.0 Parameters: ~ • {name} Client short-name. Sets the `client.name` field of @@ -1272,6 +1381,7 @@ nvim_set_current_buf({buffer}) *nvim_set_current_buf()* Attributes: ~ not allowed when |textlock| is active or in the |cmdwin| + Since: 0.1.0 Parameters: ~ • {buffer} Buffer handle @@ -1279,6 +1389,9 @@ nvim_set_current_buf({buffer}) *nvim_set_current_buf()* nvim_set_current_dir({dir}) *nvim_set_current_dir()* Changes the global working directory. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {dir} Directory path @@ -1287,6 +1400,7 @@ nvim_set_current_line({line}) *nvim_set_current_line()* Attributes: ~ not allowed when |textlock| is active + Since: 0.1.0 Parameters: ~ • {line} Line contents @@ -1296,6 +1410,7 @@ nvim_set_current_tabpage({tabpage}) *nvim_set_current_tabpage()* Attributes: ~ not allowed when |textlock| is active or in the |cmdwin| + Since: 0.1.0 Parameters: ~ • {tabpage} |tab-ID| to focus @@ -1305,6 +1420,7 @@ nvim_set_current_win({window}) *nvim_set_current_win()* Attributes: ~ not allowed when |textlock| is active or in the |cmdwin| + Since: 0.1.0 Parameters: ~ • {window} |window-ID| to focus @@ -1324,6 +1440,9 @@ nvim_set_hl({ns_id}, {name}, {val}) *nvim_set_hl()* • If `link` is used in combination with other attributes; only the `link` will take effect (see |:hi-link|). + Attributes: ~ + Since: 0.5.0 + Parameters: ~ • {ns_id} Namespace id for this highlight |nvim_create_namespace()|. Use 0 to set a highlight group globally |:highlight|. @@ -1362,6 +1481,9 @@ nvim_set_hl_ns({ns_id}) *nvim_set_hl_ns()* Set active namespace for highlights defined with |nvim_set_hl()|. This can be set for a single window, see |nvim_win_set_hl_ns()|. + Attributes: ~ + Since: 0.8.0 + Parameters: ~ • {ns_id} the namespace to use @@ -1375,6 +1497,7 @@ nvim_set_hl_ns_fast({ns_id}) *nvim_set_hl_ns_fast()* Attributes: ~ |api-fast| + Since: 0.8.0 Parameters: ~ • {ns_id} the namespace to activate @@ -1395,6 +1518,9 @@ nvim_set_keymap({mode}, {lhs}, {rhs}, {opts}) *nvim_set_keymap()* nmap <nowait> <Space><NL> <Nop> < + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {mode} Mode short-name (map command prefix: "n", "i", "v", "x", …) or "!" for |:map!|, or empty string for |:map|. "ia", "ca" or @@ -1415,6 +1541,9 @@ nvim_set_keymap({mode}, {lhs}, {rhs}, {opts}) *nvim_set_keymap()* nvim_set_var({name}, {value}) *nvim_set_var()* Sets a global (g:) variable. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {name} Variable name • {value} Variable value @@ -1422,6 +1551,9 @@ nvim_set_var({name}, {value}) *nvim_set_var()* nvim_set_vvar({name}, {value}) *nvim_set_vvar()* Sets a v: variable, if it is not readonly. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {name} Variable name • {value} Variable value @@ -1430,6 +1562,9 @@ nvim_strwidth({text}) *nvim_strwidth()* Calculates the number of display cells occupied by `text`. Control characters including <Tab> count as one cell. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {text} Some text @@ -1458,6 +1593,7 @@ nvim__get_runtime({pat}, {all}, {opts}) *nvim__get_runtime()* Attributes: ~ |api-fast| + Since: 0.6.0 Parameters: ~ • {pat} pattern of files to search for @@ -1528,6 +1664,9 @@ nvim__redraw({opts}) *nvim__redraw()* Instruct Nvim to redraw various components. + Attributes: ~ + Since: 0.10.0 + Parameters: ~ • {opts} Optional parameters. • win: Target a specific |window-ID| as described below. @@ -1568,6 +1707,9 @@ nvim_call_dict_function({dict}, {fn}, {args}) On execution error: fails with Vimscript error, updates v:errmsg. + Attributes: ~ + Since: 0.3.0 + Parameters: ~ • {dict} Dict, or String evaluating to a Vimscript |self| dict • {fn} Name of the function defined on the Vimscript dict @@ -1581,6 +1723,9 @@ nvim_call_function({fn}, {args}) *nvim_call_function()* On execution error: fails with Vimscript error, updates v:errmsg. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {fn} Function to call • {args} Function arguments packed in an Array @@ -1597,6 +1742,9 @@ nvim_command({command}) *nvim_command()* a structured way before executing it, modify the result of |nvim_parse_cmd()| then pass it to |nvim_cmd()|. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {command} Ex command string @@ -1606,6 +1754,9 @@ nvim_eval({expr}) *nvim_eval()* On execution error: fails with Vimscript error, updates v:errmsg. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {expr} Vimscript expression string @@ -1621,6 +1772,9 @@ nvim_exec2({src}, {opts}) *nvim_exec2()* On execution error: fails with Vimscript error, updates v:errmsg. + Attributes: ~ + Since: 0.9.0 + Parameters: ~ • {src} Vimscript code • {opts} Optional parameters. @@ -1642,6 +1796,7 @@ nvim_parse_expression({expr}, {flags}, {highlight}) Attributes: ~ |api-fast| + Since: 0.3.0 Parameters: ~ • {expr} Expression to parse. Always treated as a single line. @@ -1721,6 +1876,9 @@ Command Functions *api-command* nvim_buf_create_user_command({buffer}, {name}, {command}, {opts}) Creates a buffer-local command |user-commands|. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer. @@ -1734,6 +1892,9 @@ nvim_buf_del_user_command({buffer}, {name}) Only commands created with |:command-buffer| or |nvim_buf_create_user_command()| can be deleted with this function. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer. • {name} Name of the command to delete. @@ -1741,6 +1902,9 @@ nvim_buf_del_user_command({buffer}, {name}) nvim_buf_get_commands({buffer}, {opts}) *nvim_buf_get_commands()* Gets a map of buffer-local |user-commands|. + Attributes: ~ + Since: 0.3.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {opts} Optional parameters. Currently not used. @@ -1765,6 +1929,9 @@ nvim_cmd({cmd}, {opts}) *nvim_cmd()* On execution error: fails with Vimscript error, updates v:errmsg. + Attributes: ~ + Since: 0.8.0 + Parameters: ~ • {cmd} Command to execute. Must be a Dict that can contain the same values as the return value of |nvim_parse_cmd()| except @@ -1794,6 +1961,9 @@ nvim_create_user_command({name}, {command}, {opts}) Hello world! < + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {name} Name of the new user command. Must begin with an uppercase letter. @@ -1839,6 +2009,9 @@ nvim_create_user_command({name}, {command}, {opts}) nvim_del_user_command({name}) *nvim_del_user_command()* Delete a user-defined command. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {name} Name of the command to delete. @@ -1847,6 +2020,9 @@ nvim_get_commands({opts}) *nvim_get_commands()* Currently only |user-commands| are supported, not builtin Ex commands. + Attributes: ~ + Since: 0.3.0 + Parameters: ~ • {opts} Optional parameters. Currently only supports {"builtin":false} @@ -1863,6 +2039,7 @@ nvim_parse_cmd({str}, {opts}) *nvim_parse_cmd()* Attributes: ~ |api-fast| + Since: 0.8.0 Parameters: ~ • {str} Command line string to parse. Cannot contain "\n". @@ -1934,6 +2111,9 @@ nvim_get_all_options_info() *nvim_get_all_options_info()* The dict has the full option names as keys and option metadata dicts as detailed at |nvim_get_option_info2()|. + Attributes: ~ + Since: 0.5.0 + Return: ~ dict of all options @@ -1962,6 +2142,9 @@ nvim_get_option_info2({name}, {opts}) *nvim_get_option_info2()* the global value information is returned. This behavior can be disabled by explicitly specifying {scope} in the {opts} table. + Attributes: ~ + Since: 0.9.0 + Parameters: ~ • {name} Option name • {opts} Optional parameters @@ -1980,6 +2163,9 @@ nvim_get_option_value({name}, {opts}) *nvim_get_option_value()* the global value is returned. Local values always correspond to the current buffer or window, unless "buf" or "win" is set in {opts}. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {name} Option name • {opts} Optional parameters @@ -2004,6 +2190,9 @@ nvim_set_option_value({name}, {value}, {opts}) Note the options {win} and {buf} cannot be used together. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {name} Option name • {value} New option value @@ -2045,6 +2234,9 @@ nvim_buf_attach({buffer}, {send_buffer}, {opts}) *nvim_buf_attach()* }) < + Attributes: ~ + Since: 0.3.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {send_buffer} True if the initial notification should contain the @@ -2125,6 +2317,7 @@ nvim_buf_call({buffer}, {fun}) *nvim_buf_call()* Attributes: ~ Lua |vim.api| only + Since: 0.5.0 Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2137,6 +2330,9 @@ nvim_buf_call({buffer}, {fun}) *nvim_buf_call()* nvim_buf_del_keymap({buffer}, {mode}, {lhs}) *nvim_buf_del_keymap()* Unmaps a buffer-local |mapping| for the given mode. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2150,6 +2346,9 @@ nvim_buf_del_mark({buffer}, {name}) *nvim_buf_del_mark()* • only deletes marks set in the buffer, if the mark is not set in the buffer it will return false. + Attributes: ~ + Since: 0.6.0 + Parameters: ~ • {buffer} Buffer to set the mark on • {name} Mark name @@ -2164,6 +2363,9 @@ nvim_buf_del_mark({buffer}, {name}) *nvim_buf_del_mark()* nvim_buf_del_var({buffer}, {name}) *nvim_buf_del_var()* Removes a buffer-scoped (b:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {name} Variable name @@ -2173,6 +2375,7 @@ nvim_buf_delete({buffer}, {opts}) *nvim_buf_delete()* Attributes: ~ not allowed when |textlock| is active or in the |cmdwin| + Since: 0.5.0 Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2185,6 +2388,7 @@ nvim_buf_detach({buffer}) *nvim_buf_detach()* Attributes: ~ |RPC| only + Since: 0.3.0 Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2200,6 +2404,9 @@ nvim_buf_detach({buffer}) *nvim_buf_detach()* nvim_buf_get_changedtick({buffer}) *nvim_buf_get_changedtick()* Gets a changed tick of a buffer + Attributes: ~ + Since: 0.2.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2209,6 +2416,9 @@ nvim_buf_get_changedtick({buffer}) *nvim_buf_get_changedtick()* nvim_buf_get_keymap({buffer}, {mode}) *nvim_buf_get_keymap()* Gets a list of buffer-local |mapping| definitions. + Attributes: ~ + Since: 0.2.1 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {mode} Mode short-name ("n", "i", "v", ...) @@ -2228,6 +2438,9 @@ nvim_buf_get_lines({buffer}, {start}, {end}, {strict_indexing}) Out-of-bounds indices are clamped to the nearest valid value, unless `strict_indexing` is set. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {start} First line index @@ -2244,6 +2457,9 @@ nvim_buf_get_mark({buffer}, {name}) *nvim_buf_get_mark()* Marks are (1,0)-indexed. |api-indexing| + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {name} Mark name @@ -2259,6 +2475,9 @@ nvim_buf_get_mark({buffer}, {name}) *nvim_buf_get_mark()* nvim_buf_get_name({buffer}) *nvim_buf_get_name()* Gets the full file name for the buffer + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2276,6 +2495,9 @@ nvim_buf_get_offset({buffer}, {index}) *nvim_buf_get_offset()* Unlike |line2byte()|, throws error for out-of-bounds indexing. Returns -1 for unloaded buffer. + Attributes: ~ + Since: 0.3.2 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {index} Line index @@ -2296,6 +2518,9 @@ nvim_buf_get_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col}, Prefer |nvim_buf_get_lines()| when retrieving entire lines. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {start_row} First line index @@ -2310,6 +2535,9 @@ nvim_buf_get_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col}, nvim_buf_get_var({buffer}, {name}) *nvim_buf_get_var()* Gets a buffer-scoped (b:) variable. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {name} Variable name @@ -2321,6 +2549,9 @@ nvim_buf_is_loaded({buffer}) *nvim_buf_is_loaded()* Checks if a buffer is valid and loaded. See |api-buffer| for more info about unloaded buffers. + Attributes: ~ + Since: 0.3.2 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2334,6 +2565,9 @@ nvim_buf_is_valid({buffer}) *nvim_buf_is_valid()* • Even if a buffer is valid it may have been unloaded. See |api-buffer| for more info about unloaded buffers. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2343,6 +2577,9 @@ nvim_buf_is_valid({buffer}) *nvim_buf_is_valid()* nvim_buf_line_count({buffer}) *nvim_buf_line_count()* Returns the number of lines in the given buffer. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2353,6 +2590,9 @@ nvim_buf_line_count({buffer}) *nvim_buf_line_count()* nvim_buf_set_keymap({buffer}, {mode}, {lhs}, {rhs}, {opts}) Sets a buffer-local |mapping| for the given mode. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2375,6 +2615,7 @@ nvim_buf_set_lines({buffer}, {start}, {end}, {strict_indexing}, {replacement}) Attributes: ~ not allowed when |textlock| is active + Since: 0.1.0 Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2396,6 +2637,9 @@ nvim_buf_set_mark({buffer}, {name}, {line}, {col}, {opts}) Note: ~ • Passing 0 as line deletes the mark + Attributes: ~ + Since: 0.6.0 + Parameters: ~ • {buffer} Buffer to set the mark on • {name} Mark name @@ -2413,6 +2657,9 @@ nvim_buf_set_mark({buffer}, {name}, {line}, {col}, {opts}) nvim_buf_set_name({buffer}, {name}) *nvim_buf_set_name()* Sets the full file name for a buffer, like |:file_f| + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {name} Buffer name @@ -2441,6 +2688,7 @@ nvim_buf_set_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col}, Attributes: ~ not allowed when |textlock| is active + Since: 0.5.0 Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer @@ -2453,6 +2701,9 @@ nvim_buf_set_text({buffer}, {start_row}, {start_col}, {end_row}, {end_col}, nvim_buf_set_var({buffer}, {name}, {value}) *nvim_buf_set_var()* Sets a buffer-scoped (b:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {name} Variable name @@ -2470,6 +2721,9 @@ nvim_buf_clear_namespace({buffer}, {ns_id}, {line_start}, {line_end}) Lines are 0-indexed. |api-indexing| To clear the namespace in the entire buffer, specify line_start=0 and line_end=-1. + Attributes: ~ + Since: 0.3.2 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {ns_id} Namespace to clear, or -1 to clear all namespaces. @@ -2480,6 +2734,9 @@ nvim_buf_clear_namespace({buffer}, {ns_id}, {line_start}, {line_end}) nvim_buf_del_extmark({buffer}, {ns_id}, {id}) *nvim_buf_del_extmark()* Removes an |extmark|. + Attributes: ~ + Since: 0.5.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {ns_id} Namespace id from |nvim_create_namespace()| @@ -2492,6 +2749,9 @@ nvim_buf_del_extmark({buffer}, {ns_id}, {id}) *nvim_buf_del_extmark()* nvim_buf_get_extmark_by_id({buffer}, {ns_id}, {id}, {opts}) Gets the position (0-indexed) of an |extmark|. + Attributes: ~ + Since: 0.5.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {ns_id} Namespace id from |nvim_create_namespace()| @@ -2542,6 +2802,9 @@ nvim_buf_get_extmarks({buffer}, {ns_id}, {start}, {end}, {opts}) vim.print(ms) < + Attributes: ~ + Since: 0.5.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {ns_id} Namespace id from |nvim_create_namespace()| or -1 for all @@ -2582,6 +2845,9 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts}) earlier end position is not an error, but then it behaves like an empty range (no highlighting). + Attributes: ~ + Since: 0.5.0 + Parameters: ~ • {buffer} Buffer handle, or 0 for current buffer • {ns_id} Namespace id from |nvim_create_namespace()| @@ -2724,6 +2990,9 @@ nvim_create_namespace({name}) *nvim_create_namespace()* namespace, the associated id is returned. If `name` is an empty string a new, anonymous namespace is created. + Attributes: ~ + Since: 0.3.2 + Parameters: ~ • {name} Namespace name or empty string @@ -2733,6 +3002,9 @@ nvim_create_namespace({name}) *nvim_create_namespace()* nvim_get_namespaces() *nvim_get_namespaces()* Gets existing, non-anonymous |namespace|s. + Attributes: ~ + Since: 0.3.2 + Return: ~ dict that maps from names to namespace ids. @@ -2769,6 +3041,7 @@ nvim_set_decoration_provider({ns_id}, {opts}) Attributes: ~ Lua |vim.api| only + Since: 0.5.0 Parameters: ~ • {ns_id} Namespace id from |nvim_create_namespace()| @@ -2821,6 +3094,7 @@ nvim_win_call({window}, {fun}) *nvim_win_call()* Attributes: ~ Lua |vim.api| only + Since: 0.5.0 Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2839,6 +3113,7 @@ nvim_win_close({window}, {force}) *nvim_win_close()* Attributes: ~ not allowed when |textlock| is active + Since: 0.4.0 Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2849,6 +3124,9 @@ nvim_win_close({window}, {force}) *nvim_win_close()* nvim_win_del_var({window}, {name}) *nvim_win_del_var()* Removes a window-scoped (w:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window • {name} Variable name @@ -2856,6 +3134,9 @@ nvim_win_del_var({window}, {name}) *nvim_win_del_var()* nvim_win_get_buf({window}) *nvim_win_get_buf()* Gets the current buffer in a window + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2867,6 +3148,9 @@ nvim_win_get_cursor({window}) *nvim_win_get_cursor()* (different windows showing the same buffer have independent cursor positions). |api-indexing| + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2879,6 +3163,9 @@ nvim_win_get_cursor({window}) *nvim_win_get_cursor()* nvim_win_get_height({window}) *nvim_win_get_height()* Gets the window height + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2888,6 +3175,9 @@ nvim_win_get_height({window}) *nvim_win_get_height()* nvim_win_get_number({window}) *nvim_win_get_number()* Gets the window number + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2897,6 +3187,9 @@ nvim_win_get_number({window}) *nvim_win_get_number()* nvim_win_get_position({window}) *nvim_win_get_position()* Gets the window position in display cells. First position is zero. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2906,6 +3199,9 @@ nvim_win_get_position({window}) *nvim_win_get_position()* nvim_win_get_tabpage({window}) *nvim_win_get_tabpage()* Gets the window tabpage + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2915,6 +3211,9 @@ nvim_win_get_tabpage({window}) *nvim_win_get_tabpage()* nvim_win_get_var({window}, {name}) *nvim_win_get_var()* Gets a window-scoped (w:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window • {name} Variable name @@ -2925,6 +3224,9 @@ nvim_win_get_var({window}, {name}) *nvim_win_get_var()* nvim_win_get_width({window}) *nvim_win_get_width()* Gets the window width + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2941,6 +3243,7 @@ nvim_win_hide({window}) *nvim_win_hide()* Attributes: ~ not allowed when |textlock| is active + Since: 0.5.0 Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2948,6 +3251,9 @@ nvim_win_hide({window}) *nvim_win_hide()* nvim_win_is_valid({window}) *nvim_win_is_valid()* Checks if a window is valid + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2959,6 +3265,7 @@ nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()* Attributes: ~ not allowed when |textlock| is active + Since: 0.3.2 Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -2968,6 +3275,9 @@ nvim_win_set_cursor({window}, {pos}) *nvim_win_set_cursor()* Sets the (1,0)-indexed cursor position in the window. |api-indexing| This scrolls the window even if it is not the current one. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window • {pos} (row, col) tuple representing the new position @@ -2975,6 +3285,9 @@ nvim_win_set_cursor({window}, {pos}) *nvim_win_set_cursor()* nvim_win_set_height({window}, {height}) *nvim_win_set_height()* Sets the window height. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window • {height} Height as a count of rows @@ -2986,12 +3299,18 @@ nvim_win_set_hl_ns({window}, {ns_id}) *nvim_win_set_hl_ns()* This takes precedence over the 'winhighlight' option. + Attributes: ~ + Since: 0.8.0 + Parameters: ~ • {ns_id} the namespace to use nvim_win_set_var({window}, {name}, {value}) *nvim_win_set_var()* Sets a window-scoped (w:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window • {name} Variable name @@ -3001,6 +3320,9 @@ nvim_win_set_width({window}, {width}) *nvim_win_set_width()* Sets the window width. This will only succeed if the screen is split vertically. + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window • {width} Width as a count of columns @@ -3017,6 +3339,9 @@ nvim_win_text_height({window}, {opts}) *nvim_win_text_height()* Line indexing is similar to |nvim_buf_get_text()|. + Attributes: ~ + Since: 0.10.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window. • {opts} Optional parameters: @@ -3097,6 +3422,7 @@ nvim_open_win({buffer}, {enter}, {config}) *nvim_open_win()* Attributes: ~ not allowed when |textlock| is active + Since: 0.4.0 Parameters: ~ • {buffer} Buffer to display, or 0 for current buffer @@ -3232,6 +3558,9 @@ nvim_win_get_config({window}) *nvim_win_get_config()* `relative` is empty for normal windows. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window @@ -3245,6 +3574,9 @@ nvim_win_set_config({window}, {config}) *nvim_win_set_config()* When reconfiguring a window, absent option keys will not be changed. `row`/`col` and `relative` must be reconfigured together. + Attributes: ~ + Since: 0.4.0 + Parameters: ~ • {window} |window-ID|, or 0 for current window • {config} Map defining the window configuration, see |nvim_open_win()| @@ -3259,6 +3591,9 @@ Tabpage Functions *api-tabpage* nvim_tabpage_del_var({tabpage}, {name}) *nvim_tabpage_del_var()* Removes a tab-scoped (t:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage • {name} Variable name @@ -3266,6 +3601,9 @@ nvim_tabpage_del_var({tabpage}, {name}) *nvim_tabpage_del_var()* nvim_tabpage_get_number({tabpage}) *nvim_tabpage_get_number()* Gets the tabpage number + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage @@ -3275,6 +3613,9 @@ nvim_tabpage_get_number({tabpage}) *nvim_tabpage_get_number()* nvim_tabpage_get_var({tabpage}, {name}) *nvim_tabpage_get_var()* Gets a tab-scoped (t:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage • {name} Variable name @@ -3285,6 +3626,9 @@ nvim_tabpage_get_var({tabpage}, {name}) *nvim_tabpage_get_var()* nvim_tabpage_get_win({tabpage}) *nvim_tabpage_get_win()* Gets the current window in a tabpage + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage @@ -3294,6 +3638,9 @@ nvim_tabpage_get_win({tabpage}) *nvim_tabpage_get_win()* nvim_tabpage_is_valid({tabpage}) *nvim_tabpage_is_valid()* Checks if a tabpage is valid + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage @@ -3303,6 +3650,9 @@ nvim_tabpage_is_valid({tabpage}) *nvim_tabpage_is_valid()* nvim_tabpage_list_wins({tabpage}) *nvim_tabpage_list_wins()* Gets the windows in a tabpage + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage @@ -3313,6 +3663,9 @@ nvim_tabpage_list_wins({tabpage}) *nvim_tabpage_list_wins()* nvim_tabpage_set_var({tabpage}, {name}, {value}) Sets a tab-scoped (t:) variable + Attributes: ~ + Since: 0.1.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage • {name} Variable name @@ -3321,6 +3674,9 @@ nvim_tabpage_set_var({tabpage}, {name}, {value}) nvim_tabpage_set_win({tabpage}, {win}) *nvim_tabpage_set_win()* Sets the current window in a tabpage + Attributes: ~ + Since: 0.10.0 + Parameters: ~ • {tabpage} |tab-ID|, or 0 for current tabpage • {win} |window-ID|, must already belong to {tabpage} @@ -3333,6 +3689,9 @@ nvim_clear_autocmds({opts}) *nvim_clear_autocmds()* Clears all autocommands selected by {opts}. To delete autocmds see |nvim_del_autocmd()|. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {opts} Parameters • event: (string|table) Examples: @@ -3362,6 +3721,9 @@ nvim_create_augroup({name}, {opts}) *nvim_create_augroup()* }) < + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {name} String: The name of the group • {opts} Dict Parameters @@ -3400,6 +3762,9 @@ nvim_create_autocmd({event}, {opts}) *nvim_create_autocmd()* pattern = vim.fn.expand("~") .. "/some/path/*.py" < + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {event} (string|array) Event(s) that will trigger the handler (`callback` or `command`). @@ -3451,6 +3816,9 @@ nvim_del_augroup_by_id({id}) *nvim_del_augroup_by_id()* autocommands contained in this group will also be deleted and cleared. This group will no longer exist. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {id} Integer The id of the group. @@ -3465,6 +3833,9 @@ nvim_del_augroup_by_name({name}) *nvim_del_augroup_by_name()* autocommands contained in this group will also be deleted and cleared. This group will no longer exist. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {name} String The name of the group. @@ -3474,6 +3845,9 @@ nvim_del_augroup_by_name({name}) *nvim_del_augroup_by_name()* nvim_del_autocmd({id}) *nvim_del_autocmd()* Deletes an autocommand by id. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {id} Integer Autocommand id returned by |nvim_create_autocmd()| @@ -3481,6 +3855,9 @@ nvim_exec_autocmds({event}, {opts}) *nvim_exec_autocmds()* Execute all autocommands for {event} that match the corresponding {opts} |autocmd-execute|. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {event} (String|Array) The event or events to execute • {opts} Dict of autocommand options: @@ -3518,6 +3895,9 @@ nvim_get_autocmds({opts}) *nvim_get_autocmds()* NOTE: When multiple patterns or events are provided, it will find all the autocommands that match any combination of them. + Attributes: ~ + Since: 0.7.0 + Parameters: ~ • {opts} Dict with at least one of the following: • buffer: (integer) Buffer number or list of buffer numbers @@ -3568,6 +3948,7 @@ nvim_ui_attach({width}, {height}, {options}) *nvim_ui_attach()* Attributes: ~ |RPC| only + Since: 0.1.0 Parameters: ~ • {width} Requested screen columns @@ -3581,6 +3962,7 @@ nvim_ui_detach() *nvim_ui_detach()* Attributes: ~ |RPC| only + Since: 0.1.0 *nvim_ui_pum_set_bounds()* nvim_ui_pum_set_bounds({width}, {height}, {row}, {col}) @@ -3596,6 +3978,7 @@ nvim_ui_pum_set_bounds({width}, {height}, {row}, {col}) Attributes: ~ |RPC| only + Since: 0.5.0 Parameters: ~ • {width} Popupmenu width. @@ -3609,6 +3992,7 @@ nvim_ui_pum_set_height({height}) *nvim_ui_pum_set_height()* Attributes: ~ |RPC| only + Since: 0.4.0 Parameters: ~ • {height} Popupmenu height, must be greater than zero. @@ -3618,11 +4002,13 @@ nvim_ui_set_focus({gained}) *nvim_ui_set_focus()* Attributes: ~ |RPC| only + Since: 0.9.0 nvim_ui_set_option({name}, {value}) *nvim_ui_set_option()* Attributes: ~ |RPC| only + Since: 0.1.0 nvim_ui_term_event({event}, {value}) *nvim_ui_term_event()* Tells Nvim when a terminal event has occurred @@ -3634,6 +4020,7 @@ nvim_ui_term_event({event}, {value}) *nvim_ui_term_event()* Attributes: ~ |RPC| only + Since: 0.10.0 Parameters: ~ • {event} Event name @@ -3643,6 +4030,7 @@ nvim_ui_try_resize({width}, {height}) *nvim_ui_try_resize()* Attributes: ~ |RPC| only + Since: 0.1.0 *nvim_ui_try_resize_grid()* nvim_ui_try_resize_grid({grid}, {width}, {height}) @@ -3653,6 +4041,7 @@ nvim_ui_try_resize_grid({grid}, {width}, {height}) Attributes: ~ |RPC| only + Since: 0.4.0 Parameters: ~ • {grid} The handle of the grid to be changed. |