Mercurial > emacs
changeset 70229:b85aa1663ba3
(posn-string, posn-image, posn-object): Doc fix.
| author | Kim F. Storm <storm@cua.dk> |
|---|---|
| date | Wed, 26 Apr 2006 08:56:32 +0000 |
| parents | e73582101f20 |
| children | a77964e24327 |
| files | lisp/subr.el |
| diffstat | 1 files changed, 6 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/subr.el Wed Apr 26 08:56:23 2006 +0000 +++ b/lisp/subr.el Wed Apr 26 08:56:32 2006 +0000 @@ -851,19 +851,23 @@ (nth 3 position)) (defsubst posn-string (position) - "Return the string object of POSITION, or nil if a buffer position. + "Return the string object of POSITION. +Value is a cons (STRING . STRING-POS), or nil if not a string. POSITION should be a list of the form returned by the `event-start' and `event-end' functions." (nth 4 position)) (defsubst posn-image (position) - "Return the image object of POSITION, or nil if a not an image. + "Return the image object of POSITION. +Value is an list (image ...), or nil if not an image. POSITION should be a list of the form returned by the `event-start' and `event-end' functions." (nth 7 position)) (defsubst posn-object (position) "Return the object (image or string) of POSITION. +Value is a list (image ...) for an image object, a cons cell +\(STRING . STRING-POS) for a string object, and nil for a buffer position. POSITION should be a list of the form returned by the `event-start' and `event-end' functions." (or (posn-image position) (posn-string position)))