[graphic-forms-cvs] r357 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Thu Oct 19 20:48:21 UTC 2006
Author: junrue
Date: Thu Oct 19 16:48:21 2006
New Revision: 357
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfg-symbols.xml
Log:
fixed bug with multi-argument function syntaxes and setf syntax generation; more symbols documented
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Thu Oct 19 16:48:21 2006
@@ -15,6 +15,7 @@
graphic-forms.chm: gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml
$(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
-hhc htmlhelp.hhp; exit 0 # muffle Error Ignored msg due to hhc exit value 1
+ find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
gfs-tmp-syms.xml: gfs-symbols.xml $(COMMON-DEPS)
$(XSLT-PROC) --output $@ gf-data.xsl gfs-symbols.xml
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Thu Oct 19 16:48:21 2006
@@ -43,6 +43,13 @@
</xsl:copy>
</xsl:template>
+ <xsl:template match="emphasis">
+ <xsl:copy>
+ <xsl:copy-of select="@*"/>
+ <xsl:apply-templates/>
+ </xsl:copy>
+ </xsl:template>
+
<xsl:template name="emit-table">
<xsl:param name="col2-width"/>
@@ -205,18 +212,27 @@
<xsl:if test="@with-setf">
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- (setf (<xsl:value-of select="concat(../../@name,':',../@name)"/>
- <xsl:element name="emphasis">
- <xsl:for-each select="arguments/argument">
- <xsl:value-of select="concat(' ', @name)"/>
- </xsl:for-each>
- </xsl:element>)
+ (setf (<xsl:value-of select="concat(../../@name,':',../@name,' ')"/>
+ <emphasis>
+ <xsl:call-template name="first-word">
+ <xsl:with-param name="raw-text" select="arguments/argument[1]/@name"/>
+ </xsl:call-template>
+ </emphasis>)
+ <emphasis>
+ <xsl:for-each select="arguments/argument">
+ <xsl:if test="position() > 1">
+ <xsl:value-of select="concat(' ', @name)"/>
+ </xsl:if>
+ </xsl:for-each>
+ </emphasis>
<xsl:element name="emphasis">
<xsl:apply-templates select="return"/>
</xsl:element>)
</xsl:element>
</xsl:if>
+ <xsl:apply-templates select="para"/>
+
<xsl:apply-templates select="arguments"/>
</xsl:template>
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 16:48:21 2006
@@ -321,8 +321,260 @@
<!-- FUNCTIONS -->
+ <function name="make-font-data">
+ <syntax>
+ <arguments>
+ <argument name=":char-set integer">
+ <description>
+ A <reftopic label="character set">xxx</reftopic> constant value.
+ </description>
+ </argument>
+ <argument name=":face-name string">
+ <description>
+ A <refclhs>string</refclhs> representing a font face name, such
+ as "Times New Roman".
+ </description>
+ </argument>
+ <argument name=":point-size integer">
+ <description>
+ An <refclhs>integer</refclhs> value representing a font point
+ size. The value 0 is a special instruction to the font mapper to
+ return a font in the default size corresponding to the specified
+ <arg0/> and <arg3/> values.
+ </description>
+ </argument>
+ <argument name=":style list">
+ <description>
+ A <refclhs>list</refclhs> of keyword symbols that further specify
+ attributes of the desired font:
+ <enum>
+ <argument name=":bold">
+ <description>weight, see also :normal</description>
+ </argument>
+ <argument name=":fixed">
+ <description>pitch, see also :variable</description>
+ </argument>
+ <argument name=":italic">
+ <description></description>
+ </argument>
+ <argument name=":normal">
+ <description>weight, see also :bold</description>
+ </argument>
+ <argument name=":outline">
+ <description>precision, see also :truetype-only</description>
+ </argument>
+ <argument name=":strikeout">
+ <description></description>
+ </argument>
+ <argument name=":truetype-only">
+ <description>precision, see also :outline</description>
+ </argument>
+ <argument name=":underline">
+ <description></description>
+ </argument>
+ <argument name=":variable">
+ <description>pitch, see also :fixed</description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:font-data</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfg:font-data</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfg:copy-font-data</reftopic>
+ <reftopic>gfg:font</reftopic>
+ </seealso>
+ </function>
+
+ <function name="copy-font-data">
+ <syntax>
+ <arguments>
+ <argument name="font-data">
+ <description>
+ The <reftopic>gfg:font-data</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new font-data">gfg:font-data</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfg:font-data</reftopic> whose slot values
+ were copied from <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:make-font-data</reftopic>
+ <reftopic>gfg:font</reftopic>
+ </seealso>
+ </function>
+
+ <function name="make-color">
+ <syntax>
+ <arguments>
+ <argument name=":blue integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the blue color component.
+ </description>
+ </argument>
+ <argument name=":green integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the green color component.
+ </description>
+ </argument>
+ <argument name=":red integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the red color component.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:color</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfg:color</reftopic>. Note that all color component
+ values are specified in the range 0 - 255.
+ </description>
+ <seealso>
+ <reftopic>gfg:copy-color</reftopic>
+ </seealso>
+ </function>
+
+ <function name="copy-color">
+ <syntax>
+ <arguments>
+ <argument name="color">
+ <description>
+ The <reftopic>gfg:color</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new color">gfg:color</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfg:color</reftopic> whose blue, green, and
+ red values were copied from <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:make-color</reftopic>
+ </seealso>
+ </function>
+
+ <function name="color-blue">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="color">
+ <description>
+ The <reftopic>gfg:color</reftopic> object whose blue component is
+ to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the blue component of <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:color-green</reftopic>
+ <reftopic>gfg:color-red</reftopic>
+ <reftopic>gfg:make-color</reftopic>
+ </seealso>
+ </function>
+
+ <function name="color-green">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="color">
+ <description>
+ The <reftopic>gfg:color</reftopic> object whose green component is
+ to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the green component of <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:color-red</reftopic>
+ <reftopic>gfg:color-blue</reftopic>
+ <reftopic>gfg:make-color</reftopic>
+ </seealso>
+ </function>
+
+ <function name="color-red">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="color">
+ <description>
+ The <reftopic>gfg:color</reftopic> object whose red component is
+ to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the red component of <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:color-green</reftopic>
+ <reftopic>gfg:color-blue</reftopic>
+ <reftopic>gfg:make-color</reftopic>
+ </seealso>
+ </function>
+
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="data-object">
+ <syntax>
+ <arguments>
+ <argument name="self &optional">
+ <description>
+ The object from which to retrieve (or set) an abstract representation.
+ </description>
+ </argument>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> object.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>object</emphasis>
+ </return>
+ <para role="normal">
+ (setf (gfg:data-object <emphasis>self</emphasis>) <emphasis>object</emphasis>)
+ </para>
+ </syntax>
+ <description>
+ Returns (sets) the abstract representation of <arg0/>. <arg1/> is
+ required when <arg0/> is a <reftopic>gfg:font</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfg:font-data</reftopic>
+ <reftopic>gfg:image-data</reftopic>
+ <reftopic>gfg:image</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="metrics">
<syntax>
<arguments>
@@ -424,7 +676,7 @@
</return>
</syntax>
<description>
- This macro converts a <reftopic>gfg:color</reftopic> to the Win32
+ This macro converts <arg0/> to the Win32
<refwin32api>COLORREF</refwin32api> representation, which in CFFI
terms is defined as an alias for the :unsigned-long type.
</description>
More information about the Graphic-forms-cvs
mailing list