changeset 59771:4301dcdf04df

(Misc Events): Describe the help-echo event.
author Eli Zaretskii <eliz@gnu.org>
date Sat, 29 Jan 2005 14:04:57 +0000
parents bea71297b227
children 3ee04791024f
files lispref/commands.texi
diffstat 1 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/commands.texi	Sat Jan 29 14:02:43 2005 +0000
+++ b/lispref/commands.texi	Sat Jan 29 14:04:57 2005 +0000
@@ -1547,6 +1547,21 @@
 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