aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2024-02-19 11:22:00 +0800
committerGitHub <noreply@github.com>2024-02-19 11:22:00 +0800
commita9f578b7a5edbca9aa01548f37341c2b97b57cda (patch)
tree44c8ccc4113a05c0b10a12f9c678619be0b67acf /runtime/doc
parentfa131de9adb74ac1f9f46eaecd5613f38d9c2ed7 (diff)
downloadrneovim-a9f578b7a5edbca9aa01548f37341c2b97b57cda.tar.gz
rneovim-a9f578b7a5edbca9aa01548f37341c2b97b57cda.tar.bz2
rneovim-a9f578b7a5edbca9aa01548f37341c2b97b57cda.zip
docs: improve 'tabline' click label docs (#27529)
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/options.txt17
-rw-r--r--runtime/doc/vim_diff.txt3
2 files changed, 11 insertions, 9 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 25607630f6..a74071ef12 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6078,16 +6078,17 @@ A jump table for the options with a short description can be found at |Q_op|.
) - End of item group. No width fields allowed.
T N For 'tabline': start of tab page N label. Use %T or %X to end
the label. Clicking this label with left mouse button switches
- to the specified tab page.
+ to the specified tab page, while clicking it with middle mouse
+ button closes the specified tab page.
X N For 'tabline': start of close tab N label. Use %X or %T to end
the label, e.g.: %3Xclose%X. Use %999X for a "close current
- tab" label. Clicking this label with left mouse button closes
- specified tab page.
- @ N Start of execute function label. Use %X or %T to
- end the label, e.g.: %10@SwitchBuffer@foo.c%X. Clicking this
- label runs specified function: in the example when clicking once
- using left mouse button on "foo.c" "SwitchBuffer(10, 1, 'l',
- ' ')" expression will be run. Function receives the
+ tab" label. Clicking this label with left mouse button closes
+ the specified tab page.
+ @ N Start of execute function label. Use %X or %T to end the label,
+ e.g.: %10@SwitchBuffer@foo.c%X. Clicking this label runs the
+ specified function: in the example when clicking once using left
+ mouse button on "foo.c", a `SwitchBuffer(10, 1, 'l', ' ')`
+ expression will be run. The specified function receives the
following arguments in order:
1. minwid field value or zero if no N was specified
2. number of mouse clicks to detect multiple clicks
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index 023944a8ad..1d5d62c737 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -327,7 +327,8 @@ Options:
'shortmess' "F" flag does not affect output from autocommands
'signcolumn' supports up to 9 dynamic/fixed columns
'statuscolumn' full control of columns using 'statusline' format
- 'tabline' %@Func@foo%X can call any function on mouse-click
+ 'tabline' middle-click on tabpage label closes tabpage,
+ and %@Func@foo%X can call any function on mouse-click
'termpastefilter'
'ttimeout', 'ttimeoutlen' behavior was simplified
'winblend' pseudo-transparency in floating windows |api-floatwin|