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

[junrue at common-lisp.net]

Author: junrue
Date: Thu Oct 19 18:06:04 2006
New Revision: 358

Modified:
   trunk/docs/manual/gf-data.xsl
   trunk/docs/manual/gfg-symbols.xml
Log:
better handling of optional and macro body argument specifications

Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl	(original)
+++ trunk/docs/manual/gf-data.xsl	Thu Oct 19 18:06:04 2006
@@ -200,7 +200,7 @@
       <xsl:attribute name="role">normal</xsl:attribute>
       (<xsl:value-of select="concat(../../@name,':',../@name)"/>
        <xsl:element name="emphasis">
-         <xsl:for-each select="arguments/argument">
+         <xsl:for-each select="arguments/argument | arguments/notarg">
            <xsl:value-of select="concat(' ', @name)"/>
          </xsl:for-each>
        </xsl:element>) =>

Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml	(original)
+++ trunk/docs/manual/gfg-symbols.xml	Thu Oct 19 18:06:04 2006
@@ -543,14 +543,126 @@
 
   <!-- GENERIC FUNCTIONS -->
 
+  <generic-function name="transparency-mask">
+    <syntax>
+      <arguments>
+        <argument name="self">
+          <description>
+            The object from which a transparency mask is to be computed.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <reftopic>gfg:image</reftopic>
+      </return>
+    </syntax>
+    <description>
+      Returns a <reftopic label="new image">gfg:image</reftopic> that can
+      serve as the transparency mask for <arg0/>, based on the value of
+      <arg0/>'s transparency-pixel slot.
+    </description>
+    <seealso>
+      <reftopic>gfg:with-transparency-pixel</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="depth">
+    <syntax>
+      <arguments>
+        <argument name="self">
+          <description>
+            The object whose bits-per-pixel depth value is to be queried.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <refclhs>integer</refclhs>
+      </return>
+    </syntax>
+    <description>
+      Returns the bits-per-pixel depth of <arg0/>.
+    </description>
+    <seealso>
+      <reftopic>gfg:size</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="size">
+    <syntax>
+      <arguments>
+        <argument name="self">
+          <description>
+            The object whose dimensions are to be set or queried.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <reftopic>gfs:size</reftopic>
+      </return>
+    </syntax>
+    <description>
+      Returns (sets) the size of <arg0/>.
+    </description>
+    <seealso>
+      <reftopic>gfg:depth</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="background-color">
+    <syntax with-setf="t">
+      <arguments>
+        <argument name="self">
+          <description>
+            The object whose background color is to be set or queried.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <reftopic>gfg:color</reftopic>
+      </return>
+    </syntax>
+    <description>
+      Returns (sets) the background color of <arg0/>, used when filling the
+      interior of closed shapes.
+    </description>
+    <seealso>
+      <reftopic>gfg:foreground-color</reftopic>
+      <reftopic>gfg:graphics-context</reftopic>
+    </seealso>
+  </generic-function>
+
+  <generic-function name="foreground-color">
+    <syntax with-setf="t">
+      <arguments>
+        <argument name="self">
+          <description>
+            The object whose foreground color is to be set or queried.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <reftopic>gfg:color</reftopic>
+      </return>
+    </syntax>
+    <description>
+      Returns (sets) the foreground color of <arg0/>, used when drawing
+      lines and rendering text.
+    </description>
+    <seealso>
+      <reftopic>gfg:background-color</reftopic>
+      <reftopic>gfg:graphics-context</reftopic>
+    </seealso>
+  </generic-function>
+
   <generic-function name="data-object">
     <syntax>
       <arguments>
-        <argument name="self &optional">
+        <argument name="self">
           <description>
             The object from which to retrieve (or set) an abstract representation.
           </description>
         </argument>
+        <notarg name="&optional"/>
         <argument name="graphics-context">
           <description>
             A <reftopic>gfg:graphics-context</reftopic> object.
@@ -610,11 +722,12 @@
             The context for measuring the extent of <arg1/>.
           </description>
         </argument>
-        <argument name="string &optional">
+        <argument name="string">
           <description>
             The <refclhs>string</refclhs> whose pixel dimensions are to be computed.
           </description>
         </argument>
+        <notarg name="&optional"/>
         <argument name="style">
           <description>
             A <refclhs>list</refclhs> containing zero or more of the following
@@ -661,6 +774,45 @@
 
   <!-- MACROS -->
 
+  <macro name="with-image-transparency">
+    <syntax>
+      <arguments>
+        <notarg name="("/>
+        <argument name="image">
+          <description>
+            A <reftopic>gfg:image</reftopic> to have its transparency
+            pixel set and then used in <arg2/>.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfs:point</reftopic> identifying the pixel of
+            <arg0/> whose color will be used to create a transparency
+            mask.
+          </description>
+        </argument>
+        <notarg name=")"/>
+        <notarg name="&body"/>
+        <argument name="body">
+          <description>
+            Application code to make use of <arg0/>.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>results</emphasis>
+      </return>
+    </syntax>
+    <description>
+      This macro wraps <arg2/> in an unwind-protect form with <arg1/>
+      set as the transparency pixel for <arg0/>. The original point
+      set in <arg0/>, if any, is restored after <arg2/> completes.
+    </description>
+    <seealso>
+      <reftopic>gfg:transparency-mask</reftopic>
+    </seealso>
+  </macro>
+
   <macro name="color->rgb">
     <syntax>
       <arguments>