commit a9f578b7a5edbca9aa01548f37341c2b97b57cda
parent fa131de9adb74ac1f9f46eaecd5613f38d9c2ed7
Author: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 19 Feb 2024 11:22:00 +0800
docs: improve 'tabline' click label docs (#27529)
Diffstat:
4 files changed, 29 insertions(+), 25 deletions(-)
diff --git 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
@@ -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|
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
@@ -6525,16 +6525,17 @@ vim.wo.stc = vim.wo.statuscolumn
--- ) - 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/src/nvim/options.lua b/src/nvim/options.lua
@@ -8186,16 +8186,17 @@ return {
) - 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
