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>