procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve docs of 'posn-actual-col-row' (Bug#20169)

Browse source 
doc/lispref/commands.texi (Accessing Mouse): Expand documentation of
 'posn-actual-col-row'.
This commit is contained in:
Eli Zaretskii 2015-03-23 18:35:03 +02:00
parent 1291ce180e
commit 5e2951be4a
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/lispref/ChangeLog
View file

@ -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>

8
doc/lispref/commands.texi
View file

@ -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