summaryrefslogtreecommitdiff
path: root/lisp/image.el
diff options
context:
space:
mode:
authorKim F. Storm <storm@cua.dk>2004-09-22 23:12:38 +0000
committerKim F. Storm <storm@cua.dk>2004-09-22 23:12:38 +0000
commitb48bc937991d7e8d2676a842a9b784f91e62ffa1 (patch)
tree63fe7f653c19812844a01660a17f5d9e728fbac8 /lisp/image.el
parented2846bd743339ddf538568f3c0a77888834cb78 (diff)
downloademacs-b48bc937991d7e8d2676a842a9b784f91e62ffa1.tar.gz
(insert-sliced-image): Add doc string.
Diffstat (limited to 'lisp/image.el')
-rw-r--r--lisp/image.el9
1 files changed, 9 insertions, 0 deletions
diff --git a/lisp/image.el b/lisp/image.el
index ad8fcafe8de..13fdf2f6e4c 100644
--- a/lisp/image.el
+++ b/lisp/image.el
@@ -228,6 +228,15 @@ height of the image; integer values are taken as pixel values."
(defun insert-sliced-image (image &optional string area rows cols)
+ "Insert IMAGE into current buffer at point.
+IMAGE is displayed by inserting STRING into the current buffer
+with a `display' property whose value is the image. STRING is
+defaulted if you omit it.
+AREA is where to display the image. AREA nil or omitted means
+display it in the text area, a value of `left-margin' means
+display it in the left marginal area, a value of `right-margin'
+means display it in the right marginal area.
+The image is automatically split into ROW x COLS slices."
(unless string (setq string " "))
(unless (eq (car-safe image) 'image)
(error "Not an image: %s" image))