]> git.eshelyaron.com Git - emacs.git/commitdiff
(Misc Events): Describe the help-echo event.
authorEli Zaretskii <eliz@gnu.org>
Sat, 29 Jan 2005 14:04:57 +0000 (14:04 +0000)
committerEli Zaretskii <eliz@gnu.org>
Sat, 29 Jan 2005 14:04:57 +0000 (14:04 +0000)
lispref/commands.texi

index b1bc552db368d719599d61a5dd3781d177640d17..293d72783c53b36d6c5ab06eda174e7832e09c28 100644 (file)
@@ -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