[graphic-forms-cvs] r362 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Fri Oct 20 03:41:52 UTC 2006
Author: junrue
Date: Thu Oct 19 23:41:51 2006
New Revision: 362
Modified:
trunk/docs/manual/gfg-symbols.xml
Log:
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 23:41:51 2006
@@ -778,6 +778,8 @@
If <arg2/> and <arg3/> are the same, a complete ellipse is drawn.
</description>
<seealso>
+ <reftopic>gfg:draw-pie-wedge</reftopic>
+ <reftopic>gfg:draw-filled-pie-wedge</reftopic>
<reftopic>gfg:foreground-color</reftopic>
<reftopic>gfg:miter-limit</reftopic>
<reftopic>gfg:pen-style</reftopic>
@@ -855,6 +857,45 @@
<arg3/> and <arg4/> as control points.
</description>
<seealso>
+ <reftopic>gfg:draw-poly-bezier</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:miter-limit</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-poly-bezier">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the the starting
+ location of the curves.
+ </description>
+ </argument>
+ <argument name="list">
+ <description>
+ A <refclhs>list</refclhs> of 3-element sublists, where (first sublist)
+ is the current segment's endpoint, and (second sublist) and
+ (third sublist) are the segments control points.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a series of connected Bézier curves starting at <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-bezier</reftopic>
<reftopic>gfg:foreground-color</reftopic>
<reftopic>gfg:miter-limit</reftopic>
<reftopic>gfg:pen-style</reftopic>
@@ -912,6 +953,9 @@
</para>
</description>
<seealso>
+ <reftopic>gfg:draw-filled-chord</reftopic>
+ <reftopic>gfg:draw-pie-wedge</reftopic>
+ <reftopic>gfg:draw-filled-pie-wedge</reftopic>
<reftopic>gfg:foreground-color</reftopic>
<reftopic>gfg:pen-style</reftopic>
<reftopic>gfg:pen-width</reftopic>
@@ -969,6 +1013,9 @@
</para>
</description>
<seealso>
+ <reftopic>gfg:draw-chord</reftopic>
+ <reftopic>gfg:draw-pie-wedge</reftopic>
+ <reftopic>gfg:draw-filled-pie-wedge</reftopic>
<reftopic>gfg:background-color</reftopic>
<reftopic>gfg:foreground-color</reftopic>
<reftopic>gfg:pen-style</reftopic>
@@ -976,6 +1023,123 @@
</seealso>
</generic-function>
+ <generic-function name="draw-pie-wedge">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse
+ from which the arc component of the wedge is obtained.
+ </description>
+ </argument>
+ <argument name="start-point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the beginning of the
+ rendered arc.
+ </description>
+ </argument>
+ <argument name="end-point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the end of the
+ rendered arc.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a pie-shaped wedge whose curve is formed by the ellipse bound
+ by <arg1/>, in a counter-clockwise direction from <arg2/> to <arg3/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-chord</reftopic>
+ <reftopic>gfg:draw-filled-chord</reftopic>
+ <reftopic>gfg:draw-filled-pie-wedge</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-filled-pie-wedge">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ A bounding <reftopic>gfs:rectangle</reftopic> for an ellipse
+ from which the arc component of the wedge is obtained.
+ </description>
+ </argument>
+ <argument name="start-point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the beginning of the
+ rendered arc.
+ </description>
+ </argument>
+ <argument name="end-point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the end of the
+ rendered arc.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Fills a pie-shaped wedge whose curve is formed by the ellipse bound
+ by <arg1/>, in a counter-clockwise direction from <arg2/> to <arg3/>.
+ The current background color is used for the interior.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-filled-chord</reftopic>
+ <reftopic>gfg:draw-filled-pie-wedge</reftopic>
+ <reftopic>gfg:background-color</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-point">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> identifying the pixel location.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Sets a single pixel at <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:foreground-color</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="draw-ellipse">
<syntax>
<arguments>
@@ -999,6 +1163,7 @@
Draws an ellipse bounded by <arg1/>.
</description>
<seealso>
+ <reftopic>gfg:draw-filled-ellipse</reftopic>
<reftopic>gfg:foreground-color</reftopic>
<reftopic>gfg:pen-style</reftopic>
<reftopic>gfg:pen-width</reftopic>
@@ -1028,6 +1193,151 @@
Fills an ellipse bounded by <arg1/> with the current background color.
</description>
<seealso>
+ <reftopic>gfg:draw-ellipse</reftopic>
+ <reftopic>gfg:background-color</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-rectangle">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ The <reftopic>gfs:rectangle</reftopic> to be drawn.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a rectangle.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-polygon</reftopic>
+ <reftopic>gfg:draw-rounded-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rounded-rectangle</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-rounded-rectangle">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ The <reftopic>gfs:rectangle</reftopic> to be drawn.
+ </description>
+ </argument>
+ <argument name="size">
+ <description>
+ The <reftopic>gfs:size</reftopic> of an ellipse determining
+ the arc used for rounding the rectangle's corners.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a rectangle with rounded corners.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-polygon</reftopic>
+ <reftopic>gfg:draw-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rounded-rectangle</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-filled-rounded-rectangle">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ The <reftopic>gfs:rectangle</reftopic> to be drawn.
+ </description>
+ </argument>
+ <argument name="size">
+ <description>
+ The <reftopic>gfs:size</reftopic> of an ellipse determining
+ the arc used for rounding the rectangle's corners.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Fills a rectangle having rounded corners with the current
+ background color.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-polygon</reftopic>
+ <reftopic>gfg:draw-rectangle</reftopic>
+ <reftopic>gfg:draw-rounded-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rounded-rectangle</reftopic>
+ <reftopic>gfg:background-color</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-filled-rectangle">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="rectangle">
+ <description>
+ The <reftopic>gfs:rectangle</reftopic> to be filled.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Fills a rectangle with the current background color.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-polygon</reftopic>
+ <reftopic>gfg:draw-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rectangle</reftopic>
+ <reftopic>gfg:draw-filled-rounded-rectangle</reftopic>
<reftopic>gfg:background-color</reftopic>
<reftopic>gfg:foreground-color</reftopic>
<reftopic>gfg:pen-style</reftopic>
@@ -1064,6 +1374,109 @@
Draws a line between <arg1/> and <arg2/>.
</description>
<seealso>
+ <reftopic>gfg:draw-polyline</reftopic>
+ <reftopic>gfg:draw-polygon</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:miter-limit</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-polygon">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="list">
+ <description>
+ A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ defining the polygon's line segments.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a series of connected line segments determined by <arg1/>. The
+ last point in <arg1/> is connected with the first. If <arg1/> contains
+ less than three points, then this function does nothing.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-line</reftopic>
+ <reftopic>gfg:draw-polyline</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-filled-polygon">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="list">
+ <description>
+ A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ defining the polygon's line segments.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Fills a closed shape defined by a series of connected line segments
+ determined by <arg1/>. The last point in <arg1/> is connected with
+ the first. The current background color is used. If <arg1/> contains
+ less than three points, then this function does nothing.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-filled-rectangle</reftopic>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:background-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-polyline">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="list">
+ <description>
+ A <refclhs>list</refclhs> of <reftopic>gfg:point</reftopic>s
+ defining line segments.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a series of connected line segments (the last point in
+ <arg1/> is not connected to the first). If <arg1/> contains less than
+ two points, then this function does nothing.
+ </description>
+ <seealso>
+ <reftopic>gfg:draw-line</reftopic>
+ <reftopic>gfg:draw-polygon</reftopic>
<reftopic>gfg:foreground-color</reftopic>
<reftopic>gfg:miter-limit</reftopic>
<reftopic>gfg:pen-style</reftopic>
@@ -1467,7 +1880,7 @@
<arguments>
<argument name="graphics-context">
<description>
- The <reftopic>gfg:graphics-context</reftopic> whose pen width
+ The <reftopic>gfg:graphics-context</reftopic> whose miter limit
value is to be retrieved or set.
</description>
</argument>
More information about the Graphic-forms-cvs
mailing list