diff options
| author | Eli Zaretskii | 2005-01-29 14:04:57 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2005-01-29 14:04:57 +0000 |
| commit | 16bbbfd864154333809fd679d099c729b703ee6e (patch) | |
| tree | 3639440f3be4fea72fcfdbe41c7ca0d2ca25c1bf | |
| parent | ef6938c57d14f39c46b7b235117a90555f7a62c3 (diff) | |
| download | emacs-16bbbfd864154333809fd679d099c729b703ee6e.tar.gz emacs-16bbbfd864154333809fd679d099c729b703ee6e.zip | |
(Misc Events): Describe the help-echo event.
| -rw-r--r-- | lispref/commands.texi | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/lispref/commands.texi b/lispref/commands.texi index b1bc552db36..293d72783c5 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. | |||
| 1547 | This kind of event is generated, at present, only on some kinds of | 1547 | This kind of event is generated, at present, only on some kinds of |
| 1548 | systems. | 1548 | systems. |
| 1549 | 1549 | ||
| 1550 | @cindex @code{help-echo} event | ||
| 1551 | @item help-echo | ||
| 1552 | This kind of event is generated when a mouse pointer moves onto a | ||
| 1553 | portion of buffer text which has a @code{help-echo} text property. | ||
| 1554 | The generated event has this form: | ||
| 1555 | |||
| 1556 | @example | ||
| 1557 | (help-echo @var{frame} @var{help} @var{window} @var{object} @var{pos}) | ||
| 1558 | @end example | ||
| 1559 | |||
| 1560 | @noindent | ||
| 1561 | The precise meaning of the event parameters and the way these | ||
| 1562 | parameters are used to display the help-echo text are described in | ||
| 1563 | @ref{Text help-echo}. | ||
| 1564 | |||
| 1550 | @cindex @code{usr1-signal} event | 1565 | @cindex @code{usr1-signal} event |
| 1551 | @cindex @code{usr2-signal} event | 1566 | @cindex @code{usr2-signal} event |
| 1552 | @item usr1-signal | 1567 | @item usr1-signal |