diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2015-03-23 18:35:03 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2015-03-23 18:35:03 +0200 |
| commit | 5e2951be4ac50da48bb82e74db87930e9d9d127d (patch) | |
| tree | 00a9678d8f9d6dd1937697581067b647970cc4dd /doc | |
| parent | 1291ce180ee0a8e8fcbc57975b55968f9e7162bc (diff) | |
| download | emacs-5e2951be4ac50da48bb82e74db87930e9d9d127d.tar.gz | |
Improve docs of 'posn-actual-col-row' (Bug#20169)
doc/lispref/commands.texi (Accessing Mouse): Expand documentation of
'posn-actual-col-row'.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 2 | ||||
| -rw-r--r-- | doc/lispref/commands.texi | 8 |
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 1dae36ade34..970d16322b3 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -2,6 +2,8 @@ * commands.texi (Event Input Misc): Fix incorrect usage of @code. (Bug#20174) + (Accessing Mouse): Expand documentation of 'posn-actual-col-row'. + (Bug#20169) 2015-03-14 Eli Zaretskii <eliz@gnu.org> diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi index 4b69ed32709..6cb032c2635 100644 --- a/doc/lispref/commands.texi +++ b/doc/lispref/commands.texi @@ -2081,7 +2081,13 @@ Return the actual row and column in @var{position}, as a cons cell @code{(@var{col} . @var{row})}. The values are the actual row and column numbers in the window given by @var{position}. @xref{Click Events}, for details. The function returns @code{nil} if -@var{position} does not include actual position values. +@var{position} does not include actual position values; in that case +@code{posn-col-row} can be used to get approximate values. + +Note that this function doesn't account for the visual width of +characters on display, like the number of visual columns taken by a +tab character or an image. If you need the coordinates in canonical +character units, use @code{posn-col-row} instead. @end defun @defun posn-string position |