diff options
author | Eli Zaretskii <eliz@gnu.org> | 2022-11-26 13:56:30 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2022-11-26 13:56:30 +0200 |
commit | b84408647c43e9eed40b16153d0a0623dfa700c3 (patch) | |
tree | de07b61952e62b33219d97f03cbcf418c1247a4c /doc | |
parent | b3c9840066c90dfa051a9f525461914e92a4621d (diff) | |
download | emacs-b84408647c43e9eed40b16153d0a0623dfa700c3.tar.gz |
Improve documentation of some posn-* functions
* lisp/subr.el (posn-object-x-y): Doc fix.
* doc/lispref/commands.texi (Click Events): More accurate
documentation of what are DX and DY in POSITION.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/commands.texi | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 377b433cae5..662de29d45a 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -1676,10 +1676,14 @@ as returned by @code{find-image} (@pxref{Defining Images}); otherwise this is @code{nil}. @item @var{dx}, @var{dy} -These are the pixel coordinates of the click, relative to the top left -corner of @var{object}, which is @code{(0 . 0)}. If @var{object} is -@code{nil}, which stands for a buffer, the coordinates are relative to -the top left corner of the character glyph clicked on. +These are the pixel offsets of the click relative to the top left +corner of the @var{object}'s glyph that is the nearest one to the +click. The relevant @var{object}s can be either a buffer, or a string, +or an image, see above. If @var{object} is @code{nil} or a string, +the coordinates are relative to the top left corner of the character +glyph clicked on. Note that the offsets are always zero on text-mode +frames, when @var{object} is @code{nil}, since each glyph there is +considered to have exactly 1x1 pixel dimensions. @item @var{width}, @var{height} If the click is on a character, either from buffer text or from |