summaryrefslogtreecommitdiff
path: root/lisp/subr.el
diff options
context:
space:
mode:
authorChong Yidong <cyd@stupidchicken.com>2010-12-04 19:43:18 -0500
committerChong Yidong <cyd@stupidchicken.com>2010-12-04 19:43:18 -0500
commit74194465d771110242a989e527000cbb896a6af2 (patch)
tree5a30509c20d3fc91a8597977fe7e996f89cc7456 /lisp/subr.el
parent77f1ed6cb665b06fc1cdd4e2707932f0b499d481 (diff)
downloademacs-74194465d771110242a989e527000cbb896a6af2.tar.gz
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).
Diffstat (limited to 'lisp/subr.el')
-rw-r--r--lisp/subr.el14
1 files changed, 8 insertions, 6 deletions
diff --git a/lisp/subr.el b/lisp/subr.el
index 7449295421c..8404352636e 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -916,8 +916,9 @@ Select the corresponding window as well."
(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 @@ and `event-end' functions."
(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))