[graphic-forms-cvs] r369 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Fri Oct 20 21:07:44 UTC 2006
Author: junrue
Date: Fri Oct 20 17:07:44 2006
New Revision: 369
Modified:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gf-data.xsl
trunk/docs/manual/gfw-symbols.xml
Log:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Fri Oct 20 17:07:44 2006
@@ -11,6 +11,7 @@
<entry name="character" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ch.htm"/>
<entry name="error" url="http://www.lispworks.com/documentation/HyperSpec/Body/e_error.htm"/>
<entry name="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.htm"/>
+ <entry name="format" url="http://www.lispworks.com/documentation/HyperSpec/Body/f_format.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"/>
Modified: trunk/docs/manual/gf-data.xsl
==============================================================================
--- trunk/docs/manual/gf-data.xsl (original)
+++ trunk/docs/manual/gf-data.xsl Fri Oct 20 17:07:44 2006
@@ -323,11 +323,13 @@
</xsl:element>
<xsl:element name="entry">
<xsl:attribute name="valign">top</xsl:attribute>
- <xsl:for-each select="*">
- <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
- <xsl:apply-templates select="."/>
- <xsl:if test="not(position()=last())">, </xsl:if>
- </xsl:for-each>
+ <para role="normal">
+ <xsl:for-each select="*">
+ <xsl:sort select="substring-after(.,':')" order="ascending" case-order="upper-first"/>
+ <xsl:apply-templates select="."/>
+ <xsl:if test="not(position()=last())">, </xsl:if>
+ </xsl:for-each>
+ </para>
</xsl:element>
</xsl:element>
</xsl:template>
Modified: trunk/docs/manual/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 17:07:44 2006
@@ -17,6 +17,119 @@
<!-- CLASSES -->
+ <class name="flow-layout">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:layout-manager</reftopic>
+ </inherits>
+ </hierarchy>
+ This layout manager arranges child widgets in a row or column.
+ </description>
+ <initargs>
+ <argument name=":spacing">
+ <description>
+ An <refclhs>integer</refclhs> value specifying the number of pixels
+ between succeeding child widgets.
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ A <refclhs>list</refclhs> containing keyword symbols, as follows.
+ One of the following primary styles:
+ <enum>
+ <argument name=":horizontal">
+ <description>Horizontal orientation is the default.</description>
+ </argument>
+ <argument name=":vertical">
+ <description>Vertical orientation.</description>
+ </argument>
+ </enum>
+ Zero or more of the following optional styles:
+ <enum>
+ <argument name=":normalize">
+ <description>
+ Children will be sized equally in the dimension opposite to
+ the layout orientation, using the maximum of the preferred sizes.
+ </description>
+ </argument>
+ <argument name=":wrap">
+ <description>
+ Enables wrapping of the layout flow if the available horizontal
+ (or vertical) space within the container is less than the layout
+ requests for a full row (or column). The default layout mode is unwrapped.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfw:preferred-size</reftopic>
+ </seealso>
+ </class>
+
+ <class name="heap-layout">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:layout-manager</reftopic>
+ </inherits>
+ </hierarchy>
+ This layout manager creates a virtual heap of child widgets, where only
+ one child is visible at a time (known as the <emphasis>top child</emphasis>).
+ Application code can select a different child to be the
+ <emphasis>top child</emphasis> as needed, with a subsequent call to
+ <reftopic>gfw:layout</reftopic> updating the layout visually. If no
+ maximum or minimum size is set for
+ any children, all children are resized according to the maximum of their
+ preferred sizes.
+ </description>
+ <initargs>
+ <argument name=":top-child">
+ <description>
+ The child widget that should be initially visible.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfw:preferred-size</reftopic>
+ </seealso>
+ </class>
+
+ <class name="menu">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:widget</reftopic>
+ <reftopic>gfw:item-manager</reftopic>
+ </inherits>
+ </hierarchy>
+ This class represents a container for menu items and submenus.
+ </description>
+ <initargs>
+ <argument name=":callbacks">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":dispatcher">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:menu-item</reftopic>
+ </seealso>
+ </class>
+
<class name="display">
<description>
<hierarchy>
@@ -161,6 +274,199 @@
</seealso>
</class>
+ <class name="item">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:event-source</reftopic>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfw:list-item</reftopic>
+ <reftopic>gfw:menu-item</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This is the base class for non-windowed user interface objects serving
+ as elements of a <reftopic>gfw:item-manager</reftopic>. For example,
+ each entry in a <reftopic>gfw:list-box</reftopic> control is represented
+ by an item.
+ </description>
+ <initargs>
+ <argument name=":callback">
+ <description>
+ A callback function whose arguments are congruent with
+ <reftopic>gfw:event-select</reftopic>.
+ </description>
+ </argument>
+ <argument name=":data">
+ <description>
+ An application-supplied object to be represented by an item instance.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ <reftopic>gfw:owner</reftopic>
+ </seealso>
+ </class>
+
+ <class name="item-manager">
+ <description>
+ <hierarchy>
+ <inheritedby>
+ <reftopic>gfw:menu</reftopic>
+ <reftopic>gfw:list-box</reftopic>
+ </inheritedby>
+ </hierarchy>
+ This is a mix-in for widgets that contain and display sub-elements.
+ </description>
+ <initargs>
+ <argument name=":image-provider">
+ <description>
+ A function accepting one argument and returning an instance of
+ <reftopic>gfg:image</reftopic>. The function's argument will be
+ the application-supplied object for the <reftopic>gfw:item</reftopic>
+ being rendered. The default implementation returns NIL.
+ </description>
+ </argument>
+ <argument name=":sort-predicate">
+ <description>
+ A function accepting two arguments and returning a <refclhs>boolean</refclhs>.
+ This serves as a predicate for the purpose of ordering the members of the
+ item-manager. The arguments are two of the application-supplied objects.
+ Not all subclasses of item-manager make use of this feature.
+ </description>
+ </argument>
+ <argument name=":text-provider">
+ <description>
+ A function accepting one argument and returning a <refclhs>string</refclhs>.
+ The function's argument will be the application-supplied object for the
+ <reftopic>gfw:item</reftopic> being rendered. The default implementation
+ checks whether the argument is a <refclhs>string</refclhs>, and if so,
+ just returns it; otherwise, <refclhs>format</refclhs> is called.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
+ <class name="list-item">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:item</reftopic>
+ </inherits>
+ </hierarchy>
+ This class represents an element of a <reftopic>gfw:list-box</reftopic>.
+ </description>
+ <initargs>
+ <argument name=":callback">
+ <description>
+ See <reftopic>gfw:item</reftopic>.
+ </description>
+ </argument>
+ <argument name=":data">
+ <description>
+ See <reftopic>gfw:item</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
+ <class name="widget">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:event-source</reftopic>
+ </inherits>
+ <inheritedby>
+ <reftopic>gfw:control</reftopic>
+ <reftopic>gfw:color-dialog</reftopic>
+ <reftopic>gfw:file-dialog</reftopic>
+ <reftopic>gfw:menu</reftopic>
+ <reftopic>gfw:window</reftopic>
+ </inheritedby>
+ </hierarchy>
+ The widget class is the base class for all windowed user interface objects.
+ </description>
+ <initargs>
+ <argument name=":style">
+ <description>
+ A <refclhs>list</refclhs> of keyword symbols supplying additional
+ information about the desired look-and-feel or behavior of the widget;
+ style keywords are widget-specific.
+ </description>
+ </argument>
+ <argument name=":callbacks">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
+ <class name="timer">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:event-source</reftopic>
+ </inherits>
+ </hierarchy>
+ A timer is a non-windowed object that generates events at a regular
+ (adjustable) frequency. Applications handle timer events by implementing
+ methods for the <reftopic>gfw:event-timer</reftopic> generic function.
+ </description>
+ <initargs>
+ <argument name=":initial-delay">
+ <description>
+ A non-negative <refclhs>integer</refclhs> value specifying the number
+ of milliseconds until the first timer event is delivered.
+ </description>
+ </argument>
+ <argument name=":delay">
+ <description>
+ A non-negative <refclhs>integer</refclhs> value specifying the number
+ of milliseconds between successive timer events. If
+ <emphasis>:initial-delay</emphasis> is
+ not specified, then this value will be used as the initial delay as well.
+ Setting <emphasis>:delay</emphasis> to 0 and
+ <emphasis>:initial-delay</emphasis> to a positive value has the effect
+ of creating a <emphasis>one-shot</emphasis> timer.
+ </description>
+ </argument>
+ <argument name=":callbacks">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":dispatcher">
+ <description>
+ See <reftopic>gfw:event-source</reftopic>.
+ </description>
+ </argument>
+ <argument name=":handle">
+ <description>
+ See <reftopic>gfs:native-object</reftopic>.
+ </description>
+ </argument>
+ </initargs>
+ <seealso>
+ <reftopic>gfs:dispose</reftopic>
+ </seealso>
+ </class>
+
<!-- STRUCTURES -->
<!-- FUNCTIONS -->
More information about the Graphic-forms-cvs
mailing list