diff runtime/doc/eval.txt @ 4151:13170a796134 v7.3.828

updated for version 7.3.828 Problem: Mappings are not aware of wildmenu mode. Solution: Add wildmenumode(). (Christian Brabandt)
author Bram Moolenaar <bram@vim.org>
date Wed, 20 Feb 2013 17:59:11 +0100
parents 2b340e5c5baa
children cb185366f5c8
line wrap: on
line diff
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -1993,6 +1993,7 @@ undotree()			List	undo file tree
 values( {dict})			List	values in {dict}
 virtcol( {expr})		Number	screen column of cursor or mark
 visualmode( [expr])		String	last visual mode used
+wildmenumode()			Number	whether 'wildmenu' mode is active
 winbufnr( {nr})			Number	buffer number of window {nr}
 wincol()			Number	window column of the cursor
 winheight( {nr})		Number	height of window {nr}
@@ -6162,6 +6163,18 @@ visualmode([expr])						*visualmode()*
 		Dictionary or Float is not a Number or String, thus does not
 		cause the mode to be cleared.
 
+wildmenumode()					*wildmenumode()*
+		Returns non-zero when the wildmenu is active and zero
+		otherwise.  See 'wildmenu' and 'wildmode'.
+		This can be used in mappings to handle the 'wildcharm' option
+		gracefully. (Makes only sense with |mapmode-c| mappings).
+
+		For example to make <c-j> work like <down> in wildmode, use: >
+    :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
+<
+		(Note, this needs the 'wildcharm' option set appropriately).
+
+
 							*winbufnr()*
 winbufnr({nr})	The result is a Number, which is the number of the buffer
 		associated with window {nr}.  When {nr} is zero, the number of