--- a/ImageReader.st Mon May 06 15:13:47 2013 +0200
+++ b/ImageReader.st Mon May 06 15:15:56 2013 +0200
@@ -907,12 +907,16 @@
documentation
"
Abstract class to provide common functions for image-readers
- (i.e. TIFFReader, GIFReader etc.)
+ (i.e. TIFFReader, GIFReader etc.). In contrast to what the name suggests,
+ ImageReaders are suposed to support both reading and writing of images
+ (i.e. the name is somewhat outdated, but kept for historic and backward
+ compatibility reasons). They provide functionality similar to Squeak's
+ ImageReaderWriter classes.
ImageReaders are created temporary to read an image from a stream.
Normally, they are not directly used - instead, the image class is
asked to read some file, and return an instance for it:
- Image fromFile:<someFileName>
+ Image fromFile:<someFileName>
The Image class will guess the images format and forward the task to
some concrete ImageReaderClass.
If that class finds, that the files format is incorrect, other readers
@@ -924,20 +928,21 @@
See the implementation of #fromStream: in concrete subclasses.
The public interfaces are:
- <ConcreteReaderClass> fromFile:aFilename
+ <ConcreteReaderClass> fromFile:aFilename
or:
- <ConcreteReaderClass> fromStream:aStream
+ <ConcreteReaderClass> fromStream:aStream
- If you add a new reader, dont forget to add the method #isValidImageFile:
+ If you add a new reader, don't forget to add the method #isValidImageFile:
which should return true, if this reader supports reading a given file.
- If your new reader class supports writing files, dont forget to add
+
+ If your new reader class supports writing files, don't forget to add
#canRepresent:anImage and return true from this method.
[See also:]
- Image Icon Form
+ Image Icon Form
[author:]
- Claus Gittinger
+ Claus Gittinger
"
! !
@@ -1968,10 +1973,10 @@
!ImageReader class methodsFor:'documentation'!
version
- ^ '$Header: /cvs/stx/stx/libview/ImageReader.st,v 1.103 2013-05-06 13:13:47 cg Exp $'
+ ^ '$Header: /cvs/stx/stx/libview/ImageReader.st,v 1.104 2013-05-06 13:15:56 cg Exp $'
!
version_CVS
- ^ '$Header: /cvs/stx/stx/libview/ImageReader.st,v 1.103 2013-05-06 13:13:47 cg Exp $'
+ ^ '$Header: /cvs/stx/stx/libview/ImageReader.st,v 1.104 2013-05-06 13:15:56 cg Exp $'
! !