diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2014-09-18 20:20:57 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2014-09-18 20:20:57 +0300 |
| commit | 41932b21a2f716ec1021485c40331ee9a88a66a3 (patch) | |
| tree | b5d22af898cae5580dc7839f6ee846567b887c86 | |
| parent | a810675374498ff80464e48eeeb39f1854ef37bd (diff) | |
| download | emacs-41932b21a2f716ec1021485c40331ee9a88a66a3.tar.gz | |
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)
| -rw-r--r-- | src/ChangeLog | 3 | ||||
| -rw-r--r-- | src/frame.c | 13 |
2 files changed, 10 insertions, 6 deletions
diff --git a/src/ChangeLog b/src/ChangeLog index 880f49e3e89..b442158a828 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -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) diff --git a/src/frame.c b/src/frame.c index 0c130164352..35fd190ba28 100644 --- a/src/frame.c +++ b/src/frame.c @@ -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 |