aboutsummaryrefslogtreecommitdiffstats
path: root/etc/NEWS
diff options
context:
space:
mode:
authorGerd Moellmann <[email protected]>2000-07-21 15:54:52 +0000
committerGerd Moellmann <[email protected]>2000-07-21 15:54:52 +0000
commitc20aeb834ddd34c72cf4f538ded8f8078a768ee0 (patch)
tree735bed61e4eef9224dbdb625ec6502277919b0d6 /etc/NEWS
parentf83490015c7a46bd71735bc9b81782283c958724 (diff)
*** empty log message ***
Diffstat (limited to 'etc/NEWS')
-rw-r--r--etc/NEWS15
1 files changed, 11 insertions, 4 deletions
diff --git a/etc/NEWS b/etc/NEWS
index 3a724c1480..a92f9ef045 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -2863,10 +2863,17 @@ that have a `help-echo' property.
If the value of the `help-echo' property is a function, that function
is called with three arguments WINDOW, OBJECT and POSITION. WINDOW is
-the window in which the help was found, OBJECT is the buffer or string
-which had the `help-echo' property. POSITION is the position within
-OBJECT under the mouse pointer. The function should return a help
-string or nil for none.
+the window in which the help was found.
+
+If OBJECT is a buffer, POS is the position in the buffer where the
+`help-echo' text property was found.
+
+If OBJECT is an overlay, that overlay has a `help-echo' property, and
+POS is the position in the overlay's buffer under the mouse.
+
+If OBJECT is a string (an overlay string or a string displayed with
+the `display' property). POS is the position in that string under the
+mouse.
If the value of the `help-echo' property is neither a function nor a
string, it is evaluated to obtain a help string.