#DOCUMENTATION by cg
authorClaus Gittinger <cg@exept.de>
Wed, 22 Feb 2017 18:17:56 +0100
changeset 3918 fdfdf70ba4b8
parent 3917 26886da33871
child 3919 180d36e00071
#DOCUMENTATION by cg class: MacOSXIconReader comment/format in: #documentation
MacOSXIconReader.st
--- a/MacOSXIconReader.st	Wed Feb 22 17:07:26 2017 +0100
+++ b/MacOSXIconReader.st	Wed Feb 22 18:17:56 2017 +0100
@@ -49,10 +49,19 @@
     (i.e. JPEG and PNG based image encodings only). 
     This means, that only 10.8-and later icon files are really generated.
 
-    caveat:
+    [caveat:]
         only a subset of the possibly formats are supported.
 
-    supported formats:
+    [notice:]
+        when reading an ICNS file with multiple icons in it,
+        the first image is returned as such, holding on the other images via its
+        imageSequence instvar.
+        Thus, the imageEditor will usually present the first of the images,
+        and offer a next-in-sequence button to step through them.
+        To get a collection of all images, collect the images from the sequence, as in:
+            someIcoImage imageSequence collect:#image
+
+    [supported formats:]
     
     support   format   length                pixels  OS-version  description
     -----------------------------------------------------------------------------