aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii <[email protected]>2005-01-29 14:04:57 +0000
committerEli Zaretskii <[email protected]>2005-01-29 14:04:57 +0000
commit16bbbfd864154333809fd679d099c729b703ee6e (patch)
tree3639440f3be4fea72fcfdbe41c7ca0d2ca25c1bf
parentef6938c57d14f39c46b7b235117a90555f7a62c3 (diff)
(Misc Events): Describe the help-echo event.
-rw-r--r--lispref/commands.texi15
1 files changed, 15 insertions, 0 deletions
diff --git a/lispref/commands.texi b/lispref/commands.texi
index b1bc552db3..293d72783c 100644
--- a/lispref/commands.texi
+++ b/lispref/commands.texi
@@ -1547,6 +1547,21 @@ The usual way to handle this event is by visiting these files.
This kind of event is generated, at present, only on some kinds of
systems.
+@cindex @code{help-echo} event
+@item help-echo
+This kind of event is generated when a mouse pointer moves onto a
+portion of buffer text which has a @code{help-echo} text property.
+The generated event has this form:
+
+@example
+ (help-echo @var{frame} @var{help} @var{window} @var{object} @var{pos})
+@end example
+
+@noindent
+The precise meaning of the event parameters and the way these
+parameters are used to display the help-echo text are described in
+@ref{Text help-echo}.
+
@cindex @code{usr1-signal} event
@cindex @code{usr2-signal} event
@item usr1-signal