about summary refs log tree commit diff
path: root/Doc
diff options
context:
space:
mode:
authorPeter Stephenson <pws@users.sourceforge.net>2004-09-10 18:03:33 +0000
committerPeter Stephenson <pws@users.sourceforge.net>2004-09-10 18:03:33 +0000
commitb12c16850521328a396bb62c3b07558f9308c621 (patch)
treee94fb1580aa2dca85c07f91e1f01afa75ce5f521 /Doc
parent6f607e1098b9be314d551ea475ca45c368953a03 (diff)
downloadzsh-b12c16850521328a396bb62c3b07558f9308c621.tar.gz
zsh-b12c16850521328a396bb62c3b07558f9308c621.tar.xz
zsh-b12c16850521328a396bb62c3b07558f9308c621.zip
20348: rejig WIDGETSTYLE and add WIDGETFUNC
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/zle.yo22
1 files changed, 14 insertions, 8 deletions
diff --git a/Doc/Zsh/zle.yo b/Doc/Zsh/zle.yo
index 036c0284c..9af41e820 100644
--- a/Doc/Zsh/zle.yo
+++ b/Doc/Zsh/zle.yo
@@ -732,15 +732,21 @@ vindex(WIDGET)
 item(tt(WIDGET) (scalar))(
 The name of the widget currently being executed; read-only.
 )
+vindex(WIDGETFUNC)
+item(tt(WIDGETFUNC) (scalar))(
+The name of the shell function that implements a widget defined with
+either tt(zle -N) or tt(zle -C).  In the former case, this is the second
+argument to the tt(zle -N) command that defined the widget, or
+the first argument if there was no second argument.  In the latter case
+this is the the third argument to the tt(zle -C) command that defined the
+widget.  Read-only.
+)
 vindex(WIDGETSTYLE)
-item(tt(WIDGET) (scalar))(
-Describes the implementation behind the widget currently being executed;
-the second argument that followed tt(zle -C) or tt(zle -N) when the widget
-was defined, if any.  If the widget was defined with tt(zle -N) and there was
-no second argument this is the same as the first argument.  Hence for
-tt(zle -N) this gives the name of the function that implements the widget,
-and for tt(zle -C) this gives the internal completion widget that defines
-the type of completion.  Read-only.
+item(tt(WIDGETSTYLE) (scalar))(
+Describes the implementation behind the completion widget currently being
+executed; the second argument that followed tt(zle -C) when the widget was
+defined.  This is the name of a builtin completion widget.  For widgets
+defined with tt(zle -N) this is set to the empty string.  Read-only.
 )
 enditem()