summaryrefslogtreecommitdiffstats
path: root/doc/photo.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2003-07-17 22:53:09 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2003-07-17 22:53:09 (GMT)
commit32d31762b7a1cb4fc118e3f0a437f307672285d0 (patch)
treec40137609b55951292bcb2eebb42ba6ad6f242ed /doc/photo.n
parent6eb4883088184b907621ae022deee1bc9f6bbb14 (diff)
downloadtk-32d31762b7a1cb4fc118e3f0a437f307672285d0.zip
tk-32d31762b7a1cb4fc118e3f0a437f307672285d0.tar.gz
tk-32d31762b7a1cb4fc118e3f0a437f307672285d0.tar.bz2
Better docs of [$photo put]. [Bug 728952]
Diffstat (limited to 'doc/photo.n')
-rw-r--r--doc/photo.n25
1 files changed, 16 insertions, 9 deletions
diff --git a/doc/photo.n b/doc/photo.n
index b8a0673..ef04d7a 100644
--- a/doc/photo.n
+++ b/doc/photo.n
@@ -9,7 +9,7 @@
'\" Department of Computer Science,
'\" Australian National University.
'\"
-'\" RCS: @(#) $Id: photo.n,v 1.14.2.1 2003/07/14 22:59:34 dkf Exp $
+'\" RCS: @(#) $Id: photo.n,v 1.14.2.2 2003/07/17 22:53:09 dkf Exp $
'\"
.so man.macros
.TH photo n 4.0 Tk "Tk Built-In Commands"
@@ -245,9 +245,13 @@ Sets pixels in \fI imageName\fR to the data specified in \fIdata\fR.
This command first searches the list of image file format handlers for
a handler that can interpret the data in \fIdata\fR, and then reads
the image encoded within into \fIimageName\fR (the destination image).
-Note that \fIdata\fR may also be a single color name if you wish to
-fill a rectangular region with that color. The following options may
-be specified:
+If \fIdata\fR does not match any known format, an attempt to interpret
+it as a (top-to-bottom) list of scan-lines is made, with each
+scan-line being a (left-to-right) list of pixel colors (see
+\fBTk_GetColor\fR for a description of valid colors.) Every scan-line
+must be of the same length. Note that when \fIdata\fR is a single
+color name, you are instructing Tk to fill a rectangular region with
+that color. The following options may be specified:
.RS
.TP
\fB\-format \fIformat-name\fR
@@ -257,11 +261,14 @@ Specifically, only image file format handlers whose names begin with
format handler to read the data.
.TP
\fB\-to \fIx1 y1\fR ?\fIx2 y2\fR?
-Specifies the coordinates of the top-left corner (\fIx1\fR,\fIy1\fR) of the
-region of \fIimageName\fR into which data from \fIfilename\fR are to be
-read. The default is (0,0). If \fIx2\fR,\fIy2\fR is given and \fIdata\fR
-is one color value, then a region extending to the bottom-right corner
-represented by (\fIx2\fR,\fIy2\fR) will be filled with that color.
+Specifies the coordinates of the top-left corner (\fIx1\fR,\fIy1\fR)
+of the region of \fIimageName\fR into which data from \fIfilename\fR
+are to be read. The default is (0,0). If \fIx2\fR,\fIy2\fR is given
+and \fIdata\fR is not large enough to cover the rectangle specified by
+this option, the image data extracted will be tiled so it covers the
+entire destination. Note that if \fIdata\fR specifies a single color
+value, then a region extending to the bottom-right corner represented
+by (\fIx2\fR,\fIy2\fR) will be filled with that color.
.RE
.TP
\fIimageName \fBread\fR \fIfilename\fR ?\fIoption value(s) ...\fR?