diff options
author | altermo <107814000+altermo@users.noreply.github.com> | 2024-06-07 17:33:40 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-06-07 08:33:40 -0700 |
commit | f3632e14e3a75114415050ab01c2d04a06036009 (patch) | |
tree | b3a7067d7cbde9305b01324384a0aac76e6a56ae /runtime/doc | |
parent | 2ce4a4d91e4abee0aab8b98c47eea9fbd4849ba6 (diff) | |
download | rneovim-f3632e14e3a75114415050ab01c2d04a06036009.tar.gz rneovim-f3632e14e3a75114415050ab01c2d04a06036009.tar.bz2 rneovim-f3632e14e3a75114415050ab01c2d04a06036009.zip |
feat: get/set namespace properties #28728
ref https://github.com/neovim/neovim/pull/28432
ref https://github.com/neovim/neovim/issues/28469
Diffstat (limited to 'runtime/doc')
-rw-r--r-- | runtime/doc/api.txt | 35 | ||||
-rw-r--r-- | runtime/doc/news-0.10.txt | 2 | ||||
-rw-r--r-- | runtime/doc/news.txt | 2 |
3 files changed, 10 insertions, 29 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 577329ad00..f92a69af4e 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -2758,8 +2758,6 @@ nvim_buf_set_extmark({buffer}, {ns_id}, {line}, {col}, {opts}) • url: A URL to associate with this extmark. In the TUI, the OSC 8 control sequence is used to generate a clickable hyperlink to this URL. - • scoped: boolean (EXPERIMENTAL) enables "scoping" for the - extmark. See |nvim__win_add_ns()| Return: ~ Id of the created/updated extmark @@ -2841,41 +2839,26 @@ nvim_set_decoration_provider({ns_id}, {opts}) ["end", tick] < -nvim__win_add_ns({window}, {ns_id}) *nvim__win_add_ns()* +nvim__ns_get({ns_id}) *nvim__ns_get()* EXPERIMENTAL: this API will change in the future. - Scopes a namespace to the a window, so extmarks in the namespace will be - active only in the given window. + Get the properties for namespace Parameters: ~ - • {window} Window handle, or 0 for current window - • {ns_id} Namespace - - Return: ~ - true if the namespace was added, else false - -nvim__win_del_ns({window}, {ns_id}) *nvim__win_del_ns()* - EXPERIMENTAL: this API will change in the future. - - Unscopes a namespace (un-binds it from the given scope). - - Parameters: ~ - • {window} Window handle, or 0 for current window - • {ns_id} the namespace to remove + • {ns_id} Namespace Return: ~ - true if the namespace was removed, else false + Map defining the namespace properties, see |nvim__ns_set()| -nvim__win_get_ns({window}) *nvim__win_get_ns()* +nvim__ns_set({ns_id}, {opts}) *nvim__ns_set()* EXPERIMENTAL: this API will change in the future. - Gets the namespace scopes for a given window. + Set some properties for namespace Parameters: ~ - • {window} Window handle, or 0 for current window - - Return: ~ - a list of namespaces ids + • {ns_id} Namespace + • {opts} Optional parameters to set: + • wins: a list of windows to be scoped in ============================================================================== diff --git a/runtime/doc/news-0.10.txt b/runtime/doc/news-0.10.txt index d611eee242..bc868c1099 100644 --- a/runtime/doc/news-0.10.txt +++ b/runtime/doc/news-0.10.txt @@ -155,8 +155,6 @@ The following new features were added. • |nvim_input_mouse()| supports mouse buttons "x1" and "x2". • Added "force_crlf" option field in |nvim_open_term()|. • Added |nvim_tabpage_set_win()| to set the current window of a tabpage. - • |nvim__win_add_ns()| can bind a |namespace| to a window-local scope(s). - • Extmarks opt-in to this scoping via the `scoped` flag of |nvim_buf_set_extmark()|. • Mapping APIs now support abbreviations when mode short-name has suffix "a". • Floating windows can now show footer with new `footer` and `footer_pos` config fields. Uses |hl-FloatFooter| by default. diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index 2fed1b6b29..b316cc7b04 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -83,7 +83,7 @@ The following new features were added. API -• TODO +• |nvim__ns_set()| can set properties for a namespace DEFAULTS |