klute 02/05/02 01:00:40
Modified: src/documentation/xdocs/hpsf book.xml how-to.xml
Added: src/documentation/xdocs/hpsf thumbnails.xml
Removed: src/documentation/xdocs/hpsf thumbnail.html
Log:
Thumbnail docs.
Revision Changes Path
1.4 +2 -1 jakarta-poi/src/documentation/xdocs/hpsf/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/xdocs/hpsf/book.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- book.xml 6 Mar 2002 12:29:54 -0000 1.3
+++ book.xml 2 May 2002 08:00:40 -0000 1.4
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN"
"../dtd/book-cocoon-v10.dtd">
-<!-- $Id: book.xml,v 1.3 2002/03/06 12:29:54 klute Exp $ -->
+<!-- $Id: book.xml,v 1.4 2002/05/02 08:00:40 klute Exp $ -->
<book software="POI Project"
title="HPSF"
copyright="@year@ POI Project">
@@ -11,6 +11,7 @@
<menu label="HPSF">
<menu-item label="Overview" href="index.html"/>
<menu-item label="How To" href="how-to.html"/>
+ <menu-item label="Thumbnails" href="thumbnails.html"/>
<menu-item label="Internals" href="internals.html"/>
<menu-item label="To Do" href="todo.html"/>
</menu>
1.9 +6 -1 jakarta-poi/src/documentation/xdocs/hpsf/how-to.xml
Index: how-to.xml
===================================================================
RCS file: /home/cvs/jakarta-poi/src/documentation/xdocs/hpsf/how-to.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- how-to.xml 29 Apr 2002 08:16:19 -0000 1.8
+++ how-to.xml 2 May 2002 08:00:40 -0000 1.9
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"../dtd/document-v11.dtd">
-<!-- $Id: how-to.xml,v 1.8 2002/04/29 08:16:19 klute Exp $ -->
+<!-- $Id: how-to.xml,v 1.9 2002/05/02 08:00:40 klute Exp $ -->
<document>
<header>
@@ -39,6 +39,11 @@
the API documentation for the time being!</em></p>
</li>
</ol>
+
+ <p>Please note that there is separate document on <link
+ href="thumbnails.html">thumbnails</link>!</p>
+
+
<anchor id="sec1" />
<section title="Reading Standard Properties">
1.1 jakarta-poi/src/documentation/xdocs/hpsf/thumbnails.xml
Index: thumbnails.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
"../dtd/document-v11.dtd">
<!-- $Id: thumbnails.xml,v 1.1 2002/05/02 08:00:40 klute Exp $ -->
<document>
<header>
<title>HPSF THUMBNAIL HOW-TO</title>
<authors>
<person name="Drew Varner" email="[EMAIL PROTECTED]" />
</authors>
</header>
<body>
<section title="The VT_CF Format">
<p>
Thumbnail information is stored as a VT_CF, or Thumbnail Variant.
The Thumbnail Variant is used to store various types of information
in a clipboard. The VT_CF can store information in formats for the
Macintosh or Windows clipboard.
</p>
<p>
There are many types of data that can be copied to the clipboard,
but the only types of information needed for thumbnail manipulation are
the image formats.
</p>
<p>The <code>VT_CF</code> structure looks like this:</p>
<table>
<tr>
<th>Element:</th>
<td>Clipboard Size</td>
<td>Clipboard Format Tag</td>
<td>Clipboard Data</td>
</tr>
<tr>
<th>Size:</th>
<td>32 bit unsigned integer (DWord)</td>
<td>32 bit signed integer (DWord)</td>
<td>variable length (byte array)</td>
</tr>
</table>
<p>
The Clipboard Size refers to the size (in bytes) of Clipboard Data
(variable size) plus the Clipboard Format (four bytes).
</p>
<p>Clipboard Format Tag has four possible values:</p>
<table>
<tr>
<th>Value</th>
<th>Identifier</th>
<th>Description</th>
</tr>
<tr>
<td><code>-1L</code></td>
<td><code>CFTAG_WINDOWS</code></td>
<td>a built-in Windows© clipboard format value</td>
</tr>
<tr>
<td><code>-2L</code></td>
<td><code>CFTAG_MACINTOSH</code></td>
<td>a Macintosh clipboard format value</td>
</tr>
<tr>
<td><code>-3L</code></td>
<td><code>CFTAG_FMTID</code></td>
<td>a format identifier (FMTID) This is rarely used.</td>
</tr>
<tr>
<td><code>0L</code></td>
<td><code>CFTAG_NODATA</code></td>
<td>No data This is rarely used.</td>
</tr>
</table>
</section>
<section title="Windows Clipboard Data">
<p>
Windows clipboard data has four image formats for thumbnails:
</p>
<table>
<tr>
<th>Value</th>
<th>Identifier</th>
<th>Description</th>
</tr>
<tr>
<td>3</td>
<td><code>CF_METAFILEPICT</code></td>
<td>Windows metafile format - recommended</td>
</tr>
<tr>
<td>8</td>
<td><code>CF_DIB</code></td>
<td>Device Independent Bitmap</td>
</tr>
<tr>
<td>14</td>
<td><code>CF_ENHMETAFILE</code></td>
<td>Enhanced Windows metafile format</td>
</tr>
<tr>
<td>2</td>
<td><code>CF_BITMAP</code></td>
<td>Bitmap - Obsolete - Use <code>CF_DIB</code> instead</td>
</tr>
</table>
<section title="Windows Metafile Format">
<p>
The most common format for thumbnails on the Windows platform
is the Windows metafile format. The Clipboard places and extra
header in front of a the standard Windows Metafile Format data.
</p>
<p>
The Clipboard Data byte array looks like this when an image is
stored in Windows' Clipboard WMF format.
</p>
<table>
<tr>
<th>Identifier</th>
<td>CF_METAFILEPICT</td>
<td>mm</td>
<td>width</td>
<td>height</td>
<td>handle</td>
<td>WMF data</td>
</tr>
<tr>
<th>Size</th>
<td>32 bit unsigned int</td>
<td>16 bit unsigned(?) int</td>
<td>16 bit unsigned(?) int</td>
<td>16 bit unsigned(?) int</td>
<td>16 bit unsigned(?) int</td>
<td>byte array - variable length</td>
</tr>
<tr>
<th>Description</th>
<td>Clipboard WMF</td>
<td>Mapping Mode</td>
<td>Image Width</td>
<td>Image Height</td>
<td>handle to the WMF data array in memory, or 0</td>
<td>standard WMF byte stream</td>
</tr>
</table>
</section>
<section title="Device Independent Bitmap">
<p><strong>FIXME:</strong> Document Device Independent Bitmap format</p>
</section>
</section>
<section title="Macintosh Clipboard Data">
<p><strong>FIXME:</strong> Document Macintosh clipboard formats.</p>
</section>
</body>
</document>
