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

Clarify the doc strings of mouse-position and set-mouse-position.

Browse source 
src/frame.c (Fmouse_position, Fset_mouse_position): Clarify the
 units in which the position is measured.  (Bug#18493)
This commit is contained in:
Eli Zaretskii 2014-09-18 20:20:57 +03:00
parent a810675374
commit 41932b21a2
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/ChangeLog
View file

@ -1,5 +1,8 @@
2014-09-18 Eli Zaretskii <eliz@gnu.org>
* frame.c (Fmouse_position, Fset_mouse_position): Clarify the
units in which the position is measured. (Bug#18493)
* xdisp.c (redisplay_internal): Force redisplay of all windows
that show a buffer whose narrowing has changed. (Bug#18490)

13
src/frame.c
View file

@ -1524,9 +1524,9 @@ The functions are run with one argument, the frame to be deleted. */)
DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position.
The position is given in character cells, where (0, 0) is the
upper-left corner of the frame, X is the horizontal offset, and Y is
the vertical offset.
The position is given in canonical character cells, where (0, 0) is the
upper-left corner of the frame, X is the horizontal offset, and Y is the
vertical offset, measured in units of the frame's default character size.
If Emacs is running on a mouseless terminal or hasn't been programmed
to read the mouse position, it returns the selected frame for FRAME
and nil for X and Y.
@ -1609,9 +1609,10 @@ Coordinates are relative to the frame, not a window,
so the coordinates of the top left character in the frame
may be nonzero due to left-hand scroll bars or the menu bar.
The position is given in character cells, where (0, 0) is the
upper-left corner of the frame, X is the horizontal offset, and Y is
the vertical offset.
The position is given in canonical character cells, where (0, 0) is
the upper-left corner of the frame, X is the horizontal offset, and
Y is the vertical offset, measured in units of the frame's default
character size.
This function is a no-op for an X frame that is not visible.
If you have just created a frame, you must wait for it to become visible