October 2006 - graphic-forms-cvs@common-lisp.net

[graphic-forms-cvs] r357 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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 @@  + <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-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

[graphic-forms-cvs] r356 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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="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

[graphic-forms-cvs] r355 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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"?>  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-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> +  +  + + <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

[graphic-forms-cvs] r354 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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"?> + +<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> +  <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

[graphic-forms-cvs] r353 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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 @@  + <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> +  + <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> +   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"?>  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

[graphic-forms-cvs] r352 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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"?> + + +<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> + +  + +  + +  + +  + +  + +  + +</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"?>  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"?> + + +<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> + +  + +  + +  + +  + +  + +  + +</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">  <!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml">  + <!ENTITY gfwpkg SYSTEM "gfw-tmp-pkg.xml">  <!ENTITY misctopics SYSTEM "miscellaneous-topics.xml"> <!ENTITY imdataplugins SYSTEM "image-data-plugins.xml"> <!ENTITY glossary SYSTEM "glossary.xml">

1 0

[graphic-forms-cvs] r351 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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 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

[graphic-forms-cvs] r350 - trunk/docs/manual
by junrue＠common-lisp.net 19 Oct '06

19 Oct '06

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="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 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 @@ + + +<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>  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">  + <!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml">  <!ENTITY misctopics SYSTEM "miscellaneous-topics.xml"> <!ENTITY imdataplugins SYSTEM "image-data-plugins.xml"> <!ENTITY glossary SYSTEM "glossary.xml">

1 0

[graphic-forms-cvs] r349 - trunk/docs/manual
by junrue＠common-lisp.net 18 Oct '06

18 Oct '06

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 @@  + <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 @@  + <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

[graphic-forms-cvs] r348 - trunk/docs/manual
by junrue＠common-lisp.net 18 Oct '06

18 Oct '06

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 @@  + <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 @@  - <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-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> + +  + + <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