Commit 41932b21 authored by Eli Zaretskii's avatar Eli Zaretskii
Browse files

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

 src/frame.c (Fmouse_position, Fset_mouse_position): Clarify the
 units in which the position is measured.  (Bug#18493)
parent a8106753
2014-09-18 Eli Zaretskii <eliz@gnu.org> 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 * xdisp.c (redisplay_internal): Force redisplay of all windows
that show a buffer whose narrowing has changed. (Bug#18490) that show a buffer whose narrowing has changed. (Bug#18490)
......
...@@ -1524,9 +1524,9 @@ The functions are run with one argument, the frame to be deleted. */) ...@@ -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, DEFUN ("mouse-position", Fmouse_position, Smouse_position, 0, 0, 0,
doc: /* Return a list (FRAME X . Y) giving the current mouse frame and position. 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 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 upper-left corner of the frame, X is the horizontal offset, and Y is the
the vertical offset. 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 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 to read the mouse position, it returns the selected frame for FRAME
and nil for X and Y. and nil for X and Y.
...@@ -1609,9 +1609,10 @@ Coordinates are relative to the frame, not a window, ...@@ -1609,9 +1609,10 @@ Coordinates are relative to the frame, not a window,
so the coordinates of the top left character in the frame so the coordinates of the top left character in the frame
may be nonzero due to left-hand scroll bars or the menu bar. 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 The position is given in canonical character cells, where (0, 0) is
upper-left corner of the frame, X is the horizontal offset, and Y is the upper-left corner of the frame, X is the horizontal offset, and
the vertical offset. 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. 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 If you have just created a frame, you must wait for it to become visible
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment