[graphic-forms-cvs] r349 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Wed Oct 18 23:12:45 UTC 2006
Author: junrue
Date: Wed Oct 18 19:12:42 2006
New Revision: 349
Modified:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-symbols.xml
Log:
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 19:12:42 2006
@@ -136,6 +136,21 @@
</xsl:element>
</xsl:element>
+ <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>)
+ <xsl:element name="emphasis">
+ <xsl:apply-templates select="return"/>
+ </xsl:element>)
+ </xsl:element>
+ </xsl:if>
+
<xsl:apply-templates select="arguments"/>
</xsl:template>
@@ -146,7 +161,14 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
<xsl:element name="emphasis">
- <xsl:value-of select="@name"/>
+ <xsl:choose>
+ <xsl:when test="contains(@name,' ')">
+ <xsl:value-of select="substring-before(@name,' ')"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="@name"/>
+ </xsl:otherwise>
+ </xsl:choose>
</xsl:element>
</xsl:element>
</xsl:element>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 19:12:42 2006
@@ -230,18 +230,6 @@
<description>
This structure represents a point in the Cartesian plane.
</description>
- <initargs>
- <argument name=":x">
- <description>
- An <refclhs>integer</refclhs> specifying the point's X coordinate.
- </description>
- </argument>
- <argument name=":y">
- <description>
- An <refclhs>integer</refclhs> specifying the point's Y coordinate.
- </description>
- </argument>
- </initargs>
<seealso>
<reftopic>gfs:copy-point</reftopic>
<reftopic>gfs:make-point</reftopic>
@@ -279,18 +267,6 @@
<description>
This structure represents a 2-dimensional area.
</description>
- <initargs>
- <argument name=":height">
- <description>
- An <refclhs>integer</refclhs> specifying the height of the area.
- </description>
- </argument>
- <argument name=":width">
- <description>
- An <refclhs>integer</refclhs> specifying the width of the area.
- </description>
- </argument>
- </initargs>
<seealso>
<reftopic>gfs:copy-size</reftopic>
<reftopic>gfs:equal-size-p</reftopic>
@@ -303,21 +279,9 @@
<structure name="span">
<description>
- This structure represents a contiguous range of <refclhs>integer</refclhs>
- values.
+ This structure represents a contiguous (inclusive) range of
+ <refclhs>integer</refclhs> values.
</description>
- <initargs>
- <argument name=":start">
- <description>
- An <refclhs>integer</refclhs> specifying the starting value.
- </description>
- </argument>
- <argument name=":end">
- <description>
- An <refclhs>integer</refclhs> specifying the ending value.
- </description>
- </argument>
- </initargs>
<seealso>
<reftopic>gfs:copy-span</reftopic>
<reftopic>gfs:empty-span-p</reftopic>
@@ -329,6 +293,32 @@
<!-- FUNCTIONS -->
+ <function name="make-point">
+ <syntax>
+ <arguments>
+ <argument name=":x integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the X coordinate.
+ </description>
+ </argument>
+ <argument name=":y integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the Y coordinate.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new point">gfs:point</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:point</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfs:copy-point</reftopic>
+ </seealso>
+ </function>
+
<function name="copy-point">
<syntax>
<arguments>
@@ -352,7 +342,7 @@
</function>
<function name="location">
- <syntax>
+ <syntax with-setf="t">
<arguments>
<argument name="rectangle">
<description>
@@ -372,6 +362,59 @@
</description>
<seealso>
<reftopic>gfs:make-rectangle</reftopic>
+ <reftopic>gfs:size</reftopic>
+ </seealso>
+ </function>
+
+ <function name="size">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="rectangle">
+ <description>
+ The <reftopic>gfs:rectangle</reftopic> to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfs:size</reftopic> identifying the dimensions
+ of <refargument>rectangle</refargument>. For performance reasons, the
+ existing slot value is returned directly rather than being copied.
+ </description>
+ <seealso>
+ <reftopic>gfs:make-rectangle</reftopic>
+ <reftopic>gfs:location</reftopic>
+ </seealso>
+ </function>
+
+ <function name="make-rectangle">
+ <syntax>
+ <arguments>
+ <argument name=":location point">
+ <description>
+ An <reftopic>gfs:point</reftopic> specifying the coordinates of the
+ upper-left corner of the rectangle.
+ </description>
+ </argument>
+ <argument name=":size size">
+ <description>
+ A <reftopic>gfs:size</reftopic> specifing the dimensions of the
+ rectangle.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new rectangle">gfs:rectangle</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:rectangle</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfs:copy-rectangle</reftopic>
</seealso>
</function>
@@ -416,6 +459,34 @@
</description>
<seealso>
<reftopic>gfs:make-size</reftopic>
+ <reftopic>gfs:equal-size-p</reftopic>
+ </seealso>
+ </function>
+
+ <function name="make-size">
+ <syntax>
+ <arguments>
+ <argument name=":height integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the height.
+ </description>
+ </argument>
+ <argument name=":width integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the width.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new size">gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:size</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfs:copy-size</reftopic>
+ <reftopic>gfs:equal-size-p</reftopic>
</seealso>
</function>
@@ -441,6 +512,33 @@
</seealso>
</function>
+ <function name="make-span">
+ <syntax>
+ <arguments>
+ <argument name=":end integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the ending value.
+ </description>
+ </argument>
+ <argument name=":start integer">
+ <description>
+ An <refclhs>integer</refclhs> specifying the starting value.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new span">gfs:span</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:span</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfs:copy-span</reftopic>
+ <reftopic>gfs:empty-span-p</reftopic>
+ </seealso>
+ </function>
+
<function name="empty-span-p">
<syntax>
<arguments>
@@ -565,6 +663,138 @@
<!-- ACCESSORS -->
+ <slot-accessor name="point-x">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="point">
+ <description>
+ The <reftopic>gfs:point</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the X coordinate of <refargument>point</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfs:point-y</reftopic>
+ <reftopic>gfs:make-point</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="point-y">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="point">
+ <description>
+ The <reftopic>gfs:point</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the Y coordinate of <refargument>point</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfs:point-x</reftopic>
+ <reftopic>gfs:make-point</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="size-width">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="size">
+ <description>
+ The <reftopic>gfs:size</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the width value of <refargument>size</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfs:size-height</reftopic>
+ <reftopic>gfs:make-size</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="size-height">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="size">
+ <description>
+ The <reftopic>gfs:size</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the height value of <refargument>size</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfs:size-width</reftopic>
+ <reftopic>gfs:make-size</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="span-start">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="span">
+ <description>
+ The <reftopic>gfs:span</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the starting value of <refargument>span</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfs:span-end</reftopic>
+ <reftopic>gfs:make-span</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="span-end">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="span">
+ <description>
+ The <reftopic>gfs:span</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the ending value of <refargument>span</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfs:span-start</reftopic>
+ <reftopic>gfs:make-span</reftopic>
+ </seealso>
+ </slot-accessor>
+
<slot-reader name="handle">
<syntax>
<arguments>
More information about the Graphic-forms-cvs
mailing list