[graphic-forms-cvs] r377 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Sat Oct 21 22:38:31 UTC 2006
Author: junrue
Date: Sat Oct 21 18:38:30 2006
New Revision: 377
Modified:
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gf-package.xsl
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Sat Oct 21 18:38:30 2006
@@ -36,7 +36,7 @@
</xsl:element>
</xsl:template>
- <xsl:template match="para | emphasis | itemizedlist | listitem | ulink">
+ <xsl:template match="para | emphasis | itemizedlist | listitem | ulink | code | programlisting">
<xsl:copy>
<xsl:copy-of select="@*"/>
<xsl:apply-templates/>
Modified: trunk/docs/manual/gf-package.xsl
==============================================================================
--- trunk/docs/manual/gf-package.xsl (original)
+++ trunk/docs/manual/gf-package.xsl Sat Oct 21 18:38:30 2006
@@ -49,41 +49,75 @@
</xsl:element>
</xsl:for-each>
- <bridgehead renderas="sect2">classes and structures</bridgehead>
- <para role="normal">
- <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"><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>
- </xsl:for-each>
- </para>
-
- <bridgehead renderas="sect2">accessors, functions, and macros</bridgehead>
- <para role="normal">
- <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"><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>
- </xsl:for-each>
- </para>
-
- <bridgehead renderas="sect2">conditions</bridgehead>
- <para role="normal">
- <xsl:for-each select="/package/condition">
- <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
- <xsl:element name="link">
- <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>
- </xsl:for-each>
- </para>
+ <xsl:if test="/package/class | /package/structure">
+ <bridgehead renderas="sect2">classes and structures</bridgehead>
+ <para role="normal">
+ <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"><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>
+ </xsl:for-each>
+ </para>
+ </xsl:if>
+
+ <xsl:if test="/package/generic-function">
+ <bridgehead renderas="sect2">generic functions</bridgehead>
+ <para role="normal">
+ <xsl:for-each select="/package/generic-function">
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ <xsl:element name="link">
+ <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>
+ </xsl:for-each>
+ </para>
+ </xsl:if>
+
+ <xsl:if test="/package/function | /package/slot-accessor | /package/slot-reader">
+ <bridgehead renderas="sect2">accessors and simple functions</bridgehead>
+ <para role="normal">
+ <xsl:for-each select="/package/function | /package/slot-accessor | /package/slot-reader">
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ <xsl:element name="link">
+ <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>
+ </xsl:for-each>
+ </para>
+ </xsl:if>
+
+ <xsl:if test="/package/macro">
+ <bridgehead renderas="sect2">macros</bridgehead>
+ <para role="normal">
+ <xsl:for-each select="/package/macro">
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ <xsl:element name="link">
+ <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>
+ </xsl:for-each>
+ </para>
+ </xsl:if>
+
+ <xsl:if test="/package/condition">
+ <bridgehead renderas="sect2">conditions</bridgehead>
+ <para role="normal">
+ <xsl:for-each select="/package/condition">
+ <xsl:sort select="@name" order="ascending" case-order="upper-first"/>
+ <xsl:element name="link">
+ <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>
+ </xsl:for-each>
+ </para>
+ </xsl:if>
<xsl:for-each select="document($symbol-file)/data/section">
<xsl:copy-of select="current()"/>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Sat Oct 21 18:38:30 2006
@@ -265,6 +265,10 @@
<seealso>
<reftopic>gfs:dispose</reftopic>
<reftopic>gfw:menu-item</reftopic>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:append-separator</reftopic>
+ <reftopic>gfw:append-submenu</reftopic>
+ <reftopic>gfw:defmenu</reftopic>
</seealso>
</class>
@@ -2389,6 +2393,198 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="auto-hscroll-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with scrolling functionality.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is configured for automatic horizontal scrolling;
+ NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable-auto-scrolling</reftopic>
+ <reftopic>gfw:auto-vscroll-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="auto-vscroll-p">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An object with scrolling functionality.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is configured for automatic vertical scrolling;
+ NIL otherwise.
+ </description>
+ <seealso>
+ <reftopic>gfw:enable-auto-scrolling</reftopic>
+ <reftopic>gfw:auto-hscroll-p</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="append-item">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ <argument name="thing">
+ <description>
+ Any application-defined object.
+ </description>
+ </argument>
+ <argument name="dispatcher">
+ <description>
+ Either an instance of <reftopic>gfw:event-dispatcher</reftopic> (or
+ a subclass thereof), or a function whose argument list matches the
+ event method identified by the <emphasis>callback-event-name</emphasis>
+ class-allocated slot of <arg0/>.
+ </description>
+ </argument>
+ <notarg name="&optional"/>
+ <argument name="disabled">
+ <description>
+ A <refclhs>boolean</refclhs> indicating whether the item should be
+ initially disabled.
+ </description>
+ </argument>
+ <argument name="checked">
+ <description>
+ A <refclhs>boolean</refclhs> indicating whether the item should be
+ initially checked.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:item</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Adds a new item wrapping <arg1/> to <arg0/>. The newly-created
+ item is returned. Note that not all <reftopic>gfw:item-manager</reftopic>
+ subclasses support enabled or checked states for individual items.
+ </description>
+ <seealso>
+ <reftopic>gfw:menu</reftopic>
+ <reftopic>gfw:list-box</reftopic>
+ <reftopic>gfw:append-separator</reftopic>
+ <reftopic>gfw:append-submenu</reftopic>
+ <reftopic>gfw:defmenu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="append-separator">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ An instance of a subclass of <reftopic>gfw:item-manager</reftopic>.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:item</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Adds a separator to <arg0/>, and returns a newly-created item to wrap
+ the separator. A separator is a thin etched divider that serves to visually
+ separate groups of items; it generates no events.
+ </description>
+ <seealso>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:append-submenu</reftopic>
+ <reftopic>gfw:menu</reftopic>
+ <reftopic>gfw:defmenu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="append-submenu">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ A <reftopic>gfw:menu</reftopic> to which append a submenu.
+ </description>
+ </argument>
+ <argument name="text">
+ <description>
+ A <refclhs>string</refclhs> providing the text for the submenu's
+ anchor.
+ </description>
+ </argument>
+ <argument name="submenu">
+ <description>
+ A <reftopic>gfw:menu</reftopic> comprising a submenu to be
+ attached to <arg0/>.
+ </description>
+ </argument>
+ <argument name="dispatcher">
+ <description>
+ Either an instance of <reftopic>gfw:event-dispatcher</reftopic> (or
+ a subclass thereof), or a function whose argument list matches the
+ event method identified by the <emphasis>callback-event-name</emphasis>
+ class-allocated slot of <arg0/>.
+ </description>
+ </argument>
+ <notarg name="&optional"/>
+ <argument name="disabled">
+ <description>
+ A <refclhs>boolean</refclhs> indicating whether the submenu's
+ anchor should be initially disabled.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <reftopic>gfw:menu-item</reftopic>
+ </return>
+ </syntax>
+ <description>
+ Adds <arg2/> anchored to <arg0/> and returns the corresponding
+ <reftopic>gfw:menu-item</reftopic>.
+ </description>
+ <seealso>
+ <reftopic>gfw:append-item</reftopic>
+ <reftopic>gfw:append-submenu</reftopic>
+ <reftopic>gfw:menu</reftopic>
+ <reftopic>gfw:defmenu</reftopic>
+ </seealso>
+ </generic-function>
+
+ <generic-function name="ancestor-p">
+ <syntax>
+ <arguments>
+ <argument name="ancestor"/>
+ <argument name="descendant"/>
+ </arguments>
+ <return>
+ <refclhs>boolean</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns T if <arg0/> is the parent of <arg1/>; NIL otherwise.
+ </description>
+ </generic-function>
+
<generic-function name="event-activate">
<syntax>
<arguments>
@@ -3688,4 +3884,37 @@
</description>
</macro>
+ <macro name="defmenu">
+ <syntax>
+ <arguments>
+ <notarg name="("/>
+ <argument name="forms">
+ <description>
+ Menu definition forms.
+ </description>
+ </argument>
+ <notarg name=")"/>
+ </arguments>
+ <return>
+ <reftopic>gfw:menu</reftopic>
+ </return>
+ </syntax>
+ <description>
+ This macro defines a language for constructing menu hierarchies. For example:
+ <programlisting language="lisp">
+(gfw:defmenu
+ ((:item "&File" :submenu ((:item "&Open...")
+ (:item "&Save..." :disabled)
+ (:item :separator)
+ (:item "E&xit" :callback #'some-fn)))
+ (:item "&Tools" :submenu ((:item "&Fonts" :disabled)
+ (:item "&Colors" :checked)))
+ (:item "&Help" :submenu ((:item "&About" :image some-image)))))
+ </programlisting>
+ </description>
+ <seealso>
+ <reftopic>gfw:menu-bar</reftopic>
+ </seealso>
+ </macro>
+
</package>
More information about the Graphic-forms-cvs
mailing list