diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/display.texi | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 494bf0d3f7e..61bd4ce8830 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -6607,14 +6607,23 @@ in the variable @code{button-map}, which defines @key{RET} and | |||
| 6607 | The button type. @xref{Button Types}. | 6607 | The button type. @xref{Button Types}. |
| 6608 | 6608 | ||
| 6609 | @item help-echo | 6609 | @item help-echo |
| 6610 | @kindex help-index @r{(button property)} | 6610 | @kindex help-echo @r{(button property)} |
| 6611 | A string displayed by the Emacs tool-tip help system; by default, | 6611 | A string displayed by the Emacs tooltip help system; by default, |
| 6612 | @code{"mouse-2, RET: Push this button"}. | 6612 | @code{"mouse-2, RET: Push this button"}. Alternatively, a function |
| 6613 | that returns, or a form that evaluates to, a string to be displayed or | ||
| 6614 | @code{nil}. For details see @ref{Text help-echo}. | ||
| 6615 | |||
| 6616 | The function is called with three arguments, @var{window}, | ||
| 6617 | @var{object}, and @var{pos}. The second argument, @var{object}, is | ||
| 6618 | either the overlay that had the property (for overlay buttons), or the | ||
| 6619 | buffer containing the button (for text property buttons). The other | ||
| 6620 | arguments have the same meaning as for the special text property | ||
| 6621 | @code{help-echo}. | ||
| 6613 | 6622 | ||
| 6614 | @item follow-link | 6623 | @item follow-link |
| 6615 | @kindex follow-link @r{(button property)} | 6624 | @kindex follow-link @r{(button property)} |
| 6616 | The follow-link property, defining how a @key{mouse-1} click behaves | 6625 | The @code{follow-link} property, defining how a @key{mouse-1} click |
| 6617 | on this button, @xref{Clickable Text}. | 6626 | behaves on this button, @xref{Clickable Text}. |
| 6618 | 6627 | ||
| 6619 | @item button | 6628 | @item button |
| 6620 | @kindex button @r{(button property)} | 6629 | @kindex button @r{(button property)} |