[graphic-forms-cvs] r353 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Thu Oct 19 04:13:21 UTC 2006
Author: junrue
Date: Thu Oct 19 00:13:19 2006
New Revision: 353
Modified:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gf-package.xsl
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/gfw-symbols.xml
trunk/docs/manual/win32-api-table.xml
Log:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Thu Oct 19 00:13:19 2006
@@ -6,10 +6,11 @@
-->
<clhs-table>
- <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
- <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
- <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
- <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
- <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
- <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
+ <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
+ <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
+ <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/>
+ <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/>
+ <entry name="pathname" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_pn.htm"/>
+ <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/>
+ <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/>
</clhs-table>
Modified: trunk/docs/manual/gf-package.xsl
==============================================================================
--- trunk/docs/manual/gf-package.xsl (original)
+++ trunk/docs/manual/gf-package.xsl Thu Oct 19 00:13:19 2006
@@ -57,7 +57,7 @@
<xsl:for-each select="/package/class | /package/structure">
<xsl:sort select="@name" order="ascending" case-order="upper-first"/>
<xsl:element name="link">
- <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute>
<xsl:value-of select="@name"/>
</xsl:element>
<xsl:if test="not(position()=last())">, </xsl:if>
@@ -69,7 +69,7 @@
<xsl:for-each select="/package/function | /package/generic-function | /package/slot-accessor | /package/slot-reader | /package/macro">
<xsl:sort select="@name" order="ascending" case-order="upper-first"/>
<xsl:element name="link">
- <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute>
<xsl:value-of select="@name"/>
</xsl:element>
<xsl:if test="not(position()=last())">, </xsl:if>
@@ -81,7 +81,7 @@
<xsl:for-each select="/package/condition">
<xsl:sort select="@name" order="ascending" case-order="upper-first"/>
<xsl:element name="link">
- <xsl:attribute name="linkend">gfs:<xsl:value-of select="@name"/></xsl:attribute>
+ <xsl:attribute name="linkend"><xsl:value-of select="../@name"/>:<xsl:value-of select="@name"/></xsl:attribute>
<xsl:value-of select="@name"/>
</xsl:element>
<xsl:if test="not(position()=last())">, </xsl:if>
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 00:13:19 2006
@@ -17,8 +17,209 @@
<!-- CLASSES -->
+ <class name="font">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ This class encapsulates a native font handle.
+ </description>
+ <initargs>
+ <argument name=":data">
+ <description>
+ A <reftopic>gfg:font-data</reftopic> object. If this initarg
+ is specified, then a value for the <refargument>:gc</refargument>
+ initarg is also required.
+ </description>
+ </argument>
+ <argument name=":gc">
+ <description>
+ A <reftopic>gfg:graphics-context</reftopic> object. If this
+ initarg is specified, then a value for the
+ <refargument>:data</refargument> initarg is also required.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfg:data-object</reftopic>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfg:font-metrics</reftopic>
+ <reftopic>gfg:text-extent</reftopic>
+ </seealso>
+ </class>
+
+ <class name="graphics-context">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ This class wraps a Win32 device context, thus instances of this class
+ are used to perform drawing operations. Application code usually obtains
+ a <reftopic>gfg:graphics-context</reftopic> via
+ <reftopic>gfw:event-paint</reftopic>, but initargs are also provided to
+ create a context associated with a <reftopic>gfg:image</reftopic> or a
+ <reftopic>gfw:widget</reftopic> outside the scope of a paint event.
+ </description>
+ <initargs>
+ <argument name=":image">
+ <description>
+ A <reftopic>gfg:image</reftopic> on which to draw or whose graphics
+ attributes are to be manipulated.
+ </description>
+ </argument>
+ <argument name=":widget">
+ <description>
+ A <reftopic>gfw:widget</reftopic> on which to draw or whose graphics
+ attributes are to be manipulated.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
+ <class name="icon-bundle">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfs:native-object</reftopic>
+ </inherits>
+ </hierarchy>
+ <para role="normal">
+ This class encapsulates a collection of Win32 icon handles. Icons are used to
+ decorate window title bars, to represent a file or application on the desktop,
+ to represent an application in the <Alt><Tab> task switching dialog,
+ and in the Windows Start menu. See the <refwin32api>Icons in Win32</refwin32api>
+ topic of the MSDN documentation for further discussion of standard icon sizes,
+ color depths, and file format.
+ </para>
+ <para role="normal">
+ This class supports multiple-sized versions of the same image. Library
+ components that consume icon-bundle instances can, in some cases, select a
+ size appropriate for the context in which the icon is needed. To retrieve
+ or set an individual <reftopic>gfg:image</reftopic>, call
+ <reftopic>gfg:icon-image-ref</reftopic>. To find out how many images
+ are stored, call <reftopic>gfg:icon-bundle-length</reftopic>.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":file">
+ <description>
+ A <refclhs>pathname</refclhs> identifying a file to be loaded, as described
+ for the initarg of the same name for <reftopic>gfg:image</reftopic>. Note
+ that the ICO format can store multiple images, all of which will be loaded.
+ Since icon-bundle needs a transparency mask for each image in order to create
+ Windows icons, a value may be supplied for the
+ <refargument>:transparency-pixel</refargument> initarg of this class;
+ otherwise, the pixel color at location (0, 0) in each image is used by
+ default.
+ </description>
+ </argument>
+ <argument name=":images">
+ <description>
+ A <refclhs>list</refclhs> of <reftopic>gfg:image</reftopic> objects. Since
+ icon-bundle needs a transparency mask for each image to create Windows icons,
+ the application may either SETF <reftopic>gfg:transparency-pixel</reftopic>
+ for each image ahead of time (especially important when the proper pixel
+ location is different from one image to the next), or provide a value for
+ the <refargument>:transparency-pixel</refargument> initarg of this class.
+ By default, the pixel color at location (0, 0) in each image will be used.
+ </description>
+ </argument>
+ <argument name=":system">
+ <description>
+ An icon identifier constant.
+ </description>
+ </argument>
+ <argument name=":transparency-pixel">
+ <description>
+ A <reftopic>gfs:point</reftopic> identifying a pixel location providing
+ the background color to be used when creating a transparency mask. This
+ location applies to all images except system icons.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ Image Data Plugins
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfg:icon-bundle-length</reftopic>
+ <reftopic>gfg:icon-image-ref</reftopic>
+ <reftopic>gfg:load</reftopic>
+ <reftopic>gfg:push-icon-image</reftopic>
+ </seealso>
+ </class>
+
<!-- STRUCTURES -->
+ <structure name="color">
+ <description>
+ This structure represents a color in the RGB color model. Each color
+ component value is specified in the range 0 - 255.
+ </description>
+ <seealso>
+ <reftopic>gfg:copy-color</reftopic>
+ <reftopic>gfg:make-color</reftopic>
+ <reftopic>gfg:color-red</reftopic>
+ <reftopic>gfg:color-green</reftopic>
+ <reftopic>gfg:color-blue</reftopic>
+ <reftopic>gfg:color->rgb</reftopic>
+ <reftopic>gfg:rgb->color</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="font-data">
+ <description>
+ This structure describes logical attributes of a
+ <reftopic>gfg:font</reftopic> that the system font mapper can use
+ to find a match. Thus, application code can use this structure to
+ request fonts.
+ </description>
+ <seealso>
+ <reftopic>gfg:copy-font-data</reftopic>
+ <reftopic>gfg:data-object</reftopic>
+ <reftopic>gfg:make-font-data</reftopic>
+ </seealso>
+ </structure>
+
+ <structure name="font-metrics">
+ <description>
+ This structure describes attributes of a <reftopic>gfg:font</reftopic>
+ which application code may use to position and align graphical elements.
+ </description>
+ <seealso>
+ <reftopic>gfg:ascent</reftopic>
+ <reftopic>gfg:average-char-width</reftopic>
+ <reftopic>gfg:copy-font-metrics</reftopic>
+ <reftopic>gfg:descent</reftopic>
+ <reftopic>gfg:font-data</reftopic>
+ <reftopic>gfg:height</reftopic>
+ <reftopic>gfg:leading</reftopic>
+ <reftopic>gfg:make-font-metrics</reftopic>
+ <reftopic>gfg:maximum-char-width</reftopic>
+ <reftopic>gfg:metrics</reftopic>
+ </seealso>
+ </structure>
+
<!-- FUNCTIONS -->
<!-- GENERIC FUNCTIONS -->
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Thu Oct 19 00:13:19 2006
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
- gfg-symbols.xml
+ gfw-symbols.xml
Copyright (c) 2006, Jack D. Unrue
-->
Modified: trunk/docs/manual/win32-api-table.xml
==============================================================================
--- trunk/docs/manual/win32-api-table.xml (original)
+++ trunk/docs/manual/win32-api-table.xml Thu Oct 19 00:13:19 2006
@@ -8,4 +8,5 @@
<win32-api-table>
<entry name="CommDlgExtendedError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/winui/winui/windowsuserinterface/userinput/commondialogboxlibrary/commondialogboxreference/commondialogboxfunctions/commdlgextendederror.asp"/>
<entry name="GetLastError" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/debug/base/getlasterror.asp"/>
+ <entry name="Icons in Win32" url="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwui/html/msdn_icons.asp"/>
</win32-api-table>
More information about the Graphic-forms-cvs
mailing list