[graphic-forms-cvs] r354 - trunk/docs/manual

junrue at common-lisp.net junrue at common-lisp.net
Thu Oct 19 04:39:03 UTC 2006


Author: junrue
Date: Thu Oct 19 00:39:03 2006
New Revision: 354

Added:
   trunk/docs/manual/gf-utils.xsl
Modified:
   trunk/docs/manual/gf-data.xsl
   trunk/docs/manual/gf-package.xsl
   trunk/docs/manual/gfg-symbols.xml
   trunk/docs/manual/image-data-plugins.xml
Log:
 

Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl	(original)
+++ trunk/docs/manual/gf-data.xsl	Thu Oct 19 00:39:03 2006
@@ -11,13 +11,11 @@
 
   <xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
 
+  <xsl:include href="gf-utils.xsl"/>
+
   <xsl:variable name="win32-table" select="document('win32-api-table.xml')"/>
   <xsl:variable name="clhs-table"  select="document('clhs-table.xml')"/>
 
-  <xsl:template name="create-id">
-    <xsl:value-of select="concat(../@name,':', at name)"/>
-  </xsl:template>
-
   <xsl:template name="emit-index-term">
     <xsl:element name="indexterm">
       <xsl:element name="primary">
@@ -31,7 +29,9 @@
 
       <xsl:element name="para">
         <xsl:attribute name="role">normal</xsl:attribute>
-        [<xsl:value-of select="../@name"/>]
+        [<xsl:call-template name="upcase">
+           <xsl:with-param name="orig-text"><xsl:value-of select="../@name"/></xsl:with-param>
+         </xsl:call-template>]
         <xsl:value-of select="$page-type"/>
       </xsl:element>
   </xsl:template>

Modified: trunk/docs/manual/gf-package.xsl
==============================================================================
--- trunk/docs/manual/gf-package.xsl	(original)
+++ trunk/docs/manual/gf-package.xsl	Thu Oct 19 00:39:03 2006
@@ -11,12 +11,9 @@
 
   <xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
 
-  <xsl:param name="symbol-file"/>
+  <xsl:include href="gf-utils.xsl"/>
 
-  <xsl:template name="upcase">
-    <xsl:param name="orig-text"/>
-    <xsl:value-of select="translate($orig-text,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/>
-  </xsl:template>
+  <xsl:param name="symbol-file"/>
 
   <xsl:template match="/package">
 

Added: trunk/docs/manual/gf-utils.xsl
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gf-utils.xsl	Thu Oct 19 00:39:03 2006
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!--
+    gf-utils.xsl
+
+    Copyright (c) 2006, Jack D. Unrue
+-->
+<xsl:stylesheet
+  xmlns:exsl="http://exslt.org/common"
+  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+  version="1.0">
+
+  <xsl:template name="create-id">
+    <xsl:value-of select="concat(../@name,':', at name)"/>
+  </xsl:template>
+
+  <xsl:template name="upcase">
+    <xsl:param name="orig-text"/>
+    <xsl:value-of select="translate($orig-text,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/>
+  </xsl:template>
+
+</xsl:stylesheet>

Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml	(original)
+++ trunk/docs/manual/gfg-symbols.xml	Thu Oct 19 00:39:03 2006
@@ -149,8 +149,8 @@
       <argument name=":transparency-pixel">
         <description>
           A <reftopic>gfs:point</reftopic> identifying a pixel location providing
-          the background color to be used when creating a transparency mask. This
-          location applies to all images except system icons.
+          the background <reftopic>gfg:color</reftopic> to be used when creating a
+          transparency mask. This location applies to all images except system icons.
         </description>
       </argument>
       <argument name=":handle">
@@ -160,7 +160,7 @@
       </argument>
     </initargs>
     <seealso>
-      Image Data Plugins
+      <reftopic>Image Data Plugins</reftopic>
       <reftopic>gfs:dispose</reftopic>
       <reftopic>gfg:icon-bundle-length</reftopic>
       <reftopic>gfg:icon-image-ref</reftopic>
@@ -169,6 +169,104 @@
     </seealso>
   </class>
 
+  <class name="image">
+    <description>
+      <hierarchy>
+        <inherits>
+          <reftopic>gfs:native-object</reftopic>
+        </inherits>
+      </hierarchy>
+      This class wraps a Win32 bitmap handle. Instances may be drawn using
+      <reftopic>gfg:draw-image</reftopic> or displayed within certain controls
+      such as a <reftopic>gfw:label</reftopic>. Image data may be deserialized
+      from a variety of formats.
+    </description>
+    <initargs>
+      <argument name=":file">
+        <description>
+          A <refclhs>pathname</refclhs> identifying an image file to be loaded.
+        </description>
+      </argument>
+      <argument name=":transparency-pixel">
+        <description>
+          A <reftopic>gfs:point</reftopic> identifying a pixel location providing
+          the background <reftopic>gfg:color</reftopic> to be used when creating
+          a transparency mask. This location applies to all images except system icons.
+        </description>
+      </argument>
+      <argument name=":size">
+        <description>
+          A <reftopic>gfs:size</reftopic> specifying the dimensions of a new image
+          to be created.
+        </description>
+      </argument>
+      <argument name=":handle">
+        <description>
+          See <reftopic>gfs:native-object</reftopic>.
+        </description>
+      </argument>
+    </initargs>
+    <seealso>
+      <reftopic>Image Data Plugins</reftopic>
+      <reftopic>gfs:dispose</reftopic>
+      <reftopic>gfg:depth</reftopic>
+      <reftopic>gfg:load</reftopic>
+      <reftopic>gfg:data-object</reftopic>
+      <reftopic>gfg:image-data</reftopic>
+      <reftopic>gfs:size</reftopic>
+      <reftopic>gfg:transparency-mask</reftopic>
+      <reftopic>gfg:with-image-transparency</reftopic>
+    </seealso>
+  </class>
+
+  <class name="image-data">
+    <description>
+      Instances of this class represent images in external formats. Such
+      formats may be loaded and then converted to a <reftopic>gfg:image</reftopic>
+      object. The tasks of setting or querying image attributes is delegated to a
+      plugin object.
+    </description>
+    <initargs>
+      <argument name=":plugin">
+        <description>
+          An instance of <reftopic>gfg:image-data-plugin</reftopic>.
+        </description>
+      </argument>
+    </initargs>
+    <seealso>
+      <reftopic>Image Data Plugins</reftopic>
+      <reftopic>gfg:depth</reftopic>
+      <reftopic>gfs:dispose</reftopic>
+      <reftopic>gfg:load</reftopic>
+      <reftopic>gfg:data-object</reftopic>
+      <reftopic>gfs:size</reftopic>
+    </seealso>
+  </class>
+
+  <class name="image-data-plugin">
+    <description>
+      <hierarchy>
+        <inherits>
+          <reftopic>gfs:native-object</reftopic>
+        </inherits>
+      </hierarchy>
+      This is the base class of plugin objects that encapsulate external
+      library representations of images.
+    </description>
+    <initargs>
+      <argument name=":handle">
+        <description>
+          See <reftopic>gfs:native-object</reftopic>.
+        </description>
+      </argument>
+    </initargs>
+    <seealso>
+      <reftopic>Image Data Plugins</reftopic>
+      <reftopic>gfg:load</reftopic>
+      <reftopic>gfs:dispose</reftopic>
+    </seealso>
+  </class>
+
   <!-- STRUCTURES -->
 
   <structure name="color">
@@ -196,6 +294,7 @@
     </description>
     <seealso>
       <reftopic>gfg:copy-font-data</reftopic>
+      <reftopic>gfg:font</reftopic>
       <reftopic>gfg:data-object</reftopic>
       <reftopic>gfg:make-font-data</reftopic>
     </seealso>

Modified: trunk/docs/manual/image-data-plugins.xml
==============================================================================
--- trunk/docs/manual/image-data-plugins.xml	(original)
+++ trunk/docs/manual/image-data-plugins.xml	Thu Oct 19 00:39:03 2006
@@ -3,8 +3,9 @@
 
     Copyright (c) 2006, Jack D. Unrue
 -->
-<section>
+<section id="Image Data Plugins">
   <title>Image Data Plugins</title>
+  <indexterm><primary>Image Data Plugins</primary></indexterm>
 
   <bridgehead renderas="sect2">Rationale</bridgehead>
 



More information about the Graphic-forms-cvs mailing list