Author: junrue Date: Wed Oct 18 18:04:55 2006 New Revision: 348 Modified: trunk/docs/manual/clhs-table.xml trunk/docs/manual/gf-data.xsl trunk/docs/manual/gfs-symbols.xml Log: Modified: trunk/docs/manual/clhs-table.xml ============================================================================== --- trunk/docs/manual/clhs-table.xml (original) +++ trunk/docs/manual/clhs-table.xml Wed Oct 18 18:04:55 2006 @@ -6,7 +6,9 @@ --> <clhs-table> + <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/> <entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/> + <entry name="integer" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_intege.htm"/> <entry name="list" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_list.htm"/> <entry name="string" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_string.htm"/> <entry name="warning" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_warnin.htm"/> Modified: trunk/docs/manual/gf-data.xsl ============================================================================== --- trunk/docs/manual/gf-data.xsl (original) +++ trunk/docs/manual/gf-data.xsl Wed Oct 18 18:04:55 2006 @@ -125,7 +125,7 @@ <xsl:element name="para"> <xsl:attribute name="role">normal</xsl:attribute> - (<xsl:call-template name="create-id"/> + (<xsl:value-of select="concat(../../@name,':',../@name)"/> <xsl:element name="emphasis"> <xsl:for-each select="arguments/argument"> <xsl:value-of select="concat(' ', @name)"/> @@ -135,6 +135,8 @@ <xsl:apply-templates select="return"/> </xsl:element> </xsl:element> + + <xsl:apply-templates select="arguments"/> </xsl:template> <xsl:template match="argument"> @@ -284,6 +286,14 @@ </xsl:element> </xsl:template> + <xsl:template match="function/description"> + <xsl:call-template name="emit-symbol-description"/> + </xsl:template> + + <xsl:template match="generic-function/description"> + <xsl:call-template name="emit-symbol-description"/> + </xsl:template> + <xsl:template match="slot-reader/description"> <xsl:call-template name="emit-symbol-description"/> </xsl:template> @@ -347,6 +357,18 @@ </xsl:call-template> </xsl:template> + <xsl:template match="function"> + <xsl:call-template name="emit-function-section"> + <xsl:with-param name="page-type">Function</xsl:with-param> + </xsl:call-template> + </xsl:template> + + <xsl:template match="generic-function"> + <xsl:call-template name="emit-function-section"> + <xsl:with-param name="page-type">Generic Function</xsl:with-param> + </xsl:call-template> + </xsl:template> + <xsl:template match="slot-accessor"> <xsl:call-template name="emit-function-section"> <xsl:with-param name="page-type">Slot Accessor</xsl:with-param> Modified: trunk/docs/manual/gfs-symbols.xml ============================================================================== --- trunk/docs/manual/gfs-symbols.xml (original) +++ trunk/docs/manual/gfs-symbols.xml Wed Oct 18 18:04:55 2006 @@ -9,6 +9,24 @@ <!-- CONDITIONS --> + <condition name="disposed-error"> + <description> + <hierarchy> + <inherits> + <refclhs>error</refclhs> + </inherits> + </hierarchy> + This error is raised to indicate an attempt to manipulate a + <reftopic>gfs:native-object</reftopic> whose handle has not yet + been instantiated or which has been cleaned up via <reftopic>gfs:dispose</reftopic>. + </description> + <seealso> + <reftopic>gfs:toolkit-error</reftopic> + <reftopic>gfs:win32-error</reftopic> + <reftopic>gfs:disposed-p</reftopic> + </seealso> + </condition> + <condition name="toolkit-error"> <description> <hierarchy> @@ -155,6 +173,7 @@ </initargs> <seealso> <reftopic>gfs:code</reftopic> + <reftopic>gfs:dlg-code</reftopic> <reftopic>gfs:detail</reftopic> <reftopic>gfs:toolkit-warning</reftopic> <reftopic>gfs:win32-warning</reftopic> @@ -310,49 +329,53 @@ <!-- FUNCTIONS --> - <slot-reader name="code"> + <function name="copy-point"> <syntax> <arguments> - <argument name="condition"> + <argument name="point"> <description> - The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic> - object to be queried. + The <reftopic>gfs:point</reftopic> structure to be copied. </description> </argument> </arguments> <return> - <refclhs>integer</refclhs> + <reftopic label="new point">gfs:point</reftopic> </return> </syntax> <description> - Returns the Win32 error code for <refargument>condition</refargument> - as determined by <refwin32api>GetLastError</refwin32api>. + Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates + were copied from the original. </description> - </slot-reader> + <seealso> + <reftopic>gfs:make-point</reftopic> + </seealso> + </function> - <slot-reader name="copy-point"> + <function name="location"> <syntax> <arguments> - <argument name="point"> + <argument name="rectangle"> <description> - The <reftopic>gfs:point</reftopic> structure to be copied. + The <reftopic>gfs:rectangle</reftopic> to be queried. </description> </argument> </arguments> <return> - <reftopic label="new point">gfs:point</reftopic> + <reftopic>gfs:point</reftopic> </return> </syntax> <description> - Returns a new <reftopic>gfs:point</reftopic> whose X and Y coordinates - were copied from the original. + Returns (sets) the <reftopic>gfs:point</reftopic> identifying the coordinates + of the upper-left corner of <refargument>rectangle</refargument>. For + performance reasons, the existing slot value is returned directly rather + than being copied. </description> <seealso> - <reftopic>gfs:make-point</reftopic> + <reftopic>gfs:make-rectangle</reftopic> </seealso> - </slot-reader> + </function> - <slot-reader name="copy-rectangle"> + <function name="copy-rectangle"> <syntax> <arguments> <argument name="rectangle"> @@ -372,6 +395,257 @@ <seealso> <reftopic>gfs:make-rectangle</reftopic> </seealso> + </function> + + <function name="copy-size"> + <syntax> + <arguments> + <argument name="size"> + <description> + The <reftopic>gfs:size</reftopic> structure to be copied. + </description> + </argument> + </arguments> + <return> + <reftopic label="new size">gfs:size</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfs:size</reftopic> whose width and + height values were copied from the original. + </description> + <seealso> + <reftopic>gfs:make-size</reftopic> + </seealso> + </function> + + <function name="copy-span"> + <syntax> + <arguments> + <argument name="span"> + <description> + The <reftopic>gfs:span</reftopic> structure to be copied. + </description> + </argument> + </arguments> + <return> + <reftopic label="new span">gfs:span</reftopic> + </return> + </syntax> + <description> + Returns a new <reftopic>gfs:span</reftopic> whose start and + end values were copied from the original. + </description> + <seealso> + <reftopic>gfs:make-span</reftopic> + </seealso> + </function> + + <function name="empty-span-p"> + <syntax> + <arguments> + <argument name="span"> + <description> + The <reftopic>gfs:span</reftopic> structure to be tested. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if the start and end of <refargument>span</refargument> + are the same value. + </description> + <seealso> + <reftopic>gfs:span-start</reftopic> + <reftopic>gfs:span-end</reftopic> + </seealso> + </function> + + <function name="equal-size-p"> + <syntax> + <arguments> + <argument name="size1"> + <description> + The first <reftopic>gfs:size</reftopic> structure to be tested. + </description> + </argument> + <argument name="size2"> + <description> + The second <reftopic>gfs:size</reftopic> structure to be tested. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + Returns T if <refargument>size1</refargument> and + <refargument>size2</refargument> have the same height and + width values. + </description> + <seealso> + <reftopic>gfs:copy-size</reftopic> + <reftopic>gfs:size-height</reftopic> + <reftopic>gfs:size-width</reftopic> + </seealso> + </function> + + <!-- GENERIC FUNCTIONS --> + + <generic-function name="disposed-p"> + <syntax> + <arguments> + <argument name="native-object"> + <description> + The <reftopic>gfs:native-object</reftopic> whose status is to be + queried. + </description> + </argument> + </arguments> + <return> + <refclhs>boolean</refclhs> + </return> + </syntax> + <description> + <para role="normal"> + Returns T if <refargument>native-object</refargument> has not yet been + initialized or has been discarded via <reftopic>gfs:dispose</reftopic>; + NIL otherwise. + </para> + + <para role="normal"> + Note: this function does not interact with the Common Lisp garbage + collector. + </para> + </description> + <seealso> + <reftopic>gfs:disposed-error</reftopic> + </seealso> + </generic-function> + + <generic-function name="dispose"> + <syntax> + <arguments> + <argument name="native-object"> + <description> + The <reftopic>gfs:native-object</reftopic> object to be disposed. + </description> + </argument> + </arguments> + <return> + undefined + </return> + </syntax> + <description> + <para role="normal"> + Discards the system resource encapsulated by <reftopic>gfs:native-object</reftopic> + and cleans up various data structures internal to Graphic-Forms. For certain + objects, this method has visual side effects (for example, disposing + a window will remove that window from the display). A + <reftopic>gfs:disposed-error</reftopic> + will be raised if application code attempts to manipulate the object + after this function returns. + </para> + + <para role="normal"> + Note: this function does not interact with the garbage collector; + however, disposed objects will be collected once they are no longer + reachable. + </para> + </description> + <seealso> + <reftopic>gfs:disposed-p</reftopic> + <reftopic>gfw:event-disposed</reftopic> + </seealso> + </generic-function> + + <!-- ACCESSORS --> + + <slot-reader name="handle"> + <syntax> + <arguments> + <argument name="native-object"> + <description> + The <reftopic>gfs:native-object</reftopic> object to be queried. + </description> + </argument> + </arguments> + <return> + foreign pointer + </return> + </syntax> + <description> + Returns the Win32 HANDLE or foreign pointer associated with + <refargument>native-object</refargument>. + </description> + <seealso> + <reftopic>gfs:dispose</reftopic> + <reftopic>gfs:disposed-p</reftopic> + <reftopic>gfs:disposed-error</reftopic> + </seealso> + </slot-reader> + + <slot-reader name="dlg-code"> + <syntax> + <arguments> + <argument name="condition"> + <description> + The <reftopic>gfs:comdlg-error</reftopic> object to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns the Win32 error code for <refargument>condition</refargument> + as determined by the Common Dialog API function + <refwin32api>CommDlgExtendedError</refwin32api>. + </description> + </slot-reader> + + <slot-reader name="code"> + <syntax> + <arguments> + <argument name="condition"> + <description> + The <reftopic>gfs:win32-error</reftopic> or <reftopic>gfs:win32-warning</reftopic> + object to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>integer</refclhs> + </return> + </syntax> + <description> + Returns the Win32 error code for <refargument>condition</refargument> + as determined by <refwin32api>GetLastError</refwin32api>. + </description> + </slot-reader> + + <slot-reader name="detail"> + <syntax> + <arguments> + <argument name="condition"> + <description> + The <reftopic>gfs:toolkit-error</reftopic> or + <reftopic>gfs:toolkit-warning</reftopic> object to be queried. + </description> + </argument> + </arguments> + <return> + <refclhs>string</refclhs> + </return> + </syntax> + <description> + Returns the detail <refclhs>string</refclhs> for <refargument>condition</refargument>. + </description> </slot-reader> </package>