Mercurial > emacs
changeset 111905:0d5ab24d31df
Doc fix for posn-* functions (Bug#7471).
* lisp/subr.el (posn-x-y, posn-object-x-y, posn-object-width-height):
Doc fix (Bug#7471).
| author | Chong Yidong <cyd@stupidchicken.com> |
|---|---|
| date | Sat, 04 Dec 2010 19:43:18 -0500 |
| parents | 5c6c43239aa4 |
| children | da6435021d47 |
| files | lisp/ChangeLog lisp/subr.el |
| diffstat | 2 files changed, 13 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/ChangeLog Sat Dec 04 19:32:32 2010 -0500 +++ b/lisp/ChangeLog Sat Dec 04 19:43:18 2010 -0500 @@ -1,3 +1,8 @@ +2010-12-05 Chong Yidong <cyd@stupidchicken.com> + + * subr.el (posn-x-y, posn-object-x-y, posn-object-width-height): + Doc fix (Bug#7471). + 2010-12-04 Martin Rudalics <rudalics@gmx.at> * dired.el (dired-pop-to-buffer): Bind pop-up-frames to nil
--- a/lisp/subr.el Sat Dec 04 19:32:32 2010 -0500 +++ b/lisp/subr.el Sat Dec 04 19:43:18 2010 -0500 @@ -916,8 +916,9 @@ (defsubst posn-x-y (position) "Return the x and y coordinates in POSITION. -POSITION should be a list of the form returned by the `event-start' -and `event-end' functions." +The return value has the form (X . Y), where X and Y are given in +pixels. POSITION should be a list of the form returned by +`event-start' and `event-end'." (nth 2 position)) (declare-function scroll-bar-scale "scroll-bar" (num-denom whole)) @@ -997,14 +998,15 @@ (defsubst posn-object-x-y (position) "Return the x and y coordinates relative to the object of POSITION. -POSITION should be a list of the form returned by the `event-start' -and `event-end' functions." +The return value has the form (DX . DY), where DX and DY are +given in pixels. POSITION should be a list of the form returned +by `event-start' and `event-end'." (nth 8 position)) (defsubst posn-object-width-height (position) "Return the pixel width and height of the object of POSITION. -POSITION should be a list of the form returned by the `event-start' -and `event-end' functions." +The return value has the form (WIDTH . HEIGHT). POSITION should +be a list of the form returned by `event-start' and `event-end'." (nth 9 position))