summaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorBram Moolenaar <Bram@vim.org>2022-11-14 19:49:15 +0000
committerBram Moolenaar <Bram@vim.org>2022-11-14 19:49:15 +0000
commit24dc19cdb2ce7cda2156d3b2eca6aee552b097dc (patch)
tree46fca39a61693d29966c0de9623146ab3859a0b4 /runtime
parent161b6ac04f257ab17779e9ba6f5b3e3e15d2a0fd (diff)
downloadvim-git-24dc19cdb2ce7cda2156d3b2eca6aee552b097dc.tar.gz
patch 9.0.0881: cannot get the currently showing mouse shapev9.0.0881
Problem: Cannot get the currently showing mouse shape. Solution: Add getmouseshape().
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/builtin.txt7
-rw-r--r--runtime/doc/usr_41.txt1
2 files changed, 8 insertions, 0 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
index ff93437ca..727ff2a5e 100644
--- a/runtime/doc/builtin.txt
+++ b/runtime/doc/builtin.txt
@@ -246,6 +246,7 @@ getloclist({nr}, {what}) Dict get specific location list properties
getmarklist([{buf}]) List list of global/local marks
getmatches([{win}]) List list of current matches
getmousepos() Dict last known mouse position
+getmouseshape() String current mouse shape name
getpid() Number process ID of Vim
getpos({expr}) List position of cursor, mark, etc.
getqflist() List list of quickfix items
@@ -3879,6 +3880,12 @@ getmousepos() *getmousepos()*
When using |getchar()| the Vim variables |v:mouse_lnum|,
|v:mouse_col| and |v:mouse_winid| also provide these values.
+getmouseshape() *getmouseshape()*
+ Returns the name of the currently showing mouse pointer.
+ When the |+mouseshape| feature is not supported or the shape
+ is unknown an empty string is returned.
+ This function is mainly intended for testing.
+
*getpid()*
getpid() Return a Number which is the process ID of the Vim process.
On Unix and MS-Windows this is a unique number, until Vim
diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt
index e449003a5..5a7820ed7 100644
--- a/runtime/doc/usr_41.txt
+++ b/runtime/doc/usr_41.txt
@@ -1110,6 +1110,7 @@ Interactive: *interactive-functions*
getcharstr() get a character from the user as a string
getcharmod() get modifiers for the last typed character
getmousepos() get last known mouse position
+ getmouseshape() get name of the current mouse shape
echoraw() output characters as-is
feedkeys() put characters in the typeahead queue
input() get a line from the user