aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Love2000-09-04 13:55:53 +0000
committerDave Love2000-09-04 13:55:53 +0000
commit05cae5d0b01134da71f92ef93608fc1cc0b46d62 (patch)
treea19af7fa61fdb852e55561540538bc06f9570645
parentb7fa4a06756836235d9c72d8d77b082eb9c14832 (diff)
downloademacs-05cae5d0b01134da71f92ef93608fc1cc0b46d62.tar.gz
emacs-05cae5d0b01134da71f92ef93608fc1cc0b46d62.zip
help-echo stuff
-rw-r--r--lispref/text.texi24
1 files changed, 12 insertions, 12 deletions
diff --git a/lispref/text.texi b/lispref/text.texi
index e2f09404447..2b2098666bb 100644
--- a/lispref/text.texi
+++ b/lispref/text.texi
@@ -2659,9 +2659,9 @@ If text has a string as its @code{help-echo} property, then when you
2659move the mouse onto that text, Emacs displays that string in the echo 2659move the mouse onto that text, Emacs displays that string in the echo
2660area, or in the tooltip window. 2660area, or in the tooltip window.
2661 2661
2662If the value of the @code{help-echo property} is a function, that 2662If the value of the @code{help-echo} property is a function, that
2663function is called with three arguments, @var{window}, @var{object} and 2663function is called with three arguments, @var{window}, @var{object} and
2664@var{position} and should return a help string or nil for 2664@var{position} and should return a help string or @var{nil} for
2665none. The first argument, @var{window} is the window in which 2665none. The first argument, @var{window} is the window in which
2666the help was found. The second, @var{object}, is the buffer, overlay or 2666the help was found. The second, @var{object}, is the buffer, overlay or
2667string which had the @code{help-echo} property. The @var{position} 2667string which had the @code{help-echo} property. The @var{position}
@@ -2677,15 +2677,15 @@ property, and @var{pos} is the position in the overlay's buffer under
2677the mouse. 2677the mouse.
2678@item 2678@item
2679If @var{object} is a string (an overlay string or a string displayed 2679If @var{object} is a string (an overlay string or a string displayed
2680with the @code{display} property) @var{pos} is the position in that 2680with the @code{display} property), @var{pos} is the position in that
2681string under the mouse. 2681string under the mouse.
2682@end itemize 2682@end itemize
2683 2683
2684If the value of the @code{help-echo} property is neither a function nor 2684If the value of the @code{help-echo} property is neither a function nor
2685a string, it is evaluated to obtain a help string. 2685a string, it is evaluated to obtain a help string.
2686 2686
2687Variable @code{show-help-function} (@pxref{Help display}) provides a 2687You can alter the way help text is displayed by setting the variable
2688hook to alter the way help text is displayed. 2688@code{show-help-function} (@pxref{Help display}).
2689 2689
2690This feature is used in the mode line and for other active text. It is 2690This feature is used in the mode line and for other active text. It is
2691available starting in Emacs 21. 2691available starting in Emacs 21.
@@ -2813,13 +2813,13 @@ property has no effect. Do not set this variable globally; bind it with
2813 2813
2814@defvar show-help-function 2814@defvar show-help-function
2815@tindex show-help-function 2815@tindex show-help-function
2816@anchor{Help display} 2816@anchor{Help display} If this variable is non-@code{nil}, it specifies a
2817If this variable is non-@code{nil} it specifies a function called to 2817function called to display help strings. These may be @code{help-echo}
2818display help strings. These may be @code{help-echo} properties or menu 2818properties, menu help strings (@pxref{Simple Menu Items},
2819(@pxref{Simple Menu Items}, @pxref{Extended Menu Items}) or tool bar 2819@pxref{Extended Menu Items}), or tool bar help strings (@pxref{Tool
2820(@pxref{Tool Bar}) help strings. The specified function is called with 2820Bar}). The specified function is called with one argument, the help
2821one argument, the help string to display. Tooltip mode 2821string to display. Tooltip mode (@pxref{(emacs)Tooltips}) provides an
2822(@pxref{(emacs)Tooltips}) provides an example. 2822example.
2823@end defvar 2823@end defvar
2824 2824
2825@node Format Properties 2825@node Format Properties