graphic-forms-cvs
Threads by month
- ----- 2025 -----
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2024 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2023 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2022 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2021 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2020 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2019 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2018 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2017 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2016 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2015 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2014 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2013 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2012 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2011 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2010 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2009 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2008 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2007 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
- January
- ----- 2006 -----
- December
- November
- October
- September
- August
- July
- June
- May
- April
- March
- February
October 2006
- 1 participants
- 102 discussions
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>
1
0
Author: junrue
Date: Thu Oct 19 22:50:56 2006
New Revision: 361
Modified:
trunk/docs/manual/constants.xml
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfg-symbols.xml
Log:
Modified: trunk/docs/manual/constants.xml
==============================================================================
--- trunk/docs/manual/constants.xml (original)
+++ trunk/docs/manual/constants.xml Thu Oct 19 22:50:56 2006
@@ -12,7 +12,7 @@
each package.
</para>
- <bridgehead renderas="sect2">character sets [GFG]</bridgehead>
+ <bridgehead renderas="sect2">Character Sets [GFG]</bridgehead>
<informaltable frame="none">
<anchor id="character sets"/>
@@ -43,7 +43,7 @@
</tgroup>
</informaltable>
- <bridgehead renderas="sect2">colors [GFG]</bridgehead>
+ <bridgehead renderas="sect2">Standard Colors [GFG]</bridgehead>
<informaltable frame="none">
<anchor id="colors"/>
@@ -59,7 +59,7 @@
</tgroup>
</informaltable>
- <bridgehead renderas="sect2">system icons [GFG]</bridgehead>
+ <bridgehead renderas="sect2">System Icons [GFG]</bridgehead>
<informaltable frame="none">
<anchor id="system icons"/>
@@ -75,6 +75,77 @@
</tgroup>
</informaltable>
+ <bridgehead renderas="sect2">Virtual Key Codes [GFW]</bridgehead>
+
+ <informaltable frame="none">
+ <anchor id="virtual key codes"/>
+ <indexterm><primary>virtual key codes</primary></indexterm>
+ <tgroup cols="1">
+ <tbody>
+ <row><entry><para role="normal">+vk-break+</para></entry></row>
+ <row><entry><para role="normal">+vk-backspace+</para></entry></row>
+ <row><entry><para role="normal">+vk-tab+</para></entry></row>
+ <row><entry><para role="normal">+vk-clear+</para></entry></row>
+ <row><entry><para role="normal">+vk-return+</para></entry></row>
+ <row><entry><para role="normal">+vk-shift+</para></entry></row>
+ <row><entry><para role="normal">+vk-control+</para></entry></row>
+ <row><entry><para role="normal">+vk-alt+</para></entry></row>
+ <row><entry><para role="normal">+vk-pause+</para></entry></row>
+ <row><entry><para role="normal">+vk-caps-lock+</para></entry></row>
+ <row><entry><para role="normal">+vk-escape+</para></entry></row>
+ <row><entry><para role="normal">+vk-page-up+</para></entry></row>
+ <row><entry><para role="normal">+vk-page-down+</para></entry></row>
+ <row><entry><para role="normal">+vk-end+</para></entry></row>
+ <row><entry><para role="normal">+vk-home+</para></entry></row>
+ <row><entry><para role="normal">+vk-left+</para></entry></row>
+ <row><entry><para role="normal">+vk-up+</para></entry></row>
+ <row><entry><para role="normal">+vk-right+</para></entry></row>
+ <row><entry><para role="normal">+vk-down+</para></entry></row>
+ <row><entry><para role="normal">+vk-insert+</para></entry></row>
+ <row><entry><para role="normal">+vk-delete+</para></entry></row>
+ <row><entry><para role="normal">+vk-help+</para></entry></row>
+ <row><entry><para role="normal">+vk-left-win+</para></entry></row>
+ <row><entry><para role="normal">+vk-right-win+</para></entry></row>
+ <row><entry><para role="normal">+vk-applications+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-0+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-1+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-2+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-3+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-4+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-5+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-6+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-7+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-8+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-9+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-*+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-++</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad--+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-.+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-/+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f1+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f2+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f3+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f4+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f5+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f6+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f7+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f8+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f9+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f10+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f11+</para></entry></row>
+ <row><entry><para role="normal">+vk-numpad-f12+</para></entry></row>
+ <row><entry><para role="normal">+vk-num-lock+</para></entry></row>
+ <row><entry><para role="normal">+vk-scroll-lock+</para></entry></row>
+ <row><entry><para role="normal">+vk-left-shift+</para></entry></row>
+ <row><entry><para role="normal">+vk-right-shift+</para></entry></row>
+ <row><entry><para role="normal">+vk-left-control+</para></entry></row>
+ <row><entry><para role="normal">+vk-right-control+</para></entry></row>
+ <row><entry><para role="normal">+vk-left-alt+</para></entry></row>
+ <row><entry><para role="normal">+vk-right-alt+</para></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
<para role="normal"/>
</chapter>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Thu Oct 19 22:50:56 2006
@@ -36,21 +36,14 @@
</xsl:element>
</xsl:template>
- <xsl:template match="para">
+ <xsl:template match="para | emphasis | itemizedlist | listitem">
<xsl:copy>
<xsl:copy-of select="@*"/>
<xsl:apply-templates/>
</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:template name="emit-sorted-table">
<xsl:param name="col2-width"/>
<xsl:element name="informaltable">
@@ -72,6 +65,26 @@
</xsl:element>
</xsl:template>
+ <xsl:template name="emit-unsorted-table">
+ <xsl:param name="col2-width"/>
+
+ <xsl:element name="informaltable">
+ <xsl:attribute name="frame">none</xsl:attribute>
+ <xsl:element name="tgroup">
+ <xsl:attribute name="cols">2</xsl:attribute>
+ <xsl:element name="colspec">
+ <xsl:attribute name="colwidth">*</xsl:attribute>
+ </xsl:element>
+ <xsl:element name="colspec">
+ <xsl:attribute name="colwidth"><xsl:value-of select="$col2-width"/></xsl:attribute>
+ </xsl:element>
+ <xsl:element name="tbody">
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:element>
+ </xsl:template>
+
<xsl:template name="find-arg">
<xsl:param name="index"/>
<xsl:variable name="raw-text">
@@ -264,7 +277,7 @@
<xsl:attribute name="renderas">sect2</xsl:attribute>
arguments
</xsl:element>
- <xsl:call-template name="emit-table">
+ <xsl:call-template name="emit-unsorted-table">
<xsl:with-param name="col2-width">5*</xsl:with-param>
</xsl:call-template>
</xsl:template>
@@ -281,7 +294,7 @@
</xsl:element>
</xsl:element>
</xsl:for-each>
- <xsl:call-template name="emit-table">
+ <xsl:call-template name="emit-sorted-table">
<xsl:with-param name="col2-width">5*</xsl:with-param>
</xsl:call-template>
</xsl:template>
@@ -294,7 +307,7 @@
</xsl:element>
</xsl:element>
</xsl:for-each>
- <xsl:call-template name="emit-table">
+ <xsl:call-template name="emit-sorted-table">
<xsl:with-param name="col2-width">5*</xsl:with-param>
</xsl:call-template>
</xsl:template>
@@ -340,7 +353,7 @@
</xsl:template>
<xsl:template match="hierarchy">
- <xsl:call-template name="emit-table">
+ <xsl:call-template name="emit-sorted-table">
<xsl:with-param name="col2-width">8*</xsl:with-param>
</xsl:call-template>
</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 22:50:56 2006
@@ -282,6 +282,7 @@
<reftopic>gfg:color-blue</reftopic>
<reftopic>gfg:color->rgb</reftopic>
<reftopic>gfg:rgb->color</reftopic>
+ <reftopic label="Standard Colors">colors</reftopic>
</seealso>
</structure>
@@ -738,6 +739,338 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="draw-arc">
+ <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 rendered arc 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 an arc whose curve is formed by the ellipse bound by <arg1/>, in
+ a counter-clockwise direction from <arg2/> where it intersects a radial
+ originating at the center of <arg1/>. The arc ends at <arg3/> where it
+ intersects another radial also originating at the center of <arg1/>.
+ If <arg2/> and <arg3/> are the same, a complete ellipse is drawn.
+ </description>
+ <seealso>
+ <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-image">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="image">
+ <description>
+ A <reftopic>gfg:image</reftopic> to be drawn.
+ </description>
+ </argument>
+ <argument name="point">
+ <description>
+ A <reftopic>gfs:point</reftopic> specifying the location of the
+ upper-left corner of <arg1/>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ This function draws <arg1/> with its upper-left corner positioned
+ at <arg2/> in the drawing surface's coordinate system.
+ </description>
+ </generic-function>
+
+ <generic-function name="draw-bezier">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </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>
+ <argument name="ctrl-point-1">
+ <description>
+ The first control <reftopic>gfs:point</reftopic>.
+ </description>
+ </argument>
+ <argument name="ctrl-point-2">
+ <description>
+ The second control <reftopic>gfs:point</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a Bézier curve between <arg1/> and <arg2/> using
+ <arg3/> and <arg4/> as control points.
+ </description>
+ <seealso>
+ <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-chord">
+ <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 rendered chord 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 closed shape comprised of:
+ <itemizedlist mark="bullet" spacing="compact">
+ <listitem>
+ an arc whose curve is formed by the ellipse bound by <arg1/>, in
+ a counter-clockwise direction from <arg2/> where it intersects a
+ radial originating at the center of <arg1/>. The arc ends at
+ <arg3/>, where it intersects another radial also originating at
+ the center of <arg1/>
+ </listitem>
+ <listitem>
+ a line drawn between <arg2/> and <arg3/>
+ </listitem>
+ </itemizedlist>
+ <para role="normal">
+ If <arg2/> and <arg3/> are the same, a complete ellipse is drawn.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-filled-chord">
+ <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 rendered chord 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 closed shape comprised of:
+ <itemizedlist mark="bullet" spacing="compact">
+ <listitem>
+ an arc whose curve is formed by the ellipse bound by <arg1/>, in
+ a counter-clockwise direction from <arg2/> where it intersects a
+ radial originating at the center of <arg1/>. The arc ends at
+ <arg3/>, where it intersects another radial also originating at
+ the center of <arg1/>
+ </listitem>
+ <listitem>
+ a line drawn between <arg2/> and <arg3/>
+ </listitem>
+ </itemizedlist>
+ <para role="normal">
+ with the current background color. If <arg2/> and <arg3/> are the
+ same, a complete ellipse is drawn.
+ </para>
+ </description>
+ <seealso>
+ <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-ellipse">
+ <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 rendered chord is obtained.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws an ellipse bounded by <arg1/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:foreground-color</reftopic>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="draw-filled-ellipse">
+ <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 rendered chord is obtained.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Fills an ellipse bounded by <arg1/> with the current background color.
+ </description>
+ <seealso>
+ <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-line">
+ <syntax>
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+ </description>
+ </argument>
+ <argument name="start-point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the beginning of the
+ line.
+ </description>
+ </argument>
+ <argument name="end-point">
+ <description>
+ A <reftopic>gfs:point</reftopic> indicating the end of the
+ line.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <emphasis>undefined</emphasis>
+ </return>
+ </syntax>
+ <description>
+ Draws a line between <arg1/> and <arg2/>.
+ </description>
+ <seealso>
+ <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="load">
<syntax>
<arguments>
1
0
Author: junrue
Date: Thu Oct 19 20:40:25 2006
New Revision: 360
Added:
trunk/docs/manual/constants.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/api.xml
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/graphic-forms.xml
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Thu Oct 19 20:40:25 2006
@@ -5,6 +5,9 @@
# Copyright (c) 2006, Jack D. Unrue
#
+CHM-DEPS = gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml constants.xml api.xml \
+ catalog.xml glossary.xml graphic-forms.xml image-data-plugins.xml \
+ introduction.xml legal.xml miscellaneous-topics.xml
COMMON-DEPS = gf-data.xsl gf-package.xsl clhs-table.xml win32-api-table.xml
TMP-XML = gfs-tmp-pkg.xml gfs-tmp-syms.xml gfg-tmp-pkg.xml gfg-tmp-syms.xml \
@@ -12,7 +15,7 @@
XSLT-PROC = xsltproc --nonet
-graphic-forms.chm: gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml
+graphic-forms.chm: $(CHM-DEPS)
$(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 {} \;
Modified: trunk/docs/manual/api.xml
==============================================================================
--- trunk/docs/manual/api.xml (original)
+++ trunk/docs/manual/api.xml Thu Oct 19 20:40:25 2006
@@ -10,6 +10,7 @@
This chapter documents the Graphic-Forms programming interface.
</para>
+ &constants;
&gfgpkg;
&gfspkg;
&gfwpkg;
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Thu Oct 19 20:40:25 2006
@@ -8,6 +8,7 @@
<clhs-table>
<entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
<entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/>
<entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
<entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
<entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/>
Added: trunk/docs/manual/constants.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/constants.xml Thu Oct 19 20:40:25 2006
@@ -0,0 +1,80 @@
+<!--
+ constants.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+<chapter>
+ <title>Constants and Variables</title>
+ <indexterm><primary>constants</primary></indexterm>
+
+ <para role="normal">
+ This section lists the symbols for constants and variables exported from
+ each package.
+ </para>
+
+ <bridgehead renderas="sect2">character sets [GFG]</bridgehead>
+
+ <informaltable frame="none">
+ <anchor id="character sets"/>
+ <indexterm><primary>character sets</primary></indexterm>
+ <tgroup cols="1">
+ <tbody>
+ <row><entry><para role="normal">+ansi-charset+</para></entry></row>
+ <row><entry><para role="normal">+arabic-charset+</para></entry></row>
+ <row><entry><para role="normal">+baltic-charset+</para></entry></row>
+ <row><entry><para role="normal">+chinesebig5-charset+</para></entry></row>
+ <row><entry><para role="normal">+default-charset+</para></entry></row>
+ <row><entry><para role="normal">+easteurope-charset+</para></entry></row>
+ <row><entry><para role="normal">+gb2312-charset+</para></entry></row>
+ <row><entry><para role="normal">+greek-charset+</para></entry></row>
+ <row><entry><para role="normal">+hangeul-charset+</para></entry></row>
+ <row><entry><para role="normal">+hangul-charset+</para></entry></row>
+ <row><entry><para role="normal">+hebrew-charset+</para></entry></row>
+ <row><entry><para role="normal">+johab-charset+</para></entry></row>
+ <row><entry><para role="normal">+mac-charset+</para></entry></row>
+ <row><entry><para role="normal">+oem-charset+</para></entry></row>
+ <row><entry><para role="normal">+russian-charset+</para></entry></row>
+ <row><entry><para role="normal">+shiftjis-charset+</para></entry></row>
+ <row><entry><para role="normal">+symbol-charset+</para></entry></row>
+ <row><entry><para role="normal">+thai-charset+</para></entry></row>
+ <row><entry><para role="normal">+turkish-charset+</para></entry></row>
+ <row><entry><para role="normal">+vietnamese-charset+</para></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <bridgehead renderas="sect2">colors [GFG]</bridgehead>
+
+ <informaltable frame="none">
+ <anchor id="colors"/>
+ <indexterm><primary>colors</primary></indexterm>
+ <tgroup cols="1">
+ <tbody>
+ <row><entry><para role="normal">*color-black*</para></entry></row>
+ <row><entry><para role="normal">*color-blue*</para></entry></row>
+ <row><entry><para role="normal">*color-green*</para></entry></row>
+ <row><entry><para role="normal">*color-red*</para></entry></row>
+ <row><entry><para role="normal">*color-white*</para></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <bridgehead renderas="sect2">system icons [GFG]</bridgehead>
+
+ <informaltable frame="none">
+ <anchor id="system icons"/>
+ <indexterm><primary>system icons</primary></indexterm>
+ <tgroup cols="1">
+ <tbody>
+ <row><entry><para role="normal">+application-icon+</para></entry></row>
+ <row><entry><para role="normal">+error-icon+</para></entry></row>
+ <row><entry><para role="normal">+information-icon+</para></entry></row>
+ <row><entry><para role="normal">+question-icon+</para></entry></row>
+ <row><entry><para role="normal">+warning-icon+</para></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para role="normal"/>
+
+</chapter>
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 20:40:25 2006
@@ -143,7 +143,7 @@
</argument>
<argument name=":system">
<description>
- An icon identifier constant.
+ A <reftopic label="system icon">system icons</reftopic> constant.
</description>
</argument>
<argument name=":transparency-pixel">
@@ -437,7 +437,7 @@
<arguments>
<argument name=":char-set">
<description>
- A <reftopic label="character set">xxx</reftopic> constant value.
+ A <reftopic>character sets</reftopic> constant value.
</description>
</argument>
<notarg name="integer"/>
@@ -738,6 +738,47 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="load">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object to be populated with data.
+ </description>
+ </argument>
+ <argument name="pathname">
+ <description>
+ A <refclhs>string</refclhs> or <refclhs>pathname</refclhs>
+ identifying the graphics data file to be loaded.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Certain graphics objects have a persistent representation, which may
+ be deserialized with the appropriate implementation of this function.
+ <arg0/> will be re-initialized with data from the file identified by
+ <arg1/>. Certain serialized object formats (e.g., ICO) may actually
+ describe multiple instances. To facilitate such formats, this function
+ returns <arg0/> plus any additional instances in a <refclhs>list</refclhs>,
+ ordered the same as they are read from the file.
+ </para>
+
+ <para role="normal">
+ Note: this symbol shadows the Common Lisp symbol of the same name.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfg:image-data</reftopic>
+ <reftopic>Image Data Plugins</reftopic>
+ <reftopic>gfg:image</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="font">
<syntax with-setf="t">
<arguments>
@@ -1088,6 +1129,34 @@
</seealso>
</slot-accessor>
+ <slot-accessor name="miter-limit">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ The <reftopic>gfg:graphics-context</reftopic> whose pen width
+ value is to be retrieved or set.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>float</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) a <refclhs>float</refclhs> value describing the allowable
+ ratio of miter length to line width. The miter length is the distance
+ from the intersection of the line walls on the inside of a join to the
+ intersection of the line walls on the outside of the same join. The
+ default value is 10.0. This value affects the :miter-join pen style.
+ </description>
+ <seealso>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ <reftopic>gfg:draw-line</reftopic>
+ </seealso>
+ </slot-accessor>
+
<!-- MACROS -->
<macro name="with-image-transparency">
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Thu Oct 19 20:40:25 2006
@@ -9,6 +9,7 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
+ <!ENTITY constants SYSTEM "constants.xml">
<!ENTITY gfgpkg SYSTEM "gfg-tmp-pkg.xml"> <!-- generated file -->
<!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml"> <!-- generated file -->
<!ENTITY gfwpkg SYSTEM "gfw-tmp-pkg.xml"> <!-- generated file -->
1
0
Author: junrue
Date: Thu Oct 19 19:30:29 2006
New Revision: 359
Modified:
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/gfs-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 19:30:29 2006
@@ -321,21 +321,134 @@
<!-- FUNCTIONS -->
+ <function name="icon-bundle-length">
+ <syntax>
+ <arguments>
+ <argument name="icon-bundle">
+ <description>
+ The <reftopic>gfg:icon-bundle</reftopic> whose length is to
+ be returned.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the number of images in <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:icon-image-ref</reftopic>
+ <reftopic>gfg:push-icon-image</reftopic>
+ <reftopic>gfg:image</reftopic>
+ </seealso>
+ </function>
+
+ <function name="push-icon-image">
+ <syntax>
+ <arguments>
+ <argument name="image">
+ <description>
+ The <reftopic>gfg:image</reftopic> being added to <arg1/>.
+ </description>
+ </argument>
+ <argument name="icon-bundle">
+ <description>
+ The <reftopic>gfg:icon-bundle</reftopic> taking ownership of
+ <arg0/>.
+ </description>
+ </argument>
+ <notarg name="&optional"/>
+ <argument name="point">
+ <description>
+ The <reftopic>gfs:point</reftopic> specifying the location of
+ a pixel within <arg0/> whose color will be used to compute a
+ transparency mask. By default, the pixel at (0, 0) will be used.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:icon-bundle</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Use this function to add a new <reftopic>gfg:image</reftopic> to
+ <arg1/> (which assumes ownership of <arg0/>).
+ </description>
+ <seealso>
+ <reftopic>gfg:icon-image-ref</reftopic>
+ <reftopic>gfg:icon-bundle-length</reftopic>
+ </seealso>
+ </function>
+
+ <function name="icon-image-ref">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="icon-bundle">
+ <description>
+ The <reftopic>gfg:icon-bundle</reftopic> from (into) which
+ a <reftopic>gfg:image</reftopic> is to be retrieved (set).
+ </description>
+ </argument>
+ <argument name="subscript">
+ <description>
+ Either a zero-based integer subscript, or one of the following
+ keyword symbols:
+ <enum>
+ <argument name=":large">
+ <description>
+ Selects the largest image in <arg0/>.
+ </description>
+ </argument>
+ <argument name=":small">
+ <description>
+ Selects the smallest image in <arg0/>.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:image</reftopic>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ This function allows images within <arg0/> to be retrieved or
+ set via a subscript.
+ </para>
+ <para role="normal">
+ Note: there are actually four icon sizes that Windows defines
+ for use in various contexts. A future release of Graphic-Forms
+ will add keywords to better distinguish amongst all four, and
+ to help ensure selection of the appropriate size.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfg:icon-bundle-length</reftopic>
+ <reftopic>gfg:push-icon-image</reftopic>
+ </seealso>
+ </function>
+
<function name="make-font-data">
<syntax>
<arguments>
- <argument name=":char-set integer">
+ <argument name=":char-set">
<description>
A <reftopic label="character set">xxx</reftopic> constant value.
</description>
</argument>
- <argument name=":face-name string">
+ <notarg name="integer"/>
+ <argument name=":face-name">
<description>
A <refclhs>string</refclhs> representing a font face name, such
as "Times New Roman".
</description>
</argument>
- <argument name=":point-size integer">
+ <notarg name="string"/>
+ <argument name=":point-size">
<description>
An <refclhs>integer</refclhs> value representing a font point
size. The value 0 is a special instruction to the font mapper to
@@ -343,7 +456,8 @@
<arg0/> and <arg3/> values.
</description>
</argument>
- <argument name=":style list">
+ <notarg name="integer"/>
+ <argument name=":style">
<description>
A <refclhs>list</refclhs> of keyword symbols that further specify
attributes of the desired font:
@@ -378,6 +492,7 @@
</enum>
</description>
</argument>
+ <notarg name="list"/>
</arguments>
<return>
<reftopic>gfg:font-data</reftopic>
@@ -415,24 +530,104 @@
</seealso>
</function>
+ <function name="make-font-metrics">
+ <syntax>
+ <arguments>
+ <argument name=":ascent">
+ <description>
+ An <refclhs>integer</refclhs> specifying units above the character
+ baseline.
+ </description>
+ </argument>
+ <notarg name="integer"/>
+ <argument name=":avg-char-width">
+ <description>
+ An <refclhs>integer</refclhs> specifying the average width of
+ characters. Does not include overhang required for bold or italic.
+ </description>
+ </argument>
+ <notarg name="integer"/>
+ <argument name=":descent">
+ <description>
+ An <refclhs>integer</refclhs> specifying units below the
+ character baseline.
+ </description>
+ </argument>
+ <notarg name="integer"/>
+ <argument name=":leading">
+ <description>
+ An <refclhs>integer</refclhs> specifying the amount of extra space
+ added between rows of text.
+ </description>
+ </argument>
+ <notarg name="integer"/>
+ <argument name=":max-char-width">
+ <description>
+ An <refclhs>integer</refclhs> specifying the width of the widest
+ character in the font.
+ </description>
+ </argument>
+ <notarg name="integer"/>
+ </arguments>
+ <return>
+ <reftopic label="new font-metrics">gfg:font-metrics</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfg:font-metrics</reftopic> object.
+ </description>
+ <seealso>
+ <reftopic>gfg:copy-font-metrics</reftopic>
+ <reftopic>gfg:font</reftopic>
+ <reftopic>gfg:metrics</reftopic>
+ </seealso>
+ </function>
+
+ <function name="copy-font-metrics">
+ <syntax>
+ <arguments>
+ <argument name="font-metrics">
+ <description>
+ The <reftopic>gfg:font-metrics</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new font-metrics">gfg:font-metrics</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfg:font-metrics</reftopic> whose slot values
+ were copied from <arg0/>.
+ </description>
+ <seealso>
+ <reftopic>gfg:make-font-metrics</reftopic>
+ <reftopic>gfg:font</reftopic>
+ <reftopic>gfg:metrics</reftopic>
+ </seealso>
+ </function>
+
<function name="make-color">
<syntax>
<arguments>
- <argument name=":blue integer">
+ <argument name=":blue">
<description>
An <refclhs>integer</refclhs> specifying the blue color component.
</description>
</argument>
- <argument name=":green integer">
+ <notarg name="integer"/>
+ <argument name=":green">
<description>
An <refclhs>integer</refclhs> specifying the green color component.
</description>
</argument>
- <argument name=":red integer">
+ <notarg name="integer"/>
+ <argument name=":red">
<description>
An <refclhs>integer</refclhs> specifying the red color component.
</description>
</argument>
+ <notarg name="integer"/>
</arguments>
<return>
<reftopic>gfg:color</reftopic>
@@ -543,6 +738,24 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="font">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="self">
+ <description>
+ The object whose font is to be set or queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:font</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) the <reftopic>gfg:font</reftopic> of <arg0/>.
+ </description>
+ </generic-function>
+
<generic-function name="transparency-mask">
<syntax>
<arguments>
@@ -772,6 +985,109 @@
<!-- ACCESSORS -->
+ <slot-accessor name="pen-style">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ The <reftopic>gfg:graphics-context</reftopic> whose pen style
+ is to be retrieved or set.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns (sets) a list of keyword symbols that configure <arg0/>'s
+ line drawing mode, as described below.
+ </para>
+
+ <para role="normal">One of the following primary styles:</para>
+ <enum>
+ <argument name=":alternate">
+ <description>Every other pixel is set.</description>
+ </argument>
+ <argument name=":dash">
+ <description>Dashed line.</description>
+ </argument>
+ <argument name=":dashdot">
+ <description>Alternating dashes and dots.</description>
+ </argument>
+ <argument name=":dashdotdot">
+ <description>Alternating dashes and double dots.</description>
+ </argument>
+ <argument name=":dot">
+ <description>Dotted line.</description>
+ </argument>
+ <argument name=":solid">
+ <description>Solid line.</description>
+ </argument>
+ </enum>
+
+ <para role="normal">One of the following end cap styles:</para>
+ <enum>
+ <argument name=":flat-endcap"/>
+ <argument name=":round-endcap"/>
+ <argument name=":square-endcap"/>
+ </enum>
+
+ <para role="normal">One of the following end cap styles:</para>
+ <enum>
+ <argument name=":bevel-join">
+ <description>Beveled joins.</description>
+ </argument>
+ <argument name=":miter-join">
+ <description>
+ Mitered joins if the ratio of miter length to
+ line width is within <reftopic>gfg:miter-limit</reftopic>.
+ </description>
+ </argument>
+ <argument name=":round-join">
+ <description>Rounded joins.</description>
+ </argument>
+ </enum>
+
+ <para role="normal">
+ The default style is '(:flat :square-endcap :round-bevel). Specifying
+ NIL is equivalent to selecting the Win32 PS_NULL pen style, meaning
+ that the pen is invisible.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfg:miter-limit</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ </seealso>
+ </slot-accessor>
+
+ <slot-accessor name="pen-width">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ The <reftopic>gfg:graphics-context</reftopic> whose pen width
+ value is to be retrieved or set.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) an <refclhs>integer</refclhs> value determining the width
+ of a drawn line. The minimum supported value is 0, which configures the
+ underlying device context to draw 1-pixel-wide lines using an optimized
+ drawing algorithm.
+ </description>
+ <seealso>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:draw-line</reftopic>
+ </seealso>
+ </slot-accessor>
+
<!-- MACROS -->
<macro name="with-image-transparency">
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Thu Oct 19 19:30:29 2006
@@ -303,16 +303,18 @@
<function name="make-point">
<syntax>
<arguments>
- <argument name=":x integer">
+ <argument name=":x">
<description>
An <refclhs>integer</refclhs> specifying the X coordinate.
</description>
</argument>
- <argument name=":y integer">
+ <notarg name="integer"/>
+ <argument name=":y">
<description>
An <refclhs>integer</refclhs> specifying the Y coordinate.
</description>
</argument>
+ <notarg name="integer"/>
</arguments>
<return>
<reftopic label="new point">gfs:point</reftopic>
@@ -399,18 +401,20 @@
<function name="make-rectangle">
<syntax>
<arguments>
- <argument name=":location point">
+ <argument name=":location">
<description>
An <reftopic>gfs:point</reftopic> specifying the coordinates of the
upper-left corner of the rectangle.
</description>
</argument>
- <argument name=":size size">
+ <notarg name="point"/>
+ <argument name=":size">
<description>
A <reftopic>gfs:size</reftopic> specifing the dimensions of the
rectangle.
</description>
</argument>
+ <notarg name="size"/>
</arguments>
<return>
<reftopic label="new rectangle">gfs:rectangle</reftopic>
@@ -472,16 +476,18 @@
<function name="make-size">
<syntax>
<arguments>
- <argument name=":height integer">
+ <argument name=":height">
<description>
An <refclhs>integer</refclhs> specifying the height.
</description>
</argument>
- <argument name=":width integer">
+ <notarg name="integer"/>
+ <argument name=":width">
<description>
An <refclhs>integer</refclhs> specifying the width.
</description>
</argument>
+ <notarg name="integer"/>
</arguments>
<return>
<reftopic label="new size">gfs:size</reftopic>
@@ -521,16 +527,18 @@
<function name="make-span">
<syntax>
<arguments>
- <argument name=":end integer">
+ <argument name=":end">
<description>
An <refclhs>integer</refclhs> specifying the ending value.
</description>
</argument>
- <argument name=":start integer">
+ <notarg name="integer"/>
+ <argument name=":start">
<description>
An <refclhs>integer</refclhs> specifying the starting value.
</description>
</argument>
+ <notarg name="integer"/>
</arguments>
<return>
<reftopic label="new span">gfs:span</reftopic>
1
0
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>
1
0
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>
1
0
Author: junrue
Date: Thu Oct 19 15:15:23 2006
New Revision: 356
Modified:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gf-utils.xsl
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/gfs-symbols.xml
Log:
replaced refargument template with arg0-arg6 templates
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Thu Oct 19 15:15:23 2006
@@ -65,24 +65,88 @@
</xsl:element>
</xsl:template>
-<!--
- <xsl:template match="description">
- <xsl:element name="bridgehead">
- <xsl:attribute name="renderas">sect2</xsl:attribute>
- description
- </xsl:element>
+ <xsl:template name="find-arg">
+ <xsl:param name="index"/>
+ <xsl:variable name="raw-text">
+ <xsl:choose>
+ <xsl:when test="../syntax/arguments">
+ <xsl:value-of select="(../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:when test="../../syntax/arguments">
+ <xsl:value-of select="(../../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:when test="../../../syntax/arguments">
+ <xsl:value-of select="(../../../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:when test="../../../../syntax/arguments">
+ <xsl:value-of select="(../../../../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:when test="../../../../../syntax/arguments">
+ <xsl:value-of select="(../../../../../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:when test="../../../../../../syntax/arguments">
+ <xsl:value-of select="(../../../../../../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:when test="../../../../../../../syntax/arguments">
+ <xsl:value-of select="(../../../../../../../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:when test="../../../../../../../../syntax/arguments">
+ <xsl:value-of select="(../../../../../../../../syntax/arguments/argument)[position()=$index]/@name"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:message terminate="yes">
+ <xsl:text>Could not find argument </xsl:text><xsl:value-of select="$index - 1"/>
+ </xsl:message>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:variable>
+ <emphasis>
+ <xsl:call-template name="first-word">
+ <xsl:with-param name="raw-text"><xsl:value-of select="$raw-text"/></xsl:with-param>
+ </xsl:call-template>
+ </emphasis>
+ </xsl:template>
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- <xsl:apply-templates/>
- </xsl:element>
+ <xsl:template match="arg0">
+ <xsl:call-template name="find-arg">
+ <xsl:with-param name="index">1</xsl:with-param>
+ </xsl:call-template>
</xsl:template>
--->
- <xsl:template match="refargument">
- <xsl:element name="emphasis">
- <xsl:value-of select="."/>
- </xsl:element>
+ <xsl:template match="arg1">
+ <xsl:call-template name="find-arg">
+ <xsl:with-param name="index">2</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="arg2">
+ <xsl:call-template name="find-arg">
+ <xsl:with-param name="index">3</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="arg3">
+ <xsl:call-template name="find-arg">
+ <xsl:with-param name="index">4</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="arg4">
+ <xsl:call-template name="find-arg">
+ <xsl:with-param name="index">5</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="arg5">
+ <xsl:call-template name="find-arg">
+ <xsl:with-param name="index">6</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="arg6">
+ <xsl:call-template name="find-arg">
+ <xsl:with-param name="index">7</xsl:with-param>
+ </xsl:call-template>
</xsl:template>
<xsl:template match="reftopic">
@@ -163,14 +227,9 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
<xsl:element name="emphasis">
- <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:call-template name="first-word">
+ <xsl:with-param name="raw-text"><xsl:value-of select="@name"/></xsl:with-param>
+ </xsl:call-template>
</xsl:element>
</xsl:element>
</xsl:element>
Modified: trunk/docs/manual/gf-utils.xsl
==============================================================================
--- trunk/docs/manual/gf-utils.xsl (original)
+++ trunk/docs/manual/gf-utils.xsl Thu Oct 19 15:15:23 2006
@@ -18,4 +18,16 @@
<xsl:value-of select="translate($orig-text,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/>
</xsl:template>
+ <xsl:template name="first-word">
+ <xsl:param name="raw-text"/>
+ <xsl:choose>
+ <xsl:when test="contains($raw-text,' ')">
+ <xsl:value-of select="substring-before($raw-text,' ')"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="$raw-text"/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </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 15:15:23 2006
@@ -30,7 +30,7 @@
<argument name=":data">
<description>
A <reftopic>gfg:font-data</reftopic> object. If this initarg
- is specified, then a value for the <refargument>:gc</refargument>
+ is specified, then a value for the :gc
initarg is also required.
</description>
</argument>
@@ -38,7 +38,7 @@
<description>
A <reftopic>gfg:graphics-context</reftopic> object. If this
initarg is specified, then a value for the
- <refargument>:data</refargument> initarg is also required.
+ :data initarg is also required.
</description>
</argument>
<argument name=":handle">
@@ -125,7 +125,7 @@
that the ICO format can store multiple images, all of which will be loaded.
Since icon-bundle needs a transparency mask for each image in order to create
Windows icons, a value may be supplied for the
- <refargument>:transparency-pixel</refargument> initarg of this class;
+ :transparency-pixel initarg of this class;
otherwise, the pixel color at location (0, 0) in each image is used by
default.
</description>
@@ -137,7 +137,7 @@
the application may either SETF <reftopic>gfg:transparency-pixel</reftopic>
for each image ahead of time (especially important when the proper pixel
location is different from one image to the next), or provide a value for
- the <refargument>:transparency-pixel</refargument> initarg of this class.
+ the :transparency-pixel initarg of this class.
By default, the pixel color at location (0, 0) in each image will be used.
</description>
</argument>
@@ -328,7 +328,7 @@
<arguments>
<argument name="context">
<description>
- The context for retrieving the metrics of <refargument>font</refargument>.
+ The context for retrieving the metrics of <arg1/>.
</description>
</argument>
<argument name="font">
@@ -343,7 +343,7 @@
</syntax>
<description>
Returns a <reftopic>gfg:font-metrics</reftopic> object describing
- attributes of <refargument>font</refargument>.
+ attributes of <arg1/> using <arg0/>.
</description>
<seealso>
<reftopic>gfg:text-extent</reftopic>
@@ -355,7 +355,7 @@
<arguments>
<argument name="context">
<description>
- The context for measuring the extent of <refargument>string</refargument>.
+ The context for measuring the extent of <arg1/>.
</description>
</argument>
<argument name="string &optional">
@@ -371,12 +371,12 @@
<argument name=":mnemonic">
<description>
Underline the mnemonic character if any (preceded in
- <refargument>string</refargument> with an ampersand).
+ <arg1/> with an ampersand).
</description>
</argument>
<argument name=":tab">
<description>
- Expand tabs when <refargument>string</refargument> is rendered;
+ Expand tabs when <arg1/> is rendered;
by default the tab width is 8 characters.
</description>
</argument>
@@ -396,9 +396,9 @@
</syntax>
<description>
Returns the size of a rectangular region that would enclose
- <refargument>string</refargument> if it were drawn. These dimensions
+ <arg1/> if it were drawn. These dimensions
are dependent on the <reftopic>gfg:font</reftopic> currently selected
- in <refargument>context</refargument>.
+ in <arg0/>.
</description>
<seealso>
<reftopic>gfg:font-metrics</reftopic>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Thu Oct 19 15:15:23 2006
@@ -341,7 +341,7 @@
</syntax>
<description>
Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates
- were copied from the original.
+ were copied from <arg0/>.
</description>
<seealso>
<reftopic>gfs:make-point</reftopic>
@@ -363,9 +363,8 @@
</syntax>
<description>
Returns (sets) the <reftopic>gfs:point</reftopic> identifying the coordinates
- of the upper-left corner of <refargument>rectangle</refargument>. For
- performance reasons, the existing slot value is returned directly rather
- than being copied.
+ of the upper-left corner of <arg0/>. For performance reasons, the existing
+ slot value is returned directly rather than being copied.
</description>
<seealso>
<reftopic>gfs:make-rectangle</reftopic>
@@ -388,8 +387,8 @@
</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.
+ of <arg0/>. For performance reasons, the existing slot value is returned
+ directly rather than being copied.
</description>
<seealso>
<reftopic>gfs:make-rectangle</reftopic>
@@ -440,7 +439,7 @@
</syntax>
<description>
Returns a new <reftopic>gfs:rectangle</reftopic> whose location and
- dimension values were (shallow) copied from the original.
+ dimension values were (shallow) copied from <arg0/>.
</description>
<seealso>
<reftopic>gfs:make-rectangle</reftopic>
@@ -462,7 +461,7 @@
</syntax>
<description>
Returns a new <reftopic>gfs:size</reftopic> whose width and
- height values were copied from the original.
+ height values were copied from <arg0/>.
</description>
<seealso>
<reftopic>gfs:make-size</reftopic>
@@ -512,7 +511,7 @@
</syntax>
<description>
Returns a new <reftopic>gfs:span</reftopic> whose start and
- end values were copied from the original.
+ end values were copied from <arg0/>.
</description>
<seealso>
<reftopic>gfs:make-span</reftopic>
@@ -560,8 +559,7 @@
</return>
</syntax>
<description>
- Returns T if the start and end of <refargument>span</refargument>
- are the same value.
+ Returns T if the start and end of <arg0/> are the same value.
</description>
<seealso>
<reftopic>gfs:span-start</reftopic>
@@ -588,9 +586,7 @@
</return>
</syntax>
<description>
- Returns T if <refargument>size1</refargument> and
- <refargument>size2</refargument> have the same height and
- width values.
+ Returns T if <arg0/> and <arg1/> have the same height and width values.
</description>
<seealso>
<reftopic>gfs:copy-size</reftopic>
@@ -617,9 +613,8 @@
</syntax>
<description>
<para role="normal">
- Returns T if <refargument>native-object</refargument> has not yet been
- initialized or has been discarded via <reftopic>gfs:dispose</reftopic>;
- NIL otherwise.
+ Returns T if <arg0/> has not yet been initialized or has been discarded
+ via <reftopic>gfs:dispose</reftopic>; NIL otherwise.
</para>
<para role="normal">
@@ -647,9 +642,9 @@
</syntax>
<description>
<para role="normal">
- Discards the system resource encapsulated by <reftopic>gfs:native-object</reftopic>
- and cleans up various data structures internal to Graphic-Forms. For certain
- objects, this method has visual side effects (for example, disposing
+ Discards the system resource held by <arg0/> and cleans up various
+ data structures internal to Graphic-Forms. For certain objects, this
+ method has visual side effects (for example, disposing
a window will remove that window from the display). A
<reftopic>gfs:disposed-error</reftopic>
will be raised if application code attempts to manipulate the object
@@ -684,7 +679,7 @@
</return>
</syntax>
<description>
- Returns (sets) the X coordinate of <refargument>point</refargument>.
+ Returns (sets) the X coordinate of <arg0/>.
</description>
<seealso>
<reftopic>gfs:point-y</reftopic>
@@ -706,7 +701,7 @@
</return>
</syntax>
<description>
- Returns (sets) the Y coordinate of <refargument>point</refargument>.
+ Returns (sets) the Y coordinate of <arg0/>.
</description>
<seealso>
<reftopic>gfs:point-x</reftopic>
@@ -728,7 +723,7 @@
</return>
</syntax>
<description>
- Returns (sets) the width value of <refargument>size</refargument>.
+ Returns (sets) the width value of <arg0/>.
</description>
<seealso>
<reftopic>gfs:size-height</reftopic>
@@ -750,7 +745,7 @@
</return>
</syntax>
<description>
- Returns (sets) the height value of <refargument>size</refargument>.
+ Returns (sets) the height value of <arg0/>.
</description>
<seealso>
<reftopic>gfs:size-width</reftopic>
@@ -772,7 +767,7 @@
</return>
</syntax>
<description>
- Returns (sets) the starting value of <refargument>span</refargument>.
+ Returns (sets) the starting value of <arg0/>.
</description>
<seealso>
<reftopic>gfs:span-end</reftopic>
@@ -794,7 +789,7 @@
</return>
</syntax>
<description>
- Returns (sets) the ending value of <refargument>span</refargument>.
+ Returns (sets) the ending value of <arg0/>.
</description>
<seealso>
<reftopic>gfs:span-start</reftopic>
@@ -816,8 +811,7 @@
</return>
</syntax>
<description>
- Returns the Win32 HANDLE or foreign pointer associated with
- <refargument>native-object</refargument>.
+ Returns the Win32 HANDLE or foreign pointer associated with <arg0/>.
</description>
<seealso>
<reftopic>gfs:dispose</reftopic>
@@ -840,9 +834,8 @@
</return>
</syntax>
<description>
- Returns the Win32 error code for <refargument>condition</refargument>
- as determined by the Common Dialog API function
- <refwin32api>CommDlgExtendedError</refwin32api>.
+ Returns the Win32 error code for <arg0/> as determined by the Common
+ Dialog API function <refwin32api>CommDlgExtendedError</refwin32api>.
</description>
</slot-reader>
@@ -861,8 +854,8 @@
</return>
</syntax>
<description>
- Returns the Win32 error code for <refargument>condition</refargument>
- as determined by <refwin32api>GetLastError</refwin32api>.
+ Returns the Win32 error code for <arg0/> as determined by
+ <refwin32api>GetLastError</refwin32api>.
</description>
</slot-reader>
@@ -881,7 +874,7 @@
</return>
</syntax>
<description>
- Returns the detail <refclhs>string</refclhs> for <refargument>condition</refargument>.
+ Returns the detail <refclhs>string</refclhs> for <arg0/>.
</description>
</slot-reader>
1
0
Author: junrue
Date: Thu Oct 19 02:50:57 2006
New Revision: 355
Modified:
trunk/docs/manual/catalog.xml
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/win32-api-table.xml
Log:
Modified: trunk/docs/manual/catalog.xml
==============================================================================
--- trunk/docs/manual/catalog.xml (original)
+++ trunk/docs/manual/catalog.xml Thu Oct 19 02:50:57 2006
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
- graphic-forms.xsl
+ catalog.xml
Copyright (c) 2006, Jack D. Unrue
-->
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Thu Oct 19 02:50:57 2006
@@ -211,6 +211,19 @@
</xsl:call-template>
</xsl:template>
+ <xsl:template match="enum">
+ <xsl:for-each select="argument">
+ <xsl:element name="indexterm">
+ <xsl:element name="primary">
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:for-each>
+ <xsl:call-template name="emit-table">
+ <xsl:with-param name="col2-width">5*</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
<xsl:template match="inherits">
<xsl:element name="row">
<xsl:element name="entry">
@@ -365,6 +378,12 @@
</xsl:call-template>
</xsl:template>
+ <xsl:template match="macro">
+ <xsl:call-template name="emit-function-section">
+ <xsl:with-param name="page-type">Macro</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
<xsl:template match="/package">
<data>
<xsl:apply-templates>
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 02:50:57 2006
@@ -323,6 +323,300 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="metrics">
+ <syntax>
+ <arguments>
+ <argument name="context">
+ <description>
+ The context for retrieving the metrics of <refargument>font</refargument>.
+ </description>
+ </argument>
+ <argument name="font">
+ <description>
+ A <reftopic>gfg:font</reftopic> object.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:font-metrics</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a <reftopic>gfg:font-metrics</reftopic> object describing
+ attributes of <refargument>font</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfg:text-extent</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="text-extent">
+ <syntax>
+ <arguments>
+ <argument name="context">
+ <description>
+ The context for measuring the extent of <refargument>string</refargument>.
+ </description>
+ </argument>
+ <argument name="string &optional">
+ <description>
+ The <refclhs>string</refclhs> whose pixel dimensions are to be computed.
+ </description>
+ </argument>
+ <argument name="style">
+ <description>
+ A <refclhs>list</refclhs> containing zero or more of the following
+ keyword symbols:
+ <enum>
+ <argument name=":mnemonic">
+ <description>
+ Underline the mnemonic character if any (preceded in
+ <refargument>string</refargument> with an ampersand).
+ </description>
+ </argument>
+ <argument name=":tab">
+ <description>
+ Expand tabs when <refargument>string</refargument> is rendered;
+ by default the tab width is 8 characters.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name="tab-width">
+ <description>
+ An <refclhs>integer</refclhs> specifying a custom tab width; only
+ meaningful if the :tab style keyword is supplied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns the size of a rectangular region that would enclose
+ <refargument>string</refargument> if it were drawn. These dimensions
+ are dependent on the <reftopic>gfg:font</reftopic> currently selected
+ in <refargument>context</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfg:font-metrics</reftopic>
+ </seealso>
+ </generic-function>
+
<!-- ACCESSORS -->
+ <!-- MACROS -->
+
+ <macro name="color->rgb">
+ <syntax>
+ <arguments>
+ <argument name="color">
+ <description>
+ A <reftopic>gfg:color</reftopic> to be converted to the Win32
+ <refwin32api>COLORREF</refwin32api> representation.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refwin32api>COLORREF</refwin32api>
+ </return>
+ </syntax>
+ <description>
+ This macro converts a <reftopic>gfg:color</reftopic> to the Win32
+ <refwin32api>COLORREF</refwin32api> representation, which in CFFI
+ terms is defined as an alias for the :unsigned-long type.
+ </description>
+ <seealso>
+ <reftopic>gfg:rgb->color</reftopic>
+ </seealso>
+ </macro>
+
+ <macro name="rgb->color">
+ <syntax>
+ <arguments>
+ <argument name="COLOREF">
+ <description>
+ A Win32 <refwin32api>COLORREF</refwin32api> value to be translated
+ to a <reftopic>gfg:color</reftopic> object.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfg:color</reftopic>
+ </return>
+ </syntax>
+ <description>
+ This macro converts a Win32 <refwin32api>COLORREF</refwin32api> value,
+ which in CFFI terms is defined as an alias for :unsigned-long, to a
+ <reftopic>gfg:color</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfg:color->rgb</reftopic>
+ </seealso>
+ </macro>
+
+ <macro name="ascent">
+ <syntax>
+ <arguments>
+ <argument name="font-metrics">
+ <description>
+ The <reftopic>gfg:font-metrics</reftopic> object whose ascent value
+ is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This macro returns the ascent value for a <reftopic>gfg:font</reftopic>,
+ which is the number of units above the character base line.
+ </description>
+ <seealso>
+ <reftopic>gfg:average-char-width</reftopic>
+ <reftopic>gfg:descent</reftopic>
+ <reftopic>gfg:height</reftopic>
+ <reftopic>gfg:leading</reftopic>
+ <reftopic>gfg:maximum-char-width</reftopic>
+ </seealso>
+ </macro>
+
+ <macro name="average-char-width">
+ <syntax>
+ <arguments>
+ <argument name="font-metrics">
+ <description>
+ The <reftopic>gfg:font-metrics</reftopic> object whose average
+ character width is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This macro returns the average width of a character in a
+ <reftopic>gfg:font</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfg:ascent</reftopic>
+ <reftopic>gfg:descent</reftopic>
+ <reftopic>gfg:height</reftopic>
+ <reftopic>gfg:leading</reftopic>
+ <reftopic>gfg:maximum-char-width</reftopic>
+ </seealso>
+ </macro>
+
+ <macro name="descent">
+ <syntax>
+ <arguments>
+ <argument name="font-metrics">
+ <description>
+ The <reftopic>gfg:font-metrics</reftopic> object whose descent value
+ is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This macro returns the descent value for a <reftopic>gfg:font</reftopic>,
+ which is the number of units above the character base line.
+ </description>
+ <seealso>
+ <reftopic>gfg:average-char-width</reftopic>
+ <reftopic>gfg:ascent</reftopic>
+ <reftopic>gfg:height</reftopic>
+ <reftopic>gfg:leading</reftopic>
+ <reftopic>gfg:maximum-char-width</reftopic>
+ </seealso>
+ </macro>
+
+ <macro name="height">
+ <syntax>
+ <arguments>
+ <argument name="font-metrics">
+ <description>
+ The <reftopic>gfg:font-metrics</reftopic> object whose height value
+ is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This macro returns the height value for a <reftopic>gfg:font</reftopic>,
+ which is the sum of the font's ascent and descent.
+ </description>
+ <seealso>
+ <reftopic>gfg:ascent</reftopic>
+ <reftopic>gfg:average-char-width</reftopic>
+ <reftopic>gfg:descent</reftopic>
+ <reftopic>gfg:leading</reftopic>
+ <reftopic>gfg:maximum-char-width</reftopic>
+ </seealso>
+ </macro>
+
+ <macro name="leading">
+ <syntax>
+ <arguments>
+ <argument name="font-metrics">
+ <description>
+ The <reftopic>gfg:font-metrics</reftopic> object whose leading value
+ is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This macro returns the leading value for a <reftopic>gfg:font</reftopic>,
+ which is the amount of extra space added between rows of text.
+ </description>
+ <seealso>
+ <reftopic>gfg:ascent</reftopic>
+ <reftopic>gfg:average-char-width</reftopic>
+ <reftopic>gfg:descent</reftopic>
+ <reftopic>gfg:height</reftopic>
+ <reftopic>gfg:maximum-char-width</reftopic>
+ </seealso>
+ </macro>
+
+ <macro name="maximum-char-width">
+ <syntax>
+ <arguments>
+ <argument name="font-metrics">
+ <description>
+ The <reftopic>gfg:font-metrics</reftopic> object whose maximum
+ character width is to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ This macro returns the maximum width of a character in a
+ <reftopic>gfg:font</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfg:ascent</reftopic>
+ <reftopic>gfg:descent</reftopic>
+ <reftopic>gfg:height</reftopic>
+ <reftopic>gfg:leading</reftopic>
+ <reftopic>gfg:average-char-width</reftopic>
+ </seealso>
+ </macro>
+
</package>
Modified: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- trunk/docs/manual/win32-api-table.xml (original)
+++ trunk/docs/manual/win32-api-table.xml Thu Oct 19 02:50:57 2006
@@ -6,6 +6,7 @@
-->
<win32-api-table>
+ <entry name="COLORREF" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/gdi/colors…"/>
<entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/>
<entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base…"/>
<entry name="Icons in Win32" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwui/html…"/>
1
0
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,':',@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,':',@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>
1
0
Author: junrue
Date: Thu Oct 19 00:13:19 2006
New Revision: 353
Modified:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gf-package.xsl
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/gfw-symbols.xml
trunk/docs/manual/win32-api-table.xml
Log:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Thu Oct 19 00:13:19 2006
@@ -6,10 +6,11 @@
-->
<clhs-table>
- <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
- <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
- <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
- <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
- <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
- <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
+ <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
+ <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
+ <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
+ <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/>
+ <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+ <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
</clhs-table>
Modified: trunk/docs/manual/gf-package.xsl
==============================================================================
--- trunk/docs/manual/gf-package.xsl (original)
+++ trunk/docs/manual/gf-package.xsl Thu Oct 19 00:13:19 2006
@@ -57,7 +57,7 @@
<xsl:for-each select="/package/class | /package/structure">
<xsl:sort select="@name" order="ascending" case-order="upper-first"/>
<xsl:element name="link">
- <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute>
<xsl:value-of select="@name"/>
</xsl:element>
<xsl:if test="not(position()=last())">, </xsl:if>
@@ -69,7 +69,7 @@
<xsl:for-each select="/package/function | /package/generic-function | /package/slot-accessor | /package/slot-reader | /package/macro">
<xsl:sort select="@name" order="ascending" case-order="upper-first"/>
<xsl:element name="link">
- <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute>
<xsl:value-of select="@name"/>
</xsl:element>
<xsl:if test="not(position()=last())">, </xsl:if>
@@ -81,7 +81,7 @@
<xsl:for-each select="/package/condition">
<xsl:sort select="@name" order="ascending" case-order="upper-first"/>
<xsl:element name="link">
- <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute>
<xsl:value-of select="@name"/>
</xsl:element>
<xsl:if test="not(position()=last())">, </xsl:if>
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 00:13:19 2006
@@ -17,8 +17,209 @@
<!-- CLASSES -->
+ <class name="font">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ This class encapsulates a native font handle.
+ </description>
+ <initargs>
+ <argument name=":data">
+ <description>
+ A <reftopic>gfg:font-data</reftopic> object. If this initarg
+ is specified, then a value for the <refargument>:gc</refargument>
+ initarg is also required.
+ </description>
+ </argument>
+ <argument name=":gc">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> object. If this
+ initarg is specified, then a value for the
+ <refargument>:data</refargument> initarg is also required.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfg:data-object</reftopic>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfg:font-metrics</reftopic>
+ <reftopic>gfg:text-extent</reftopic>
+ </seealso>
+ </class>
+
+ <class name="graphics-context">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ This class wraps a Win32 device context, thus instances of this class
+ are used to perform drawing operations. Application code usually obtains
+ a <reftopic>gfg:graphics-context</reftopic> via
+ <reftopic>gfw:event-paint</reftopic>, but initargs are also provided to
+ create a context associated with a <reftopic>gfg:image</reftopic> or a
+ <reftopic>gfw:widget</reftopic> outside the scope of a paint event.
+ </description>
+ <initargs>
+ <argument name=":image">
+ <description>
+ A <reftopic>gfg:image</reftopic> on which to draw or whose graphics
+ attributes are to be manipulated.
+ </description>
+ </argument>
+ <argument name=":widget">
+ <description>
+ A <reftopic>gfw:widget</reftopic> on which to draw or whose graphics
+ attributes are to be manipulated.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
+ <class name="icon-bundle">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ <para role="normal">
+ This class encapsulates a collection of Win32 icon handles. Icons are used to
+ decorate window title bars, to represent a file or application on the desktop,
+ to represent an application in the <Alt><Tab> task switching dialog,
+ and in the Windows Start menu. See the <refwin32api>Icons in Win32</refwin32api>
+ topic of the MSDN documentation for further discussion of standard icon sizes,
+ color depths, and file format.
+ </para>
+ <para role="normal">
+ This class supports multiple-sized versions of the same image. Library
+ components that consume icon-bundle instances can, in some cases, select a
+ size appropriate for the context in which the icon is needed. To retrieve
+ or set an individual <reftopic>gfg:image</reftopic>, call
+ <reftopic>gfg:icon-image-ref</reftopic>. To find out how many images
+ are stored, call <reftopic>gfg:icon-bundle-length</reftopic>.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":file">
+ <description>
+ A <refclhs>pathname</refclhs> identifying a file to be loaded, as described
+ for the initarg of the same name for <reftopic>gfg:image</reftopic>. Note
+ that the ICO format can store multiple images, all of which will be loaded.
+ Since icon-bundle needs a transparency mask for each image in order to create
+ Windows icons, a value may be supplied for the
+ <refargument>:transparency-pixel</refargument> initarg of this class;
+ otherwise, the pixel color at location (0, 0) in each image is used by
+ default.
+ </description>
+ </argument>
+ <argument name=":images">
+ <description>
+ A <refclhs>list</refclhs> of <reftopic>gfg:image</reftopic> objects. Since
+ icon-bundle needs a transparency mask for each image to create Windows icons,
+ the application may either SETF <reftopic>gfg:transparency-pixel</reftopic>
+ for each image ahead of time (especially important when the proper pixel
+ location is different from one image to the next), or provide a value for
+ the <refargument>:transparency-pixel</refargument> initarg of this class.
+ By default, the pixel color at location (0, 0) in each image will be used.
+ </description>
+ </argument>
+ <argument name=":system">
+ <description>
+ An icon identifier constant.
+ </description>
+ </argument>
+ <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.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ Image Data Plugins
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfg:icon-bundle-length</reftopic>
+ <reftopic>gfg:icon-image-ref</reftopic>
+ <reftopic>gfg:load</reftopic>
+ <reftopic>gfg:push-icon-image</reftopic>
+ </seealso>
+ </class>
+
<!-- STRUCTURES -->
+ <structure name="color">
+ <description>
+ This structure represents a color in the RGB color model. Each color
+ component value is specified in the range 0 - 255.
+ </description>
+ <seealso>
+ <reftopic>gfg:copy-color</reftopic>
+ <reftopic>gfg:make-color</reftopic>
+ <reftopic>gfg:color-red</reftopic>
+ <reftopic>gfg:color-green</reftopic>
+ <reftopic>gfg:color-blue</reftopic>
+ <reftopic>gfg:color->rgb</reftopic>
+ <reftopic>gfg:rgb->color</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="font-data">
+ <description>
+ This structure describes logical attributes of a
+ <reftopic>gfg:font</reftopic> that the system font mapper can use
+ to find a match. Thus, application code can use this structure to
+ request fonts.
+ </description>
+ <seealso>
+ <reftopic>gfg:copy-font-data</reftopic>
+ <reftopic>gfg:data-object</reftopic>
+ <reftopic>gfg:make-font-data</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="font-metrics">
+ <description>
+ This structure describes attributes of a <reftopic>gfg:font</reftopic>
+ which application code may use to position and align graphical elements.
+ </description>
+ <seealso>
+ <reftopic>gfg:ascent</reftopic>
+ <reftopic>gfg:average-char-width</reftopic>
+ <reftopic>gfg:copy-font-metrics</reftopic>
+ <reftopic>gfg:descent</reftopic>
+ <reftopic>gfg:font-data</reftopic>
+ <reftopic>gfg:height</reftopic>
+ <reftopic>gfg:leading</reftopic>
+ <reftopic>gfg:make-font-metrics</reftopic>
+ <reftopic>gfg:maximum-char-width</reftopic>
+ <reftopic>gfg:metrics</reftopic>
+ </seealso>
+ </structure>
+
<!-- FUNCTIONS -->
<!-- GENERIC FUNCTIONS -->
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Thu Oct 19 00:13:19 2006
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
- gfg-symbols.xml
+ gfw-symbols.xml
Copyright (c) 2006, Jack D. Unrue
-->
Modified: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- trunk/docs/manual/win32-api-table.xml (original)
+++ trunk/docs/manual/win32-api-table.xml Thu Oct 19 00:13:19 2006
@@ -8,4 +8,5 @@
<win32-api-table>
<entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/>
<entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base…"/>
+ <entry name="Icons in Win32" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwui/html…"/>
</win32-api-table>
1
0
Author: junrue
Date: Wed Oct 18 23:20:23 2006
New Revision: 352
Added:
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/gfw-symbols.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/api.xml
trunk/docs/manual/gf-package.xsl
trunk/docs/manual/gfs-symbols.xml
trunk/docs/manual/graphic-forms.xml
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Wed Oct 18 23:20:23 2006
@@ -7,20 +7,33 @@
COMMON-DEPS = gf-data.xsl gf-package.xsl clhs-table.xml win32-api-table.xml
-TMP-XML = gfs-tmp-pkg.xml gfs-tmp-syms.xml
+TMP-XML = gfs-tmp-pkg.xml gfs-tmp-syms.xml gfg-tmp-pkg.xml gfg-tmp-syms.xml \
+ gfw-tmp-pkg.xml gfw-tmp-syms.xml
XSLT-PROC = xsltproc --nonet
-graphic-forms.chm: gfs-tmp-pkg.xml
+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
-gfs-tmp-pkg.xml: gfs-tmp-syms.xml $(COMMON-DEPS)
- $(XSLT-PROC) --output $@ gf-package.xsl gfs-symbols.xml
-
gfs-tmp-syms.xml: gfs-symbols.xml $(COMMON-DEPS)
$(XSLT-PROC) --output $@ gf-data.xsl gfs-symbols.xml
+gfs-tmp-pkg.xml: gfs-tmp-syms.xml gfs-symbols.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --stringparam symbol-file gfs-tmp-syms.xml --output $@ gf-package.xsl gfs-symbols.xml
+
+gfg-tmp-syms.xml: gfg-symbols.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-data.xsl gfg-symbols.xml
+
+gfg-tmp-pkg.xml: gfg-tmp-syms.xml gfg-symbols.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --stringparam symbol-file gfg-tmp-syms.xml --output $@ gf-package.xsl gfg-symbols.xml
+
+gfw-tmp-syms.xml: gfw-symbols.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-data.xsl gfw-symbols.xml
+
+gfw-tmp-pkg.xml: gfw-tmp-syms.xml gfw-symbols.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --stringparam symbol-file gfw-tmp-syms.xml --output $@ gf-package.xsl gfw-symbols.xml
+
clean:
rm -f $(TMP-XML)
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
Modified: trunk/docs/manual/api.xml
==============================================================================
--- trunk/docs/manual/api.xml (original)
+++ trunk/docs/manual/api.xml Wed Oct 18 23:20:23 2006
@@ -10,6 +10,8 @@
This chapter documents the Graphic-Forms programming interface.
</para>
+ &gfgpkg;
&gfspkg;
+ &gfwpkg;
</chapter>
Modified: trunk/docs/manual/gf-package.xsl
==============================================================================
--- trunk/docs/manual/gf-package.xsl (original)
+++ trunk/docs/manual/gf-package.xsl Wed Oct 18 23:20:23 2006
@@ -11,14 +11,34 @@
<xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
+ <xsl:param name="symbol-file"/>
+
+ <xsl:template name="upcase">
+ <xsl:param name="orig-text"/>
+ <xsl:value-of select="translate($orig-text,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/>
+ </xsl:template>
+
<xsl:template match="/package">
+
<chapter>
<title><xsl:value-of select="@fullname"/></title>
+ <indexterm>
+ <primary>
+ <xsl:call-template name="upcase">
+ <xsl:with-param name="orig-text"><xsl:value-of select="@name"/></xsl:with-param>
+ </xsl:call-template>
+ </primary>
+ </indexterm>
+ <indexterm><primary><xsl:value-of select="@fullname"/></primary></indexterm>
<para role="normal">[Package]</para>
<bridgehead renderas="sect2">nickname</bridgehead>
- <para role="normal"><xsl:value-of select="translate(@name,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/></para>
+ <para role="normal">
+ <xsl:call-template name="upcase">
+ <xsl:with-param name="orig-text"><xsl:value-of select="@name"/></xsl:with-param>
+ </xsl:call-template>
+ </para>
<xsl:for-each select="description">
<xsl:element name="bridgehead">
@@ -68,7 +88,7 @@
</xsl:for-each>
</para>
- <xsl:for-each select="document('gfs-tmp-syms.xml')/data/section">
+ <xsl:for-each select="document($symbol-file)/data/section">
<xsl:copy-of select="current()"/>
</xsl:for-each>
Added: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfg-symbols.xml Wed Oct 18 23:20:23 2006
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!--
+ gfg-symbols.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<package name="gfg" fullname="graphic-forms.uitoolkit.graphics">
+
+ <description>
+ This package exports the symbols corresponding to graphics meta-data
+ and drawing operations. This package and GFW together comprise the bulk
+ of the public API.
+ </description>
+
+ <!-- CONDITIONS -->
+
+ <!-- CLASSES -->
+
+ <!-- STRUCTURES -->
+
+ <!-- FUNCTIONS -->
+
+ <!-- GENERIC FUNCTIONS -->
+
+ <!-- ACCESSORS -->
+
+</package>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 23:20:23 2006
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
- gfs-package-data.xml
+ gfs-symbols.xml
Copyright (c) 2006, Jack D. Unrue
-->
Added: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfw-symbols.xml Wed Oct 18 23:20:23 2006
@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<!--
+ gfg-symbols.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<package name="gfw" fullname="graphic-forms.uitoolkit.widgets">
+
+ <description>
+ This package contains symbols for user interface widget classes,
+ event-handling methods, and management functions. This package and
+ GFG together constitute the bulk of the public API.
+ </description>
+
+ <!-- CONDITIONS -->
+
+ <!-- CLASSES -->
+
+ <!-- STRUCTURES -->
+
+ <!-- FUNCTIONS -->
+
+ <!-- GENERIC FUNCTIONS -->
+
+ <!-- ACCESSORS -->
+
+</package>
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Wed Oct 18 23:20:23 2006
@@ -9,7 +9,9 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
+ <!ENTITY gfgpkg SYSTEM "gfg-tmp-pkg.xml"> <!-- generated file -->
<!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml"> <!-- generated file -->
+ <!ENTITY gfwpkg SYSTEM "gfw-tmp-pkg.xml"> <!-- generated file -->
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
1
0
Author: junrue
Date: Wed Oct 18 22:49:17 2006
New Revision: 351
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gf-package.xsl
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Wed Oct 18 22:49:17 2006
@@ -11,9 +11,9 @@
XSLT-PROC = xsltproc --nonet
-docs: gfs-tmp-pkg.xml
+graphic-forms.chm: gfs-tmp-pkg.xml
$(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
- -hhc htmlhelp.hhp
+ -hhc htmlhelp.hhp; exit 0 # muffle Error Ignored msg due to hhc exit value 1
gfs-tmp-pkg.xml: gfs-tmp-syms.xml $(COMMON-DEPS)
$(XSLT-PROC) --output $@ gf-package.xsl gfs-symbols.xml
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 22:49:17 2006
@@ -286,48 +286,6 @@
</xsl:element>
</xsl:template>
-<!--
- <xsl:template match="class/description">
- <xsl:element name="bridgehead">
- <xsl:attribute name="renderas">sect2</xsl:attribute>
- description
- </xsl:element>
-
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- <xsl:apply-templates/>
- </xsl:element>
- </xsl:template>
-
- <xsl:template match="condition/description">
- <xsl:element name="bridgehead">
- <xsl:attribute name="renderas">sect2</xsl:attribute>
- description
- </xsl:element>
-
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- <xsl:apply-templates/>
- </xsl:element>
- </xsl:template>
-
- <xsl:template match="function/description">
- <xsl:call-template name="emit-description"/>
- </xsl:template>
-
- <xsl:template match="generic-function/description">
- <xsl:call-template name="emit-description"/>
- </xsl:template>
-
- <xsl:template match="slot-reader/description">
- <xsl:call-template name="emit-description"/>
- </xsl:template>
-
- <xsl:template match="slot-accessor/description">
- <xsl:call-template name="emit-description"/>
- </xsl:template>
--->
-
<xsl:template name="emit-type-section">
<xsl:param name="page-type"/>
Modified: trunk/docs/manual/gf-package.xsl
==============================================================================
--- trunk/docs/manual/gf-package.xsl (original)
+++ trunk/docs/manual/gf-package.xsl Wed Oct 18 22:49:17 2006
@@ -18,7 +18,7 @@
<para role="normal">[Package]</para>
<bridgehead renderas="sect2">nickname</bridgehead>
- <para role="normal"><xsl:value-of select="@name"/></para>
+ <para role="normal"><xsl:value-of select="translate(@name,'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/></para>
<xsl:for-each select="description">
<xsl:element name="bridgehead">
@@ -34,21 +34,38 @@
<bridgehead renderas="sect2">classes and structures</bridgehead>
<para role="normal">
- native-object, point, rectangle, size, span
+ <xsl:for-each select="/package/class | /package/structure">
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ <xsl:element name="link">
+ <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
</para>
<bridgehead renderas="sect2">accessors, functions, and macros</bridgehead>
<para role="normal">
- code, copy-point, copy-rectangle, copy-size, copy-span, detail, dispose,
- disposed-p, dlg-code, empty-span-p, equal-size-p, handle, location,
- make-point, make-rectangle, make-size, make-span, point-x, point-y,
- size, size-height, size-width, span-end, span-start
+ <xsl:for-each select="/package/function | /package/generic-function | /package/slot-accessor | /package/slot-reader | /package/macro">
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ <xsl:element name="link">
+ <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
</para>
<bridgehead renderas="sect2">conditions</bridgehead>
<para role="normal">
- comdlg-error, disposed-error, toolkit-error, toolkit-warning, win32-error,
- win32-warning
+ <xsl:for-each select="/package/condition">
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ <xsl:element name="link">
+ <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
</para>
<xsl:for-each select="document('gfs-tmp-syms.xml')/data/section">
1
0
Author: junrue
Date: Wed Oct 18 21:57:02 2006
New Revision: 350
Added:
trunk/docs/manual/gf-package.xsl
Removed:
trunk/docs/manual/system-package.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-symbols.xml
trunk/docs/manual/graphic-forms.xml
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Wed Oct 18 21:57:02 2006
@@ -5,17 +5,20 @@
# Copyright (c) 2006, Jack D. Unrue
#
-COMMON-DEPS = gf-data.xsl clhs-table.xml win32-api-table.xml
+COMMON-DEPS = gf-data.xsl gf-package.xsl clhs-table.xml win32-api-table.xml
-TMP-XML = gfs-tmp.xml
+TMP-XML = gfs-tmp-pkg.xml gfs-tmp-syms.xml
XSLT-PROC = xsltproc --nonet
-docs: gfs-tmp.xml
+docs: gfs-tmp-pkg.xml
$(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
-hhc htmlhelp.hhp
-gfs-tmp.xml: gfs-symbols.xml $(COMMON-DEPS)
+gfs-tmp-pkg.xml: gfs-tmp-syms.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-package.xsl gfs-symbols.xml
+
+gfs-tmp-syms.xml: gfs-symbols.xml $(COMMON-DEPS)
$(XSLT-PROC) --output $@ gf-data.xsl gfs-symbols.xml
clean:
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 21:57:02 2006
@@ -26,6 +26,23 @@
</xsl:element>
</xsl:template>
+ <xsl:template name="emit-page-type">
+ <xsl:param name="page-type"/>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ [<xsl:value-of select="../@name"/>]
+ <xsl:value-of select="$page-type"/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="para">
+ <xsl:copy>
+ <xsl:copy-of select="@*"/>
+ <xsl:apply-templates/>
+ </xsl:copy>
+ </xsl:template>
+
<xsl:template name="emit-table">
<xsl:param name="col2-width"/>
@@ -48,17 +65,8 @@
</xsl:element>
</xsl:template>
- <xsl:template name="emit-page-type">
- <xsl:param name="page-type"/>
-
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- [<xsl:value-of select="../@name"/>]
- <xsl:value-of select="$page-type"/>
- </xsl:element>
- </xsl:template>
-
- <xsl:template name="emit-symbol-description">
+<!--
+ <xsl:template match="description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
description
@@ -69,13 +77,7 @@
<xsl:apply-templates/>
</xsl:element>
</xsl:template>
-
- <xsl:template match="para">
- <xsl:copy>
- <xsl:copy-of select="@*"/>
- <xsl:apply-templates/>
- </xsl:copy>
- </xsl:template>
+-->
<xsl:template match="refargument">
<xsl:element name="emphasis">
@@ -272,7 +274,7 @@
</xsl:element>
</xsl:template>
- <xsl:template match="structure/description">
+ <xsl:template match="/package/*/description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
description
@@ -284,6 +286,7 @@
</xsl:element>
</xsl:template>
+<!--
<xsl:template match="class/description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
@@ -309,20 +312,21 @@
</xsl:template>
<xsl:template match="function/description">
- <xsl:call-template name="emit-symbol-description"/>
+ <xsl:call-template name="emit-description"/>
</xsl:template>
<xsl:template match="generic-function/description">
- <xsl:call-template name="emit-symbol-description"/>
+ <xsl:call-template name="emit-description"/>
</xsl:template>
<xsl:template match="slot-reader/description">
- <xsl:call-template name="emit-symbol-description"/>
+ <xsl:call-template name="emit-description"/>
</xsl:template>
<xsl:template match="slot-accessor/description">
- <xsl:call-template name="emit-symbol-description"/>
+ <xsl:call-template name="emit-description"/>
</xsl:template>
+-->
<xsl:template name="emit-type-section">
<xsl:param name="page-type"/>
@@ -404,9 +408,11 @@
</xsl:template>
<xsl:template match="/package">
- <xsl:apply-templates>
- <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
- </xsl:apply-templates>
+ <data>
+ <xsl:apply-templates>
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ </xsl:apply-templates>
+ </data>
</xsl:template>
</xsl:stylesheet>
Added: trunk/docs/manual/gf-package.xsl
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gf-package.xsl Wed Oct 18 21:57:02 2006
@@ -0,0 +1,61 @@
+<!--
+ gf-package.xsl
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<xsl:stylesheet
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+ xmlns:exsl="http://exslt.org/common"
+ version="1.0">
+
+ <xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
+
+ <xsl:template match="/package">
+ <chapter>
+ <title><xsl:value-of select="@fullname"/></title>
+
+ <para role="normal">[Package]</para>
+
+ <bridgehead renderas="sect2">nickname</bridgehead>
+ <para role="normal"><xsl:value-of select="@name"/></para>
+
+ <xsl:for-each select="description">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ description
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:for-each>
+
+ <bridgehead renderas="sect2">classes and structures</bridgehead>
+ <para role="normal">
+ native-object, point, rectangle, size, span
+ </para>
+
+ <bridgehead renderas="sect2">accessors, functions, and macros</bridgehead>
+ <para role="normal">
+ code, copy-point, copy-rectangle, copy-size, copy-span, detail, dispose,
+ disposed-p, dlg-code, empty-span-p, equal-size-p, handle, location,
+ make-point, make-rectangle, make-size, make-span, point-x, point-y,
+ size, size-height, size-width, span-end, span-start
+ </para>
+
+ <bridgehead renderas="sect2">conditions</bridgehead>
+ <para role="normal">
+ comdlg-error, disposed-error, toolkit-error, toolkit-warning, win32-error,
+ win32-warning
+ </para>
+
+ <xsl:for-each select="document('gfs-tmp-syms.xml')/data/section">
+ <xsl:copy-of select="current()"/>
+ </xsl:for-each>
+
+ </chapter>
+ </xsl:template>
+
+</xsl:stylesheet>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 21:57:02 2006
@@ -5,7 +5,14 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<package name="gfs">
+<package name="gfs" fullname="graphic-forms.uitoolkit.system">
+
+ <description>
+ The symbols in this package correspond to system-level functionality,
+ such as foreign function declarations for the Win32 API. The majority
+ of symbols in this package are not exported, except for the
+ fundamental types, conditions, and functions listed below.
+ </description>
<!-- CONDITIONS -->
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Wed Oct 18 21:57:02 2006
@@ -9,8 +9,7 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
- <!ENTITY gfspkg SYSTEM "system-package.xml">
- <!ENTITY gfssymbols SYSTEM "gfs-tmp.xml"> <!-- generated file -->
+ <!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml"> <!-- generated file -->
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
1
0
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>
1
0
Author: junrue
Date: Wed Oct 18 18:04:55 2006
New Revision: 348
Modified:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-symbols.xml
Log:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Wed Oct 18 18:04:55 2006
@@ -6,7 +6,9 @@
-->
<clhs-table>
+ <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
<entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
<entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
<entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
<entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 18:04:55 2006
@@ -125,7 +125,7 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- (<xsl:call-template name="create-id"/>
+ (<xsl:value-of select="concat(../../@name,':',../@name)"/>
<xsl:element name="emphasis">
<xsl:for-each select="arguments/argument">
<xsl:value-of select="concat(' ', @name)"/>
@@ -135,6 +135,8 @@
<xsl:apply-templates select="return"/>
</xsl:element>
</xsl:element>
+
+ <xsl:apply-templates select="arguments"/>
</xsl:template>
<xsl:template match="argument">
@@ -284,6 +286,14 @@
</xsl:element>
</xsl:template>
+ <xsl:template match="function/description">
+ <xsl:call-template name="emit-symbol-description"/>
+ </xsl:template>
+
+ <xsl:template match="generic-function/description">
+ <xsl:call-template name="emit-symbol-description"/>
+ </xsl:template>
+
<xsl:template match="slot-reader/description">
<xsl:call-template name="emit-symbol-description"/>
</xsl:template>
@@ -347,6 +357,18 @@
</xsl:call-template>
</xsl:template>
+ <xsl:template match="function">
+ <xsl:call-template name="emit-function-section">
+ <xsl:with-param name="page-type">Function</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="generic-function">
+ <xsl:call-template name="emit-function-section">
+ <xsl:with-param name="page-type">Generic Function</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
<xsl:template match="slot-accessor">
<xsl:call-template name="emit-function-section">
<xsl:with-param name="page-type">Slot Accessor</xsl:with-param>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 18:04:55 2006
@@ -9,6 +9,24 @@
<!-- CONDITIONS -->
+ <condition name="disposed-error">
+ <description>
+ <hierarchy>
+ <inherits>
+ <refclhs>error</refclhs>
+ </inherits>
+ </hierarchy>
+ This error is raised to indicate an attempt to manipulate a
+ <reftopic>gfs:native-object</reftopic> whose handle has not yet
+ been instantiated or which has been cleaned up via <reftopic>gfs:dispose</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfs:toolkit-error</reftopic>
+ <reftopic>gfs:win32-error</reftopic>
+ <reftopic>gfs:disposed-p</reftopic>
+ </seealso>
+ </condition>
+
<condition name="toolkit-error">
<description>
<hierarchy>
@@ -155,6 +173,7 @@
</initargs>
<seealso>
<reftopic>gfs:code</reftopic>
+ <reftopic>gfs:dlg-code</reftopic>
<reftopic>gfs:detail</reftopic>
<reftopic>gfs:toolkit-warning</reftopic>
<reftopic>gfs:win32-warning</reftopic>
@@ -310,49 +329,53 @@
<!-- FUNCTIONS -->
- <slot-reader name="code">
+ <function name="copy-point">
<syntax>
<arguments>
- <argument name="condition">
+ <argument name="point">
<description>
- The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
- object to be queried.
+ The <reftopic>gfs:point</reftopic> structure to be copied.
</description>
</argument>
</arguments>
<return>
- <refclhs>integer</refclhs>
+ <reftopic label="new point">gfs:point</reftopic>
</return>
</syntax>
<description>
- Returns the Win32 error code for <refargument>condition</refargument>
- as determined by <refwin32api>GetLastError</refwin32api>.
+ Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates
+ were copied from the original.
</description>
- </slot-reader>
+ <seealso>
+ <reftopic>gfs:make-point</reftopic>
+ </seealso>
+ </function>
- <slot-reader name="copy-point">
+ <function name="location">
<syntax>
<arguments>
- <argument name="point">
+ <argument name="rectangle">
<description>
- The <reftopic>gfs:point</reftopic> structure to be copied.
+ The <reftopic>gfs:rectangle</reftopic> to be queried.
</description>
</argument>
</arguments>
<return>
- <reftopic label="new point">gfs:point</reftopic>
+ <reftopic>gfs:point</reftopic>
</return>
</syntax>
<description>
- Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates
- were copied from the original.
+ Returns (sets) the <reftopic>gfs:point</reftopic> identifying the coordinates
+ of the upper-left corner of <refargument>rectangle</refargument>. For
+ performance reasons, the existing slot value is returned directly rather
+ than being copied.
</description>
<seealso>
- <reftopic>gfs:make-point</reftopic>
+ <reftopic>gfs:make-rectangle</reftopic>
</seealso>
- </slot-reader>
+ </function>
- <slot-reader name="copy-rectangle">
+ <function name="copy-rectangle">
<syntax>
<arguments>
<argument name="rectangle">
@@ -372,6 +395,257 @@
<seealso>
<reftopic>gfs:make-rectangle</reftopic>
</seealso>
+ </function>
+
+ <function name="copy-size">
+ <syntax>
+ <arguments>
+ <argument name="size">
+ <description>
+ The <reftopic>gfs:size</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new size">gfs:size</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:size</reftopic> whose width and
+ height values were copied from the original.
+ </description>
+ <seealso>
+ <reftopic>gfs:make-size</reftopic>
+ </seealso>
+ </function>
+
+ <function name="copy-span">
+ <syntax>
+ <arguments>
+ <argument name="span">
+ <description>
+ The <reftopic>gfs:span</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new span">gfs:span</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:span</reftopic> whose start and
+ end values were copied from the original.
+ </description>
+ <seealso>
+ <reftopic>gfs:make-span</reftopic>
+ </seealso>
+ </function>
+
+ <function name="empty-span-p">
+ <syntax>
+ <arguments>
+ <argument name="span">
+ <description>
+ The <reftopic>gfs:span</reftopic> structure to be tested.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if the start and end of <refargument>span</refargument>
+ are the same value.
+ </description>
+ <seealso>
+ <reftopic>gfs:span-start</reftopic>
+ <reftopic>gfs:span-end</reftopic>
+ </seealso>
+ </function>
+
+ <function name="equal-size-p">
+ <syntax>
+ <arguments>
+ <argument name="size1">
+ <description>
+ The first <reftopic>gfs:size</reftopic> structure to be tested.
+ </description>
+ </argument>
+ <argument name="size2">
+ <description>
+ The second <reftopic>gfs:size</reftopic> structure to be tested.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <refargument>size1</refargument> and
+ <refargument>size2</refargument> have the same height and
+ width values.
+ </description>
+ <seealso>
+ <reftopic>gfs:copy-size</reftopic>
+ <reftopic>gfs:size-height</reftopic>
+ <reftopic>gfs:size-width</reftopic>
+ </seealso>
+ </function>
+
+ <!-- GENERIC FUNCTIONS -->
+
+ <generic-function name="disposed-p">
+ <syntax>
+ <arguments>
+ <argument name="native-object">
+ <description>
+ The <reftopic>gfs:native-object</reftopic> whose status is to be
+ queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Returns T if <refargument>native-object</refargument> has not yet been
+ initialized or has been discarded via <reftopic>gfs:dispose</reftopic>;
+ NIL otherwise.
+ </para>
+
+ <para role="normal">
+ Note: this function does not interact with the Common Lisp garbage
+ collector.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfs:disposed-error</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="dispose">
+ <syntax>
+ <arguments>
+ <argument name="native-object">
+ <description>
+ The <reftopic>gfs:native-object</reftopic> object to be disposed.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ undefined
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Discards the system resource encapsulated by <reftopic>gfs:native-object</reftopic>
+ and cleans up various data structures internal to Graphic-Forms. For certain
+ objects, this method has visual side effects (for example, disposing
+ a window will remove that window from the display). A
+ <reftopic>gfs:disposed-error</reftopic>
+ will be raised if application code attempts to manipulate the object
+ after this function returns.
+ </para>
+
+ <para role="normal">
+ Note: this function does not interact with the garbage collector;
+ however, disposed objects will be collected once they are no longer
+ reachable.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfs:disposed-p</reftopic>
+ <reftopic>gfw:event-disposed</reftopic>
+ </seealso>
+ </generic-function>
+
+ <!-- ACCESSORS -->
+
+ <slot-reader name="handle">
+ <syntax>
+ <arguments>
+ <argument name="native-object">
+ <description>
+ The <reftopic>gfs:native-object</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ foreign pointer
+ </return>
+ </syntax>
+ <description>
+ Returns the Win32 HANDLE or foreign pointer associated with
+ <refargument>native-object</refargument>.
+ </description>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfs:disposed-p</reftopic>
+ <reftopic>gfs:disposed-error</reftopic>
+ </seealso>
+ </slot-reader>
+
+ <slot-reader name="dlg-code">
+ <syntax>
+ <arguments>
+ <argument name="condition">
+ <description>
+ The <reftopic>gfs:comdlg-error</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the Win32 error code for <refargument>condition</refargument>
+ as determined by the Common Dialog API function
+ <refwin32api>CommDlgExtendedError</refwin32api>.
+ </description>
+ </slot-reader>
+
+ <slot-reader name="code">
+ <syntax>
+ <arguments>
+ <argument name="condition">
+ <description>
+ The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
+ object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the Win32 error code for <refargument>condition</refargument>
+ as determined by <refwin32api>GetLastError</refwin32api>.
+ </description>
+ </slot-reader>
+
+ <slot-reader name="detail">
+ <syntax>
+ <arguments>
+ <argument name="condition">
+ <description>
+ The <reftopic>gfs:toolkit-error</reftopic> or
+ <reftopic>gfs:toolkit-warning</reftopic> object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>string</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns the detail <refclhs>string</refclhs> for <refargument>condition</refargument>.
+ </description>
</slot-reader>
</package>
1
0
18 Oct '06
Author: junrue
Date: Wed Oct 18 16:37:02 2006
New Revision: 347
Modified:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-symbols.xml
trunk/docs/manual/glossary.xml
trunk/docs/manual/introduction.xml
trunk/docs/website/index.html
Log:
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 16:37:02 2006
@@ -58,26 +58,6 @@
</xsl:element>
</xsl:template>
- <xsl:template name="emit-syntax">
- <xsl:element name="bridgehead">
- <xsl:attribute name="renderas">sect2</xsl:attribute>
- syntax
- </xsl:element>
-
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- (<xsl:call-template name="create-id"/>
- <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:value-of select="return/@type"/>
- </xsl:element>
- </xsl:element>
- </xsl:template>
-
<xsl:template name="emit-symbol-description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
@@ -90,19 +70,11 @@
</xsl:element>
</xsl:template>
- <xsl:template name="emit-ref-target">
- <xsl:param name="role">normal</xsl:param>
- <xsl:choose>
- <xsl:when test="$role='small'">
- <xsl:element name="para">
- <xsl:attribute name="role"><xsl:value-of select="$role"/></xsl:attribute>
- <xsl:value-of select="."/>
- </xsl:element>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="."/>
- </xsl:otherwise>
- </xsl:choose>
+ <xsl:template match="para">
+ <xsl:copy>
+ <xsl:copy-of select="@*"/>
+ <xsl:apply-templates/>
+ </xsl:copy>
</xsl:template>
<xsl:template match="refargument">
@@ -112,38 +84,56 @@
</xsl:template>
<xsl:template match="reftopic">
- <xsl:param name="role">normal</xsl:param>
<xsl:element name="link">
<xsl:attribute name="linkend"><xsl:value-of select="."/></xsl:attribute>
- <xsl:call-template name="emit-ref-target">
- <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
- </xsl:call-template>
+ <xsl:choose>
+ <xsl:when test="@label">
+ <xsl:value-of select="@label"/>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="."/>
+ </xsl:otherwise>
+ </xsl:choose>
</xsl:element>
</xsl:template>
<xsl:template match="refclhs">
- <xsl:param name="role">normal</xsl:param>
<xsl:variable name="tmp" select="string()"/>
<xsl:element name="ulink">
<xsl:attribute name="url">
<xsl:value-of select="$clhs-table//entry[string(@name)=$tmp]/@url"/>
</xsl:attribute>
- <xsl:call-template name="emit-ref-target">
- <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
- </xsl:call-template>
+ <xsl:value-of select="."/>
</xsl:element>
</xsl:template>
<xsl:template match="refwin32api">
- <xsl:param name="role">normal</xsl:param>
<xsl:variable name="tmp" select="string()"/>
<xsl:element name="ulink">
<xsl:attribute name="url">
<xsl:value-of select="$win32-table//entry[string(@name)=$tmp]/@url"/>
</xsl:attribute>
- <xsl:call-template name="emit-ref-target">
- <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
- </xsl:call-template>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="syntax">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ syntax
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ (<xsl:call-template name="create-id"/>
+ <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:template>
@@ -200,15 +190,17 @@
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
<xsl:element name="para">
- <xsl:attribute name="role">small</xsl:attribute>
+ <xsl:attribute name="role">normal</xsl:attribute>
inherits:
</xsl:element>
</xsl:element>
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
- <xsl:apply-templates>
- <xsl:with-param name="role">small</xsl:with-param>
- </xsl:apply-templates>
+ <xsl:for-each select="*">
+ <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
+ <xsl:apply-templates select="."/>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
</xsl:element>
</xsl:element>
</xsl:template>
@@ -218,15 +210,17 @@
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
<xsl:element name="para">
- <xsl:attribute name="role">small</xsl:attribute>
+ <xsl:attribute name="role">normal</xsl:attribute>
inherited by:
</xsl:element>
</xsl:element>
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
- <xsl:apply-templates>
- <xsl:with-param name="role">small</xsl:with-param>
- </xsl:apply-templates>
+ <xsl:for-each select="*">
+ <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
+ <xsl:apply-templates select="."/>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
</xsl:element>
</xsl:element>
</xsl:template>
@@ -247,12 +241,25 @@
<xsl:attribute name="role">normal</xsl:attribute>
<xsl:for-each select="*">
+ <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
<xsl:apply-templates select="."/>
<xsl:if test="not(position()=last())">, </xsl:if>
</xsl:for-each>
</xsl:element>
</xsl:template>
+ <xsl:template match="structure/description">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ description
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
<xsl:template match="class/description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
@@ -318,8 +325,6 @@
<xsl:with-param name="page-type">[<xsl:value-of select="$page-type"/>]</xsl:with-param>
</xsl:call-template>
- <xsl:call-template name="emit-syntax"/>
-
<xsl:apply-templates/>
</xsl:element>
</xsl:template>
@@ -330,6 +335,12 @@
</xsl:call-template>
</xsl:template>
+ <xsl:template match="structure">
+ <xsl:call-template name="emit-type-section">
+ <xsl:with-param name="page-type">Structure</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
<xsl:template match="condition">
<xsl:call-template name="emit-type-section">
<xsl:with-param name="page-type">Condition</xsl:with-param>
Modified: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- trunk/docs/manual/gfs-symbols.xml (original)
+++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 16:37:02 2006
@@ -7,6 +7,8 @@
<package name="gfs">
+ <!-- CONDITIONS -->
+
<condition name="toolkit-error">
<description>
<hierarchy>
@@ -159,20 +161,217 @@
</seealso>
</condition>
- <slot-reader name="code">
- <arguments>
- <argument name="condition">
+ <!-- CLASSES -->
+
+ <class name="native-object">
+ <description>
+ <hierarchy>
+ <inheritedby>
+ <reftopic>gfw:display</reftopic>
+ <reftopic>gfg:image-data-plugin</reftopic>
+ <reftopic>gfg:image</reftopic>
+ <reftopic>gfg:icon-bundle</reftopic>
+ <reftopic>gfg:graphics-context</reftopic>
+ <reftopic>gfg:font</reftopic>
+ <reftopic>gfw:event-source</reftopic>
+ </inheritedby>
+ </hierarchy>
+ <para role="normal">
+ This is the abstract base class for objects representing a system resource
+ such as a window or device context.
+ </para>
+
+ <para role="normal">
+ Graphic-Forms does not register any finalizer for coordination with the
+ garbage collector, since the destruction of these system resources has
+ important application semantics which cannot be postponed. Also, there
+ are often related system resources (especially other native handles) that
+ occupy scarce heap space within system components, so these must be cleaned
+ up promptly as well.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":handle">
+ <description>
+ A Win32 HANDLE or foreign pointer.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfs:handle</reftopic>
+ <reftopic>gfs:disposed-error</reftopic>
+ <reftopic>gfs:disposed-p</reftopic>
+ </seealso>
+ </class>
+
+ <!-- STRUCTURES -->
+
+ <structure name="point">
+ <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>
+ <reftopic>gfs:point-x</reftopic>
+ <reftopic>gfs:point-y</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="rectangle">
+ <description>
+ This structure represents a rectangle in the Cartesian plane.
+ </description>
+ <initargs>
+ <argument name=":location">
+ <description>
+ A <reftopic>gfs:point</reftopic> specifying the rectangle's upper-left
+ corner.
+ </description>
+ </argument>
+ <argument name=":size">
+ <description>
+ A <reftopic>gfs:size</reftopic> specifying the rectangle's dimensions.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:copy-rectangle</reftopic>
+ <reftopic>gfs:location</reftopic>
+ <reftopic>gfs:make-rectangle</reftopic>
+ <reftopic>gfs:size</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="size">
+ <description>
+ This structure represents a 2-dimensional area.
+ </description>
+ <initargs>
+ <argument name=":height">
<description>
- The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
- object to be queried.
+ An <refclhs>integer</refclhs> specifying the height of the area.
</description>
</argument>
- </arguments>
- <return type="integer"/>
+ <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>
+ <reftopic>gfs:make-size</reftopic>
+ <reftopic>gfs:size-height</reftopic>
+ <reftopic>gfs:size-width</reftopic>
+ <reftopic>gfs:rectangle</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="span">
+ <description>
+ This structure represents a contiguous 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>
+ <reftopic>gfs:make-span</reftopic>
+ <reftopic>gfs:span-start</reftopic>
+ <reftopic>gfs:span-end</reftopic>
+ </seealso>
+ </structure>
+
+ <!-- FUNCTIONS -->
+
+ <slot-reader name="code">
+ <syntax>
+ <arguments>
+ <argument name="condition">
+ <description>
+ The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
+ object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>integer</refclhs>
+ </return>
+ </syntax>
<description>
Returns the Win32 error code for <refargument>condition</refargument>
as determined by <refwin32api>GetLastError</refwin32api>.
</description>
</slot-reader>
+ <slot-reader name="copy-point">
+ <syntax>
+ <arguments>
+ <argument name="point">
+ <description>
+ The <reftopic>gfs:point</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new point">gfs:point</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates
+ were copied from the original.
+ </description>
+ <seealso>
+ <reftopic>gfs:make-point</reftopic>
+ </seealso>
+ </slot-reader>
+
+ <slot-reader name="copy-rectangle">
+ <syntax>
+ <arguments>
+ <argument name="rectangle">
+ <description>
+ The <reftopic>gfs:rectangle</reftopic> structure to be copied.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic label="new rectangle">gfs:rectangle</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Returns a new <reftopic>gfs:rectangle</reftopic> whose location and
+ dimension values were (shallow) copied from the original.
+ </description>
+ <seealso>
+ <reftopic>gfs:make-rectangle</reftopic>
+ </seealso>
+ </slot-reader>
+
</package>
Modified: trunk/docs/manual/glossary.xml
==============================================================================
--- trunk/docs/manual/glossary.xml (original)
+++ trunk/docs/manual/glossary.xml Wed Oct 18 16:37:02 2006
@@ -3,9 +3,10 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<glossary><title>Glossary</title>
+<glossary id="glossary"><title>Glossary</title>
+<indexterm><primary>Glossary</primary></indexterm>
-<glossdiv><title>A</title>
+<glossdiv id="glossary-A"><title>A</title>
<glossentry id="accelerator"><glossterm>accelerator</glossterm>
<glossdef>
@@ -35,10 +36,10 @@
</glossdiv>
-<glossdiv><title>B</title>
+<glossdiv id="glossary-B"><title>B</title>
</glossdiv>
-<glossdiv><title>C</title>
+<glossdiv id="glossary-C"><title>C</title>
<glossentry id="control"><glossterm>control</glossterm>
<glossdef>
@@ -52,7 +53,7 @@
</glossdiv>
-<glossdiv><title>D</title>
+<glossdiv id="glossary-D"><title>D</title>
<glossentry id="default action"><glossterm>default action</glossterm>
<glossdef>
@@ -81,7 +82,7 @@
</glossdiv>
-<glossdiv><title>E</title>
+<glossdiv id="glossary-E"><title>E</title>
<glossentry id="extension"><glossterm>extension</glossterm>
<glossdef>
@@ -98,28 +99,28 @@
</glossdiv>
-<glossdiv><title>F</title>
+<glossdiv id="glossary-F"><title>F</title>
</glossdiv>
-<glossdiv><title>G</title>
+<glossdiv id="glossary-G"><title>G</title>
</glossdiv>
-<glossdiv><title>H</title>
+<glossdiv id="glossary-H"><title>H</title>
</glossdiv>
-<glossdiv><title>I</title>
+<glossdiv id="glossary-I"><title>I</title>
</glossdiv>
-<glossdiv><title>J</title>
+<glossdiv id="glossary-J"><title>J</title>
</glossdiv>
-<glossdiv><title>K</title>
+<glossdiv id="glossary-K"><title>K</title>
</glossdiv>
-<glossdiv><title>L</title>
+<glossdiv id="glossary-L"><title>L</title>
</glossdiv>
-<glossdiv><title>M</title>
+<glossdiv id="glossary-M"><title>M</title>
<glossentry id="menu"><glossterm>menu</glossterm>
<glossdef>
@@ -132,7 +133,7 @@
</glossdef>
</glossentry>
- <glossentry id="mix-in class"><glossterm>mix-in class</glossterm>
+ <glossentry id="mix-in"><glossterm>mix-in class</glossterm>
<glossdef>
<para>
A mix-in class represents a specific abstraction that complements
@@ -155,13 +156,13 @@
</glossentry>
</glossdiv>
-<glossdiv><title>N</title>
+<glossdiv id="glossary-N"><title>N</title>
</glossdiv>
-<glossdiv><title>O</title>
+<glossdiv id="glossary-O"><title>O</title>
</glossdiv>
-<glossdiv><title>P</title>
+<glossdiv id="glossary-P"><title>P</title>
<glossentry id="plugin"><glossterm>plugin</glossterm>
<glossdef>
@@ -177,34 +178,34 @@
</glossdiv>
-<glossdiv><title>Q</title>
+<glossdiv id="glossary-Q"><title>Q</title>
</glossdiv>
-<glossdiv><title>R</title>
+<glossdiv id="glossary-R"><title>R</title>
</glossdiv>
-<glossdiv><title>S</title>
+<glossdiv id="glossary-S"><title>S</title>
</glossdiv>
-<glossdiv><title>T</title>
+<glossdiv id="glossary-T"><title>T</title>
</glossdiv>
-<glossdiv><title>U</title>
+<glossdiv id="glossary-U"><title>U</title>
</glossdiv>
-<glossdiv><title>V</title>
+<glossdiv id="glossary-V"><title>V</title>
</glossdiv>
-<glossdiv><title>W</title>
+<glossdiv id="glossary-W"><title>W</title>
</glossdiv>
-<glossdiv><title>X</title>
+<glossdiv id="glossary-X"><title>X</title>
</glossdiv>
-<glossdiv><title>Y</title>
+<glossdiv id="glossary-Y"><title>Y</title>
</glossdiv>
-<glossdiv><title>Z</title>
+<glossdiv id="glossary-Z"><title>Z</title>
</glossdiv>
</glossary>
Modified: trunk/docs/manual/introduction.xml
==============================================================================
--- trunk/docs/manual/introduction.xml (original)
+++ trunk/docs/manual/introduction.xml Wed Oct 18 16:37:02 2006
@@ -5,10 +5,10 @@
-->
<chapter>
<title>Introduction</title>
+ <indexterm><primary>Introduction</primary></indexterm>
<bridgehead renderas="sect2">Background</bridgehead>
<para role="normal">
- <indexterm><primary>Introduction</primary></indexterm>
Graphic-Forms is a user interface library implemented in Common Lisp
focusing on the Windows platform. Graphic-Forms is licensed under the
terms of the BSD License. The goal is to provide a Common Lisp-based
Modified: trunk/docs/website/index.html
==============================================================================
--- trunk/docs/website/index.html (original)
+++ trunk/docs/website/index.html Wed Oct 18 16:37:02 2006
@@ -10,7 +10,7 @@
<body>
<div class="header">
<h1>Graphic-Forms</h1>
- <h2>A user interface toolkit for the Windows platform.</h2>
+ <h2>A user interface toolkit for Windows.</h2>
</div>
<div class="NavBar">
1
0
[graphic-forms-cvs] r346 - in trunk: docs/manual src/uitoolkit/widgets
by junrue＠common-lisp.net 18 Oct '06
by junrue＠common-lisp.net 18 Oct '06
18 Oct '06
Author: junrue
Date: Wed Oct 18 14:16:10 2006
New Revision: 346
Added:
trunk/docs/manual/gfs-symbols.xml
Removed:
trunk/docs/manual/gfs-function-data.xml
trunk/docs/manual/gfs-type-data.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/system-package.xml
trunk/docs/manual/win32-api-table.xml
trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Wed Oct 18 14:16:10 2006
@@ -7,22 +7,19 @@
COMMON-DEPS = gf-data.xsl clhs-table.xml win32-api-table.xml
-INTERIM-XML = system-types.xml system-functions.xml
+TMP-XML = gfs-tmp.xml
XSLT-PROC = xsltproc --nonet
-docs: system-types.xml system-functions.xml
+docs: gfs-tmp.xml
$(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
-hhc htmlhelp.hhp
-system-types.xml: gfs-type-data.xml $(COMMON-DEPS)
- $(XSLT-PROC) --output $@ gf-data.xsl gfs-type-data.xml
-
-system-functions.xml: gfs-function-data.xml $(COMMON-DEPS)
- $(XSLT-PROC) --output $@ gf-data.xsl gfs-function-data.xml
+gfs-tmp.xml: gfs-symbols.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-data.xsl gfs-symbols.xml
clean:
- rm -f $(INTERIM-XML)
+ rm -f $(TMP-XML)
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
scrub: clean
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Wed Oct 18 14:16:10 2006
@@ -6,7 +6,8 @@
-->
<clhs-table>
- <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
- <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
- <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+ <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
+ <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+ <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
</clhs-table>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 14:16:10 2006
@@ -40,7 +40,9 @@
<xsl:attribute name="colwidth"><xsl:value-of select="$col2-width"/></xsl:attribute>
</xsl:element>
<xsl:element name="tbody">
- <xsl:apply-templates/>
+ <xsl:apply-templates>
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ </xsl:apply-templates>
</xsl:element>
</xsl:element>
</xsl:element>
@@ -51,6 +53,7 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
+ [<xsl:value-of select="../@name"/>]
<xsl:value-of select="$page-type"/>
</xsl:element>
</xsl:template>
@@ -180,6 +183,13 @@
<xsl:attribute name="renderas">sect2</xsl:attribute>
initargs
</xsl:element>
+ <xsl:for-each select="argument">
+ <xsl:element name="indexterm">
+ <xsl:element name="primary">
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:for-each>
<xsl:call-template name="emit-table">
<xsl:with-param name="col2-width">5*</xsl:with-param>
</xsl:call-template>
@@ -283,9 +293,7 @@
<xsl:call-template name="emit-index-term"/>
- <xsl:element name="title">
- <xsl:call-template name="create-id"/>
- </xsl:element>
+ <xsl:element name="title"><xsl:value-of select="@name"/></xsl:element>
<xsl:call-template name="emit-page-type">
<xsl:with-param name="page-type">[<xsl:value-of select="$page-type"/>]</xsl:with-param>
@@ -304,9 +312,7 @@
<xsl:call-template name="emit-index-term"/>
- <xsl:element name="title">
- <xsl:call-template name="create-id"/>
- </xsl:element>
+ <xsl:element name="title"><xsl:value-of select="@name"/></xsl:element>
<xsl:call-template name="emit-page-type">
<xsl:with-param name="page-type">[<xsl:value-of select="$page-type"/>]</xsl:with-param>
@@ -318,28 +324,34 @@
</xsl:element>
</xsl:template>
- <xsl:template match="/package/class">
+ <xsl:template match="class">
<xsl:call-template name="emit-type-section">
<xsl:with-param name="page-type">Class</xsl:with-param>
</xsl:call-template>
</xsl:template>
- <xsl:template match="/package/condition">
+ <xsl:template match="condition">
<xsl:call-template name="emit-type-section">
<xsl:with-param name="page-type">Condition</xsl:with-param>
</xsl:call-template>
</xsl:template>
- <xsl:template match="/package/slot-accessor">
+ <xsl:template match="slot-accessor">
<xsl:call-template name="emit-function-section">
<xsl:with-param name="page-type">Slot Accessor</xsl:with-param>
</xsl:call-template>
</xsl:template>
- <xsl:template match="/package/slot-reader">
+ <xsl:template match="slot-reader">
<xsl:call-template name="emit-function-section">
<xsl:with-param name="page-type">Slot Reader</xsl:with-param>
</xsl:call-template>
</xsl:template>
+ <xsl:template match="/package">
+ <xsl:apply-templates>
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ </xsl:apply-templates>
+ </xsl:template>
+
</xsl:stylesheet>
Added: trunk/docs/manual/gfs-symbols.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 14:16:10 2006
@@ -0,0 +1,178 @@
+<?xml version="1.0"?>
+<!--
+ gfs-package-data.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<package name="gfs">
+
+ <condition name="toolkit-error">
+ <description>
+ <hierarchy>
+ <inherits>
+ <refclhs>error</refclhs>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfs:win32-error</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This error is raised to indicate invalid argument values or inconsistent
+ state.
+ </description>
+ <initargs>
+ <argument name=":detail">
+ <description>
+ A <refclhs>string</refclhs> supplying additional problem information.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:detail</reftopic>
+ <reftopic>gfs:toolkit-warning</reftopic>
+ <reftopic>gfs:win32-warning</reftopic>
+ </seealso>
+ </condition>
+
+ <condition name="toolkit-warning">
+ <description>
+ <hierarchy>
+ <inherits>
+ <refclhs>warning</refclhs>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfs:win32-warning</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This warning is raised to indicate non-fatal problems that nevertheless
+ may represent application logic errors.
+ </description>
+ <initargs>
+ <argument name=":detail">
+ <description>
+ A <refclhs>string</refclhs> supplying additional problem information.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:detail</reftopic>
+ <reftopic>gfs:toolkit-error</reftopic>
+ <reftopic>gfs:win32-error</reftopic>
+ </seealso>
+ </condition>
+
+ <condition name="win32-error">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:toolkit-error</reftopic>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfs:comdlg-error</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This error is raised to indicate that a Win32 API function has failed.
+ </description>
+ <initargs>
+ <argument name=":code">
+ <description>
+ The error code returned by <refwin32api>GetLastError</refwin32api>.
+ </description>
+ </argument>
+ <argument name=":detail">
+ <description>
+ See <reftopic>gfs:toolkit-error</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:code</reftopic>
+ <reftopic>gfs:detail</reftopic>
+ <reftopic>gfs:toolkit-warning</reftopic>
+ <reftopic>gfs:win32-warning</reftopic>
+ </seealso>
+ </condition>
+
+ <condition name="win32-warning">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:toolkit-warning</reftopic>
+ </inherits>
+ </hierarchy>
+ This warning is reported when a Win32 API function has failed in a
+ non-fatal manner which may indicate a logic error on the part of
+ the application.
+ </description>
+ <initargs>
+ <argument name=":code">
+ <description>
+ The error code returned by <refwin32api>GetLastError</refwin32api>.
+ </description>
+ </argument>
+ <argument name=":detail">
+ <description>
+ See <reftopic>gfs:toolkit-error</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:code</reftopic>
+ <reftopic>gfs:detail</reftopic>
+ <reftopic>gfs:toolkit-error</reftopic>
+ <reftopic>gfs:win32-error</reftopic>
+ </seealso>
+ </condition>
+
+ <condition name="comdlg-error">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:win32-error</reftopic>
+ </inherits>
+ </hierarchy>
+ This error is raised to indicate that a Win32 Common Dialog API function
+ has failed.
+ </description>
+ <initargs>
+ <argument name=":dlg-code">
+ <description>
+ The error code returned by <refwin32api>CommDlgExtendedError</refwin32api>.
+ </description>
+ </argument>
+ <argument name=":code">
+ <description>
+ See <reftopic>gfs:win32-error</reftopic>.
+ </description>
+ </argument>
+ <argument name=":detail">
+ <description>
+ See <reftopic>gfs:toolkit-error</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:code</reftopic>
+ <reftopic>gfs:detail</reftopic>
+ <reftopic>gfs:toolkit-warning</reftopic>
+ <reftopic>gfs:win32-warning</reftopic>
+ </seealso>
+ </condition>
+
+ <slot-reader name="code">
+ <arguments>
+ <argument name="condition">
+ <description>
+ The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
+ object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return type="integer"/>
+ <description>
+ Returns the Win32 error code for <refargument>condition</refargument>
+ as determined by <refwin32api>GetLastError</refwin32api>.
+ </description>
+ </slot-reader>
+
+</package>
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Wed Oct 18 14:16:10 2006
@@ -10,8 +10,7 @@
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
<!ENTITY gfspkg SYSTEM "system-package.xml">
- <!ENTITY gfstypes SYSTEM "system-types.xml"> <!-- generated file -->
- <!ENTITY gfsfuncs SYSTEM "system-functions.xml"> <!-- generated file -->
+ <!ENTITY gfssymbols SYSTEM "gfs-tmp.xml"> <!-- generated file -->
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
@@ -19,10 +18,12 @@
<book>
<title>Graphic-Forms</title>
- <subtitle>Programming Reference (version 0.6)</subtitle>
+ <subtitle>
+ A Common Lisp user interface toolkit for Windows.
+ </subtitle>
<bridgehead renderas="sect2">
- A Common Lisp user interface toolkit for the Windows platform.
+ Programming Reference (version 0.6)
</bridgehead>
Modified: trunk/docs/manual/system-package.xml
==============================================================================
--- trunk/docs/manual/system-package.xml (original)
+++ trunk/docs/manual/system-package.xml Wed Oct 18 14:16:10 2006
@@ -38,7 +38,6 @@
win32-warning
</para>
- &gfstypes;
- &gfsfuncs;
+ &gfssymbols;
</chapter>
Modified: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- trunk/docs/manual/win32-api-table.xml (original)
+++ trunk/docs/manual/win32-api-table.xml Wed Oct 18 14:16:10 2006
@@ -6,5 +6,6 @@
-->
<win32-api-table>
- <entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base…"/>
+ <entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winu…"/>
+ <entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base…"/>
</win32-api-table>
Modified: trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp
==============================================================================
--- trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp (original)
+++ trunk/src/uitoolkit/widgets/scrolling-event-dispatcher.lisp Wed Oct 18 14:16:10 2006
@@ -131,7 +131,6 @@
;;;
(defmethod event-pre-resize ((disp scrolling-event-dispatcher) (window window) rect type)
- (declare (ignore type))
(let ((h-step (gfs:size-width (step-increments disp)))
(v-step (gfs:size-height (step-increments disp)))
(outer-size (gfw:size window))
1
0
Author: junrue
Date: Wed Oct 18 03:46:35 2006
New Revision: 345
Removed:
trunk/docs/manual/ApiReference.html
trunk/docs/manual/ConstantsAndVariables.html
trunk/docs/manual/Footnotes.html
trunk/docs/manual/Glossary.html
trunk/docs/manual/Graphic-FormsProgrammingReference.wcp
trunk/docs/manual/GraphicsPackage.html
trunk/docs/manual/ImageDataPlugins.html
trunk/docs/manual/Introduction.html
trunk/docs/manual/LegalInfo.html
trunk/docs/manual/MiscellaneousTopics.html
trunk/docs/manual/Prerequisites.html
trunk/docs/manual/Support.html
trunk/docs/manual/SystemPackage.html
trunk/docs/manual/TerminologyConventions.html
trunk/docs/manual/WidgetsPackage.html
Modified:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-function-data.xml
trunk/docs/manual/gfs-type-data.xml
trunk/docs/manual/graphic-forms.css
Log:
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 03:46:35 2006
@@ -18,6 +18,14 @@
<xsl:value-of select="concat(../@name,':',@name)"/>
</xsl:template>
+ <xsl:template name="emit-index-term">
+ <xsl:element name="indexterm">
+ <xsl:element name="primary">
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:template>
+
<xsl:template name="emit-table">
<xsl:param name="col2-width"/>
@@ -79,6 +87,21 @@
</xsl:element>
</xsl:template>
+ <xsl:template name="emit-ref-target">
+ <xsl:param name="role">normal</xsl:param>
+ <xsl:choose>
+ <xsl:when test="$role='small'">
+ <xsl:element name="para">
+ <xsl:attribute name="role"><xsl:value-of select="$role"/></xsl:attribute>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:when>
+ <xsl:otherwise>
+ <xsl:value-of select="."/>
+ </xsl:otherwise>
+ </xsl:choose>
+ </xsl:template>
+
<xsl:template match="refargument">
<xsl:element name="emphasis">
<xsl:value-of select="."/>
@@ -86,29 +109,38 @@
</xsl:template>
<xsl:template match="reftopic">
+ <xsl:param name="role">normal</xsl:param>
<xsl:element name="link">
<xsl:attribute name="linkend"><xsl:value-of select="."/></xsl:attribute>
- <xsl:value-of select="."/>
+ <xsl:call-template name="emit-ref-target">
+ <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
+ </xsl:call-template>
</xsl:element>
</xsl:template>
<xsl:template match="refclhs">
+ <xsl:param name="role">normal</xsl:param>
<xsl:variable name="tmp" select="string()"/>
<xsl:element name="ulink">
<xsl:attribute name="url">
<xsl:value-of select="$clhs-table//entry[string(@name)=$tmp]/@url"/>
</xsl:attribute>
- <xsl:value-of select="."/>
+ <xsl:call-template name="emit-ref-target">
+ <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
+ </xsl:call-template>
</xsl:element>
</xsl:template>
<xsl:template match="refwin32api">
+ <xsl:param name="role">normal</xsl:param>
<xsl:variable name="tmp" select="string()"/>
<xsl:element name="ulink">
<xsl:attribute name="url">
<xsl:value-of select="$win32-table//entry[string(@name)=$tmp]/@url"/>
</xsl:attribute>
- <xsl:value-of select="."/>()
+ <xsl:call-template name="emit-ref-target">
+ <xsl:with-param name="role"><xsl:value-of select="$role"/></xsl:with-param>
+ </xsl:call-template>
</xsl:element>
</xsl:template>
@@ -154,19 +186,47 @@
</xsl:template>
<xsl:template match="inherits">
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- inherits:<xsl:apply-templates/>
+ <xsl:element name="row">
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:element name="para">
+ <xsl:attribute name="role">small</xsl:attribute>
+ inherits:
+ </xsl:element>
+ </xsl:element>
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:apply-templates>
+ <xsl:with-param name="role">small</xsl:with-param>
+ </xsl:apply-templates>
+ </xsl:element>
</xsl:element>
</xsl:template>
<xsl:template match="inheritedby">
- <xsl:element name="para">
- <xsl:attribute name="role">normal</xsl:attribute>
- inherited by:<xsl:apply-templates/>
+ <xsl:element name="row">
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:element name="para">
+ <xsl:attribute name="role">small</xsl:attribute>
+ inherited by:
+ </xsl:element>
+ </xsl:element>
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:apply-templates>
+ <xsl:with-param name="role">small</xsl:with-param>
+ </xsl:apply-templates>
+ </xsl:element>
</xsl:element>
</xsl:template>
+ <xsl:template match="hierarchy">
+ <xsl:call-template name="emit-table">
+ <xsl:with-param name="col2-width">8*</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
<xsl:template match="*/seealso">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
@@ -195,20 +255,34 @@
</xsl:element>
</xsl:template>
- <xsl:template match="slot-accessor/description">
- <xsl:call-template name="emit-symbol-description"/>
+ <xsl:template match="condition/description">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ description
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:apply-templates/>
+ </xsl:element>
</xsl:template>
<xsl:template match="slot-reader/description">
<xsl:call-template name="emit-symbol-description"/>
</xsl:template>
+ <xsl:template match="slot-accessor/description">
+ <xsl:call-template name="emit-symbol-description"/>
+ </xsl:template>
+
<xsl:template name="emit-type-section">
<xsl:param name="page-type"/>
<xsl:element name="section">
<xsl:attribute name="id"><xsl:call-template name="create-id"/></xsl:attribute>
+ <xsl:call-template name="emit-index-term"/>
+
<xsl:element name="title">
<xsl:call-template name="create-id"/>
</xsl:element>
@@ -228,6 +302,8 @@
<xsl:element name="section">
<xsl:attribute name="id"><xsl:call-template name="create-id"/></xsl:attribute>
+ <xsl:call-template name="emit-index-term"/>
+
<xsl:element name="title">
<xsl:call-template name="create-id"/>
</xsl:element>
@@ -248,6 +324,12 @@
</xsl:call-template>
</xsl:template>
+ <xsl:template match="/package/condition">
+ <xsl:call-template name="emit-type-section">
+ <xsl:with-param name="page-type">Condition</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
<xsl:template match="/package/slot-accessor">
<xsl:call-template name="emit-function-section">
<xsl:with-param name="page-type">Slot Accessor</xsl:with-param>
Modified: trunk/docs/manual/gfs-function-data.xml
==============================================================================
--- trunk/docs/manual/gfs-function-data.xml (original)
+++ trunk/docs/manual/gfs-function-data.xml Wed Oct 18 03:46:35 2006
@@ -9,9 +9,9 @@
<slot-reader name="code">
<arguments>
- <argument name="condition" type="cl:condition">
+ <argument name="condition">
<description>
- The <reftopic>win32-error</reftopic> or <reftopic>win32-warning</reftopic>
+ The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic>
object to be queried.
</description>
</argument>
Modified: trunk/docs/manual/gfs-type-data.xml
==============================================================================
--- trunk/docs/manual/gfs-type-data.xml (original)
+++ trunk/docs/manual/gfs-type-data.xml Wed Oct 18 03:46:35 2006
@@ -7,14 +7,16 @@
<package name="gfs">
- <class name="toolkit-error">
+ <condition name="toolkit-error">
<description>
- <inherits>
- <refclhs>error</refclhs>
- </inherits>
- <inheritedby>
- <reftopic>win32-error</reftopic>
- </inheritedby>
+ <hierarchy>
+ <inherits>
+ <refclhs>error</refclhs>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfs:win32-error</reftopic>
+ </inheritedby>
+ </hierarchy>
This error is raised to indicate invalid argument values or inconsistent
state.
</description>
@@ -26,11 +28,43 @@
</argument>
</initargs>
<seealso>
- <reftopic>detail</reftopic>
- <reftopic>toolkit-warning</reftopic>
- <reftopic>win32-warning</reftopic>
+ <reftopic>gfs:detail</reftopic>
+ <reftopic>gfs:toolkit-warning</reftopic>
+ <reftopic>gfs:win32-warning</reftopic>
</seealso>
- </class>
+ </condition>
+
+ <condition name="win32-error">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:toolkit-error</reftopic>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfs:comdlg-error</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This error is raised to indicate that a Win32 API function has failed.
+ </description>
+ <initargs>
+ <argument name=":code">
+ <description>
+ The error code returned by <refwin32api>GetLastError</refwin32api>.
+ </description>
+ </argument>
+ <argument name=":detail">
+ <description>
+ See <reftopic>gfs:toolkit-error</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:code</reftopic>
+ <reftopic>gfs:detail</reftopic>
+ <reftopic>gfs:toolkit-warning</reftopic>
+ <reftopic>gfs:win32-warning</reftopic>
+ </seealso>
+ </condition>
</package>
Modified: trunk/docs/manual/graphic-forms.css
==============================================================================
--- trunk/docs/manual/graphic-forms.css (original)
+++ trunk/docs/manual/graphic-forms.css Wed Oct 18 03:46:35 2006
@@ -37,7 +37,7 @@
font-family: { Arial, Helvetica, sans-serif; }
}
-p.small {
+a.small, p.small {
font-size: 11;
font-family: { Arial, Helvetica, sans-serif; }
}
1
0
Author: junrue
Date: Wed Oct 18 03:46:13 2006
New Revision: 344
Removed:
trunk/docs/manual/gfs/
Log:
1
0
Author: junrue
Date: Wed Oct 18 03:45:30 2006
New Revision: 343
Removed:
trunk/docs/manual/gfw/
Log:
1
0
Author: junrue
Date: Wed Oct 18 03:44:55 2006
New Revision: 342
Removed:
trunk/docs/manual/gfg/
Log:
1
0
Author: junrue
Date: Wed Oct 18 02:54:47 2006
New Revision: 341
Added:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gfs-type-data.xml
trunk/docs/manual/win32-api-table.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-function-data.xml
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/graphic-forms.xsl
trunk/docs/manual/system-package.xml
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Wed Oct 18 02:54:47 2006
@@ -5,15 +5,24 @@
# Copyright (c) 2006, Jack D. Unrue
#
-docs: system-functions.xml
- xsltproc --nonet graphic-forms.xsl graphic-forms.xml
+COMMON-DEPS = gf-data.xsl clhs-table.xml win32-api-table.xml
+
+INTERIM-XML = system-types.xml system-functions.xml
+
+XSLT-PROC = xsltproc --nonet
+
+docs: system-types.xml system-functions.xml
+ $(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
-hhc htmlhelp.hhp
-system-functions.xml: gfs-function-data.xml gf-data.xsl
- xsltproc --nonet --output system-functions.xml gf-data.xsl gfs-function-data.xml
+system-types.xml: gfs-type-data.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-data.xsl gfs-type-data.xml
+
+system-functions.xml: gfs-function-data.xml $(COMMON-DEPS)
+ $(XSLT-PROC) --output $@ gf-data.xsl gfs-function-data.xml
clean:
- rm -f system-functions.xml
+ rm -f $(INTERIM-XML)
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
scrub: clean
Added: trunk/docs/manual/clhs-table.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/clhs-table.xml Wed Oct 18 02:54:47 2006
@@ -0,0 +1,12 @@
+<?xml version="1.0"?>
+<!--
+ clhs-table.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<clhs-table>
+ <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
+ <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+</clhs-table>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Wed Oct 18 02:54:47 2006
@@ -11,21 +11,43 @@
<xsl:output method="xml" omit-xml-declaration="yes" indent="yes"/>
- <xsl:template name="page-type">
- <xsl:param name="type-str"/>
+ <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,':',@name)"/>
+ </xsl:template>
+
+ <xsl:template name="emit-table">
+ <xsl:param name="col2-width"/>
+
+ <xsl:element name="informaltable">
+ <xsl:attribute name="frame">none</xsl:attribute>
+ <xsl:element name="tgroup">
+ <xsl:attribute name="cols">2</xsl:attribute>
+ <xsl:element name="colspec">
+ <xsl:attribute name="colwidth">*</xsl:attribute>
+ </xsl:element>
+ <xsl:element name="colspec">
+ <xsl:attribute name="colwidth"><xsl:value-of select="$col2-width"/></xsl:attribute>
+ </xsl:element>
+ <xsl:element name="tbody">
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template name="emit-page-type">
+ <xsl:param name="page-type"/>
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- <xsl:value-of select="$type-str"/>
+ <xsl:value-of select="$page-type"/>
</xsl:element>
</xsl:template>
- <xsl:template name="syntax">
- <xsl:param name="package"/>
- <xsl:param name="name"/>
- <xsl:param name="arguments"/>
- <xsl:param name="return-type"/>
-
+ <xsl:template name="emit-syntax">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
syntax
@@ -33,20 +55,81 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- (<xsl:value-of select="$package"/>:<xsl:value-of select="$name"/>
+ (<xsl:call-template name="create-id"/>
<xsl:element name="emphasis">
- <xsl:value-of select="$arguments"/>
+ <xsl:for-each select="arguments/argument">
+ <xsl:value-of select="concat(' ', @name)"/>
+ </xsl:for-each>
</xsl:element>) =>
<xsl:element name="emphasis">
- <xsl:value-of select="$return-type"/>
+ <xsl:value-of select="return/@type"/>
</xsl:element>
</xsl:element>
</xsl:template>
+ <xsl:template name="emit-symbol-description">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ description
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="refargument">
+ <xsl:element name="emphasis">
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="reftopic">
+ <xsl:element name="link">
+ <xsl:attribute name="linkend"><xsl:value-of select="."/></xsl:attribute>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="refclhs">
+ <xsl:variable name="tmp" select="string()"/>
+ <xsl:element name="ulink">
+ <xsl:attribute name="url">
+ <xsl:value-of select="$clhs-table//entry[string(@name)=$tmp]/@url"/>
+ </xsl:attribute>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="refwin32api">
+ <xsl:variable name="tmp" select="string()"/>
+ <xsl:element name="ulink">
+ <xsl:attribute name="url">
+ <xsl:value-of select="$win32-table//entry[string(@name)=$tmp]/@url"/>
+ </xsl:attribute>
+ <xsl:value-of select="."/>()
+ </xsl:element>
+ </xsl:template>
+
<xsl:template match="argument">
<xsl:element name="row">
- <xsl:element name="entry"><xsl:value-of select="@name"/></xsl:element>
- <xsl:element name="entry"><xsl:value-of select="description"/></xsl:element>
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:element name="emphasis">
+ <xsl:value-of select="@name"/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:element>
+ <xsl:element name="entry">
+ <xsl:attribute name="valign">top</xsl:attribute>
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:apply-templates select="description"/>
+ </xsl:element>
+ </xsl:element>
</xsl:element>
</xsl:template>
@@ -55,18 +138,52 @@
<xsl:attribute name="renderas">sect2</xsl:attribute>
arguments
</xsl:element>
- <xsl:element name="informaltable">
- <xsl:attribute name="frame">none</xsl:attribute>
- <xsl:element name="tgroup">
- <xsl:attribute name="cols">2</xsl:attribute>
- <xsl:element name="tbody">
- <xsl:apply-templates/>
- </xsl:element>
- </xsl:element>
+ <xsl:call-template name="emit-table">
+ <xsl:with-param name="col2-width">5*</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="initargs">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ initargs
</xsl:element>
+ <xsl:call-template name="emit-table">
+ <xsl:with-param name="col2-width">5*</xsl:with-param>
+ </xsl:call-template>
</xsl:template>
- <xsl:template match="slot-accessor/description">
+ <xsl:template match="inherits">
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ inherits:<xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="inheritedby">
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ inherited by:<xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="*/seealso">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ see also
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+
+ <xsl:for-each select="*">
+ <xsl:apply-templates select="."/>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="class/description">
<xsl:element name="bridgehead">
<xsl:attribute name="renderas">sect2</xsl:attribute>
description
@@ -74,33 +191,73 @@
<xsl:element name="para">
<xsl:attribute name="role">normal</xsl:attribute>
- <xsl:value-of select="."/>
+ <xsl:apply-templates/>
</xsl:element>
</xsl:template>
- <xsl:template match="slot-accessor">
+ <xsl:template match="slot-accessor/description">
+ <xsl:call-template name="emit-symbol-description"/>
+ </xsl:template>
+
+ <xsl:template match="slot-reader/description">
+ <xsl:call-template name="emit-symbol-description"/>
+ </xsl:template>
+
+ <xsl:template name="emit-type-section">
+ <xsl:param name="page-type"/>
+
<xsl:element name="section">
+ <xsl:attribute name="id"><xsl:call-template name="create-id"/></xsl:attribute>
+
<xsl:element name="title">
- <xsl:value-of select="@package"/>:<xsl:value-of select="@name"/>
+ <xsl:call-template name="create-id"/>
</xsl:element>
- <xsl:call-template name="page-type">
- <xsl:with-param name="type-str">[Slot Accessor]</xsl:with-param>
+ <xsl:call-template name="emit-page-type">
+ <xsl:with-param name="page-type">[<xsl:value-of select="$page-type"/>]</xsl:with-param>
</xsl:call-template>
- <xsl:call-template name="syntax">
- <xsl:with-param name="package"><xsl:value-of select="@package"/></xsl:with-param>
- <xsl:with-param name="name"><xsl:value-of select="@name"/></xsl:with-param>
- <xsl:with-param name="arguments">
- <xsl:for-each select="arguments/argument">
- <xsl:element name="foo"><xsl:value-of select="concat(' ', @name)"/></xsl:element>
- </xsl:for-each>
- </xsl:with-param>
- <xsl:with-param name="return-type"><xsl:value-of select="return/@type"/></xsl:with-param>
+ <xsl:apply-templates/>
+ </xsl:element>
+
+ </xsl:template>
+
+ <xsl:template name="emit-function-section">
+ <xsl:param name="page-type"/>
+
+ <xsl:element name="section">
+ <xsl:attribute name="id"><xsl:call-template name="create-id"/></xsl:attribute>
+
+ <xsl:element name="title">
+ <xsl:call-template name="create-id"/>
+ </xsl:element>
+
+ <xsl:call-template name="emit-page-type">
+ <xsl:with-param name="page-type">[<xsl:value-of select="$page-type"/>]</xsl:with-param>
</xsl:call-template>
+ <xsl:call-template name="emit-syntax"/>
+
<xsl:apply-templates/>
</xsl:element>
</xsl:template>
+ <xsl:template match="/package/class">
+ <xsl:call-template name="emit-type-section">
+ <xsl:with-param name="page-type">Class</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="/package/slot-accessor">
+ <xsl:call-template name="emit-function-section">
+ <xsl:with-param name="page-type">Slot Accessor</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
+ <xsl:template match="/package/slot-reader">
+ <xsl:call-template name="emit-function-section">
+ <xsl:with-param name="page-type">Slot Reader</xsl:with-param>
+ </xsl:call-template>
+ </xsl:template>
+
</xsl:stylesheet>
Modified: trunk/docs/manual/gfs-function-data.xml
==============================================================================
--- trunk/docs/manual/gfs-function-data.xml (original)
+++ trunk/docs/manual/gfs-function-data.xml Wed Oct 18 02:54:47 2006
@@ -5,17 +5,23 @@
Copyright (c) 2006, Jack D. Unrue
-->
-<slot-accessor package="gfs" name="code">
- <arguments>
- <argument name="condition" type="cl:condition">
- <description>
- The condition object to be queried; must be of type
- win32-error or win32-warning or subclasses thereof.
- </description>
- </argument>
- </arguments>
- <return type="integer"/>
- <description>
- Returns the Win32 error code for the specified condition.
- </description>
-</slot-accessor>
+<package name="gfs">
+
+ <slot-reader name="code">
+ <arguments>
+ <argument name="condition" type="cl:condition">
+ <description>
+ The <reftopic>win32-error</reftopic> or <reftopic>win32-warning</reftopic>
+ object to be queried.
+ </description>
+ </argument>
+ </arguments>
+ <return type="integer"/>
+ <description>
+ Returns the Win32 error code for <refargument>condition</refargument>
+ as determined by <refwin32api>GetLastError</refwin32api>.
+ </description>
+ </slot-reader>
+
+</package>
+
Added: trunk/docs/manual/gfs-type-data.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfs-type-data.xml Wed Oct 18 02:54:47 2006
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!--
+ gfs-type-data.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<package name="gfs">
+
+ <class name="toolkit-error">
+ <description>
+ <inherits>
+ <refclhs>error</refclhs>
+ </inherits>
+ <inheritedby>
+ <reftopic>win32-error</reftopic>
+ </inheritedby>
+ This error is raised to indicate invalid argument values or inconsistent
+ state.
+ </description>
+ <initargs>
+ <argument name=":detail">
+ <description>
+ A <refclhs>string</refclhs> supplying additional problem information.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>detail</reftopic>
+ <reftopic>toolkit-warning</reftopic>
+ <reftopic>win32-warning</reftopic>
+ </seealso>
+ </class>
+
+</package>
+
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Wed Oct 18 02:54:47 2006
@@ -10,6 +10,7 @@
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
<!ENTITY gfspkg SYSTEM "system-package.xml">
+ <!ENTITY gfstypes SYSTEM "system-types.xml"> <!-- generated file -->
<!ENTITY gfsfuncs SYSTEM "system-functions.xml"> <!-- generated file -->
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
Modified: trunk/docs/manual/graphic-forms.xsl
==============================================================================
--- trunk/docs/manual/graphic-forms.xsl (original)
+++ trunk/docs/manual/graphic-forms.xsl Wed Oct 18 02:54:47 2006
@@ -22,6 +22,12 @@
<xsl:param name="htmlhelp.hhc.folders.instead.books" select="0"/>
<xsl:param name="htmlhelp.show.advanced.search" select="1"/>
<xsl:param name="suppress.navigation" select="1"/>
+<!--
+ xsltproc doesn't implement the adjustColumnWidths function
+
+ <xsl:param name="use.extensions" select="1"/>
+ <xsl:param name="tablecolumn.extensions" select="1"/>
+-->
<xsl:template name="user.footer.content">
<div class="footer">
Copyright © 2006, Jack D. Unrue
Modified: trunk/docs/manual/system-package.xml
==============================================================================
--- trunk/docs/manual/system-package.xml (original)
+++ trunk/docs/manual/system-package.xml Wed Oct 18 02:54:47 2006
@@ -38,6 +38,7 @@
win32-warning
</para>
+ &gfstypes;
&gfsfuncs;
</chapter>
Added: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/win32-api-table.xml Wed Oct 18 02:54:47 2006
@@ -0,0 +1,10 @@
+<?xml version="1.0"?>
+<!--
+ win32-api-table.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<win32-api-table>
+ <entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base…"/>
+</win32-api-table>
1
0
Author: junrue
Date: Tue Oct 17 23:24:17 2006
New Revision: 340
Added:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfs-function-data.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/api.xml
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/graphic-forms.xsl
trunk/docs/manual/system-package.xml
Log:
initial steps at generating DocBook content
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Tue Oct 17 23:24:17 2006
@@ -5,11 +5,15 @@
# Copyright (c) 2006, Jack D. Unrue
#
-docs:
+docs: system-functions.xml
xsltproc --nonet graphic-forms.xsl graphic-forms.xml
-hhc htmlhelp.hhp
+system-functions.xml: gfs-function-data.xml gf-data.xsl
+ xsltproc --nonet --output system-functions.xml gf-data.xsl gfs-function-data.xml
+
clean:
+ rm -f system-functions.xml
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
scrub: clean
Modified: trunk/docs/manual/api.xml
==============================================================================
--- trunk/docs/manual/api.xml (original)
+++ trunk/docs/manual/api.xml Tue Oct 17 23:24:17 2006
@@ -10,6 +10,6 @@
This chapter documents the Graphic-Forms programming interface.
</para>
- &systempkg;
+ &gfspkg;
</chapter>
Added: trunk/docs/manual/gf-data.xsl
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gf-data.xsl Tue Oct 17 23:24:17 2006
@@ -0,0 +1,106 @@
+<?xml version="1.0"?>
+<!--
+ gf-data.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:output method="xml" omit-xml-declaration="yes" indent="yes"/>
+
+ <xsl:template name="page-type">
+ <xsl:param name="type-str"/>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:value-of select="$type-str"/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template name="syntax">
+ <xsl:param name="package"/>
+ <xsl:param name="name"/>
+ <xsl:param name="arguments"/>
+ <xsl:param name="return-type"/>
+
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ syntax
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ (<xsl:value-of select="$package"/>:<xsl:value-of select="$name"/>
+ <xsl:element name="emphasis">
+ <xsl:value-of select="$arguments"/>
+ </xsl:element>) =>
+ <xsl:element name="emphasis">
+ <xsl:value-of select="$return-type"/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="argument">
+ <xsl:element name="row">
+ <xsl:element name="entry"><xsl:value-of select="@name"/></xsl:element>
+ <xsl:element name="entry"><xsl:value-of select="description"/></xsl:element>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="arguments">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ arguments
+ </xsl:element>
+ <xsl:element name="informaltable">
+ <xsl:attribute name="frame">none</xsl:attribute>
+ <xsl:element name="tgroup">
+ <xsl:attribute name="cols">2</xsl:attribute>
+ <xsl:element name="tbody">
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:element>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="slot-accessor/description">
+ <xsl:element name="bridgehead">
+ <xsl:attribute name="renderas">sect2</xsl:attribute>
+ description
+ </xsl:element>
+
+ <xsl:element name="para">
+ <xsl:attribute name="role">normal</xsl:attribute>
+ <xsl:value-of select="."/>
+ </xsl:element>
+ </xsl:template>
+
+ <xsl:template match="slot-accessor">
+ <xsl:element name="section">
+ <xsl:element name="title">
+ <xsl:value-of select="@package"/>:<xsl:value-of select="@name"/>
+ </xsl:element>
+
+ <xsl:call-template name="page-type">
+ <xsl:with-param name="type-str">[Slot Accessor]</xsl:with-param>
+ </xsl:call-template>
+
+ <xsl:call-template name="syntax">
+ <xsl:with-param name="package"><xsl:value-of select="@package"/></xsl:with-param>
+ <xsl:with-param name="name"><xsl:value-of select="@name"/></xsl:with-param>
+ <xsl:with-param name="arguments">
+ <xsl:for-each select="arguments/argument">
+ <xsl:element name="foo"><xsl:value-of select="concat(' ', @name)"/></xsl:element>
+ </xsl:for-each>
+ </xsl:with-param>
+ <xsl:with-param name="return-type"><xsl:value-of select="return/@type"/></xsl:with-param>
+ </xsl:call-template>
+
+ <xsl:apply-templates/>
+ </xsl:element>
+ </xsl:template>
+
+</xsl:stylesheet>
Added: trunk/docs/manual/gfs-function-data.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/gfs-function-data.xml Tue Oct 17 23:24:17 2006
@@ -0,0 +1,21 @@
+<?xml version="1.0"?>
+<!--
+ gfs-function-data.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+
+<slot-accessor package="gfs" name="code">
+ <arguments>
+ <argument name="condition" type="cl:condition">
+ <description>
+ The condition object to be queried; must be of type
+ win32-error or win32-warning or subclasses thereof.
+ </description>
+ </argument>
+ </arguments>
+ <return type="integer"/>
+ <description>
+ Returns the Win32 error code for the specified condition.
+ </description>
+</slot-accessor>
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Tue Oct 17 23:24:17 2006
@@ -9,7 +9,8 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
- <!ENTITY systempkg SYSTEM "system-package.xml">
+ <!ENTITY gfspkg SYSTEM "system-package.xml">
+ <!ENTITY gfsfuncs SYSTEM "system-functions.xml"> <!-- generated file -->
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
Modified: trunk/docs/manual/graphic-forms.xsl
==============================================================================
--- trunk/docs/manual/graphic-forms.xsl (original)
+++ trunk/docs/manual/graphic-forms.xsl Tue Oct 17 23:24:17 2006
@@ -5,6 +5,7 @@
Copyright (c) 2006, Jack D. Unrue
-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
<xsl:import href="htmlhelp.xsl"/>
<xsl:param name="chapter.autolabel" select="0"/>
<xsl:param name="chunk.first.sections" select="1"/>
@@ -26,4 +27,5 @@
Copyright © 2006, Jack D. Unrue
</div>
</xsl:template>
+
</xsl:stylesheet>
Modified: trunk/docs/manual/system-package.xml
==============================================================================
--- trunk/docs/manual/system-package.xml (original)
+++ trunk/docs/manual/system-package.xml Tue Oct 17 23:24:17 2006
@@ -1,12 +1,12 @@
<!--
- system-pkg.xml
+ system-package.xml
Copyright (c) 2006, Jack D. Unrue
-->
<chapter>
<title>graphic-forms.uitoolkit.system</title>
- <para role="normal">[package]</para>
+ <para role="normal">[Package]</para>
<bridgehead renderas="sect2">nickname</bridgehead>
<para role="normal">GFS</para>
@@ -38,4 +38,6 @@
win32-warning
</para>
+ &gfsfuncs;
+
</chapter>
1
0
Author: junrue
Date: Tue Oct 17 19:54:50 2006
New Revision: 339
Added:
trunk/docs/manual/api.xml
trunk/docs/manual/system-package.xml
Modified:
trunk/docs/manual/graphic-forms.css
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/graphic-forms.xsl
Log:
Added: trunk/docs/manual/api.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/api.xml Tue Oct 17 19:54:50 2006
@@ -0,0 +1,15 @@
+<!--
+ api.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+<chapter>
+ <title>API Reference</title>
+
+ <para role="normal">
+ This chapter documents the Graphic-Forms programming interface.
+ </para>
+
+ &systempkg;
+
+</chapter>
Modified: trunk/docs/manual/graphic-forms.css
==============================================================================
--- trunk/docs/manual/graphic-forms.css (original)
+++ trunk/docs/manual/graphic-forms.css Tue Oct 17 19:54:50 2006
@@ -1,4 +1,4 @@
-h2.title {
+div.title, h2.title {
font-size: 16;
font-family: { Arial, Helvetica, sans-serif; }
font-weight: Bold;
@@ -17,6 +17,11 @@
font-weight: Bold;
}
+div.chapter, div.glossary, div.section {
+ border-bottom-style: groove;
+ margin-bottom: 12px;
+}
+
div.footer {
font-size: 9;
font-family: { Arial, Helvetica, sans-serif; }
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Tue Oct 17 19:54:50 2006
@@ -8,6 +8,8 @@
[
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
+ <!ENTITY api SYSTEM "api.xml">
+ <!ENTITY systempkg SYSTEM "system-package.xml">
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
@@ -18,12 +20,13 @@
<subtitle>Programming Reference (version 0.6)</subtitle>
<bridgehead renderas="sect2">
- A user interface toolkit for the Windows platform.
+ A Common Lisp user interface toolkit for the Windows platform.
</bridgehead>
&legal;
&introduction;
+ &api;
&misctopics;
&glossary;
Modified: trunk/docs/manual/graphic-forms.xsl
==============================================================================
--- trunk/docs/manual/graphic-forms.xsl (original)
+++ trunk/docs/manual/graphic-forms.xsl Tue Oct 17 19:54:50 2006
@@ -20,8 +20,8 @@
<xsl:param name="htmlhelp.chm" select="'graphic-forms.chm'"/>
<xsl:param name="htmlhelp.hhc.folders.instead.books" select="0"/>
<xsl:param name="htmlhelp.show.advanced.search" select="1"/>
- <xsl:template name="user.footer.navigation">
- <hr/>
+ <xsl:param name="suppress.navigation" select="1"/>
+ <xsl:template name="user.footer.content">
<div class="footer">
Copyright © 2006, Jack D. Unrue
</div>
Added: trunk/docs/manual/system-package.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/system-package.xml Tue Oct 17 19:54:50 2006
@@ -0,0 +1,41 @@
+<!--
+ system-pkg.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+<chapter>
+ <title>graphic-forms.uitoolkit.system</title>
+
+ <para role="normal">[package]</para>
+
+ <bridgehead renderas="sect2">nickname</bridgehead>
+ <para role="normal">GFS</para>
+
+ <bridgehead renderas="sect2">description</bridgehead>
+ <para role="normal">
+ The symbols in this package correspond to system-level functionality,
+ such as foreign function declarations for the Win32 API. The majority
+ of symbols in this package are not exported, except for the
+ fundamental types, conditions, and functions listed below.
+ </para>
+
+ <bridgehead renderas="sect2">classes and structures</bridgehead>
+ <para role="normal">
+ native-object, point, rectangle, size, span
+ </para>
+
+ <bridgehead renderas="sect2">accessors, functions, and macros</bridgehead>
+ <para role="normal">
+ code, copy-point, copy-rectangle, copy-size, copy-span, detail, dispose,
+ disposed-p, dlg-code, empty-span-p, equal-size-p, handle, location,
+ make-point, make-rectangle, make-size, make-span, point-x, point-y,
+ size, size-height, size-width, span-end, span-start
+ </para>
+
+ <bridgehead renderas="sect2">conditions</bridgehead>
+ <para role="normal">
+ comdlg-error, disposed-error, toolkit-error, toolkit-warning, win32-error,
+ win32-warning
+ </para>
+
+</chapter>
1
0
Author: junrue
Date: Tue Oct 17 02:22:41 2006
New Revision: 338
Added:
trunk/docs/manual/glossary.xml
Modified:
trunk/docs/manual/graphic-forms.css
trunk/docs/manual/graphic-forms.xml
trunk/docs/manual/image-data-plugins.xml
Log:
restored glossary
Added: trunk/docs/manual/glossary.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/glossary.xml Tue Oct 17 02:22:41 2006
@@ -0,0 +1,210 @@
+<!--
+ glossary.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+<glossary><title>Glossary</title>
+
+<glossdiv><title>A</title>
+
+ <glossentry id="accelerator"><glossterm>accelerator</glossterm>
+ <glossdef>
+ <para>
+ An accelerator is a key sequence assigned to an application
+ function allowing a user to bypass navigation of the menu or control
+ hierarchy normally required to invoke the function. Some accelerators
+ are established by Windows style guidelines, such as control-c for
+ the clipboard copy operation from an Edit menu. Applications may define
+ other accelerators as appropriate. Accelerators are generally intended
+ for more knowledgeable users and should not be the sole mechanism for
+ invoking functionality.
+ </para>
+ <glossseealso otherterm="mnemonic"/>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="auto-scrolling"><glossterm>auto-scrolling</glossterm>
+ <glossdef>
+ <para>
+ Auto-scrolling is a feature whereby scrolling occurs as a side
+ effect of user input so content can remain visible, thus avoiding
+ the need to explicitly manipulate scrollbars to achieve the same result.
+ </para>
+ </glossdef>
+ </glossentry>
+
+</glossdiv>
+
+<glossdiv><title>B</title>
+</glossdiv>
+
+<glossdiv><title>C</title>
+
+ <glossentry id="control"><glossterm>control</glossterm>
+ <glossdef>
+ <para>
+ A control is a system-defined window class whose role is to accept
+ user input and possibly generate notification events based on such
+ input.
+ </para>
+ </glossdef>
+ </glossentry>
+
+</glossdiv>
+
+<glossdiv><title>D</title>
+
+ <glossentry id="default action"><glossterm>default action</glossterm>
+ <glossdef>
+ <para>
+ Conceptually, a default action is a secondary event initiated by
+ user input that is a logical follow-up to a previous event. Examples
+ of such user gestures include double-clicking an item in a list box
+ control, or pressing enter when an edit control has the keyboard focus.
+ The response to a default action makes use of context established by
+ the preceding event (e.g., the selection set by an initial click
+ becomes the context for the double-click response).
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="dialog"><glossterm>dialog</glossterm>
+ <glossdef>
+ <para>
+ A dialog is a mechanism for collecting user input or showing
+ information. The system defines common dialogs for tasks like
+ choosing files, fonts, or colors. Custom dialogs can be defined
+ by application code.
+ </para>
+ </glossdef>
+ </glossentry>
+
+</glossdiv>
+
+<glossdiv><title>E</title>
+
+ <glossentry id="extension"><glossterm>extension</glossterm>
+ <glossdef>
+ <para>
+ An extension is code providing additional functionality beyond the
+ original scope of a system. An extension framework encourages
+ modularity. More importantly, it is a conscious design choice to
+ allow a system to be stretched beyond what the original designers may
+ have anticipated.
+ </para>
+ <glossseealso otherterm="plugin"/>
+ </glossdef>
+ </glossentry>
+
+</glossdiv>
+
+<glossdiv><title>F</title>
+</glossdiv>
+
+<glossdiv><title>G</title>
+</glossdiv>
+
+<glossdiv><title>H</title>
+</glossdiv>
+
+<glossdiv><title>I</title>
+</glossdiv>
+
+<glossdiv><title>J</title>
+</glossdiv>
+
+<glossdiv><title>K</title>
+</glossdiv>
+
+<glossdiv><title>L</title>
+</glossdiv>
+
+<glossdiv><title>M</title>
+
+ <glossentry id="menu"><glossterm>menu</glossterm>
+ <glossdef>
+ <para>
+ A collection of menu items presented within a single rectangular
+ region. Menus are often anchored to a menu bar, but may also be
+ invoked in a context-sensitive manner via the mouse or an
+ <glossseealso otherterm="accelerator"/>.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="mix-in class"><glossterm>mix-in class</glossterm>
+ <glossdef>
+ <para>
+ A mix-in class represents a specific abstraction that complements
+ the role(s) of other class(es) in a class hierarchy.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id="mnemonic"><glossterm>mnemonic</glossterm>
+ <glossdef>
+ <para>
+ A mnemonic is a key sequence (usually a single character modified
+ by the <Alt> key) enabling mouse-free navigation of a menu or
+ control hierarchy to invoke an application function. Depending on
+ the user's system settings, mnemonic characters may be hidden until
+ the user presses the <Alt> key.
+ </para>
+ <glossseealso otherterm="accelerator"/>
+ </glossdef>
+ </glossentry>
+</glossdiv>
+
+<glossdiv><title>N</title>
+</glossdiv>
+
+<glossdiv><title>O</title>
+</glossdiv>
+
+<glossdiv><title>P</title>
+
+ <glossentry id="plugin"><glossterm>plugin</glossterm>
+ <glossdef>
+ <para>
+ A plugin is a unit of code integrated into a larger system in order
+ to implement a specific instance of an established category of
+ services. A plugin framework encourages modularity within a
+ defined scope of functionality.
+ </para>
+ <glossseealso otherterm="extension"/>
+ </glossdef>
+ </glossentry>
+
+</glossdiv>
+
+<glossdiv><title>Q</title>
+</glossdiv>
+
+<glossdiv><title>R</title>
+</glossdiv>
+
+<glossdiv><title>S</title>
+</glossdiv>
+
+<glossdiv><title>T</title>
+</glossdiv>
+
+<glossdiv><title>U</title>
+</glossdiv>
+
+<glossdiv><title>V</title>
+</glossdiv>
+
+<glossdiv><title>W</title>
+</glossdiv>
+
+<glossdiv><title>X</title>
+</glossdiv>
+
+<glossdiv><title>Y</title>
+</glossdiv>
+
+<glossdiv><title>Z</title>
+</glossdiv>
+
+</glossary>
Modified: trunk/docs/manual/graphic-forms.css
==============================================================================
--- trunk/docs/manual/graphic-forms.css (original)
+++ trunk/docs/manual/graphic-forms.css Tue Oct 17 02:22:41 2006
@@ -27,7 +27,7 @@
font-family: { Arial, Helvetica, sans-serif; }
}
-a, p.normal, span.productname {
+a, dd, dt, p.normal, span.productname {
font-size: 12;
font-family: { Arial, Helvetica, sans-serif; }
}
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Tue Oct 17 02:22:41 2006
@@ -10,6 +10,7 @@
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY misctopics SYSTEM "miscellaneous-topics.xml">
<!ENTITY imdataplugins SYSTEM "image-data-plugins.xml">
+ <!ENTITY glossary SYSTEM "glossary.xml">
]>
<book>
@@ -24,6 +25,7 @@
&legal;
&introduction;
&misctopics;
+ &glossary;
<index id="index"/>
</book>
Modified: trunk/docs/manual/image-data-plugins.xml
==============================================================================
--- trunk/docs/manual/image-data-plugins.xml (original)
+++ trunk/docs/manual/image-data-plugins.xml Tue Oct 17 02:22:41 2006
@@ -16,7 +16,7 @@
<para role="small">
Nowadays, the Windows platform offers alternatives, such as GDI+
which adds among other features native support for additional image
- formats. Graphic-Forms sticks with plain-old gdi to avoid the
+ formats. Graphic-Forms sticks with plain-old GDI to avoid the
possibility of these alternatives not being installed.
</para>
</footnote>
1
0