[graphic-forms-cvs] r371 - in trunk/docs: manual website
junrue at common-lisp.net
junrue at common-lisp.net
Sat Oct 21 00:34:07 UTC 2006
Author: junrue
Date: Fri Oct 20 20:34:05 2006
New Revision: 371
Modified:
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gfw-symbols.xml
trunk/docs/website/index.html
Log:
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Fri Oct 20 20:34:05 2006
@@ -6,15 +6,16 @@
-->
<clhs-table>
- <entry name="alist" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/>
- <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
- <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"/>
- <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="alist" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_a.htm#alist"/>
+ <entry name="boolean" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_ban.htm"/>
+ <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="namestring" url="http://www.lispworks.com/documentation/HyperSpec/Body/26_glo_n.htm#namestring"/>
+ <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/gfw-symbols.xml
==============================================================================
--- trunk/docs/manual/gfw-symbols.xml (original)
+++ trunk/docs/manual/gfw-symbols.xml Fri Oct 20 20:34:05 2006
@@ -647,6 +647,336 @@
</seealso>
</class>
+ <class name="color-dialog">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:widget</reftopic>
+ </inherits>
+ </hierarchy>
+ <para role="normal">
+ This class provides a standard dialog for choosing (or defining new) colors.
+ The <reftopic>gfw:with-color-dialog</reftopic> macro wraps the creation of
+ this dialog type and subsequent retrieval of the user's <reftopic>gfg:color</reftopic>
+ choice. However, applications may choose to implement these steps manually,
+ in which case the <reftopic>gfw:obtain-chosen-color</reftopic> function can be
+ used.
+ </para>
+ <para role="normal">
+ Like other system dialogs in Graphic-Forms, file-dialog is derived from
+ <reftopic>gfw:widget</reftopic> rather than <reftopic>gfw:dialog</reftopic>
+ since the majority of its functionality is implemented by the system. A
+ future release will provide a customization mechanism.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":initial-color">
+ <description>
+ This initarg causes the dialog to show the specified
+ <reftopic>gfg:color</reftopic> as initially selected.
+ </description>
+ </argument>
+ <argument name=":initial-custom-colors">
+ <description>
+ This initarg accepts a <refclhs>list</refclhs> of <reftopic>gfg:color</reftopic>
+ objects which are used to populate the custom color editing portion of the dialog.
+ A maximum of 16 colors are used, with any extras supplied in the
+ <refclhs>list</refclhs> being
+ ignored. Fewer than 16 may be supplied, in which case black is displayed as
+ a default color for the remaining entries.
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ A <refclhs>list</refclhs> of keyword symbols specifying how the color dialog
+ is to look and behave. One or more of the following:
+ <enum>
+ <argument name=":allow-custom-colors">
+ <description>
+ This configures the dialog to enable the
+ <emphasis>Define Custom Color</emphasis> button, which when
+ clicked reveals additional controls for creating custom colors.
+ </description>
+ </argument>
+ <argument name=":display-solid-only">
+ <description>
+ This configures the dialog to only display solid colors in
+ the set of basic colors.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name=":owner">
+ <description>
+ A value is required for this initarg, which may be either a
+ <reftopic>gfw:window</reftopic> or a <reftopic>gfw:dialog</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="file-dialog">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:widget</reftopic>
+ </inherits>
+ </hierarchy>
+ <para role="normal">
+ This class provides a standard dialog for navigating the file system
+ to select or enter file names. A variety of configurations are possible.
+ Please note that in :save mode, the user will be prompted to
+ confirm overwrite when an existing file is selected.
+ </para>
+ <para role="normal">
+ The <reftopic>gfw:with-file-dialog</reftopic> macro wraps the creation
+ of a file-dialog and subsequent retrieval of the file paths selected by
+ the user. However, applications may choose to implement these steps
+ manually, in which case the <reftopic>gfw:file-dialog-paths</reftopic>
+ function can be used to obtain the user's selection(s). Unless the
+ :multiple-select style keyword is specified, there will at most be one
+ selected file returned. In either case, zero is returned if the user
+ cancelled the dialog. Manual construction of an instance must be followed
+ by an explicit call to <reftopic>gfs:dispose</reftopic>.
+ </para>
+ <para role="normal">
+ Like other system dialogs in Graphic-Forms, file-dialog is derived from
+ <reftopic>gfw:widget</reftopic> rather than <reftopic>gfw:dialog</reftopic>
+ since the majority of its functionality is implemented by the system. A
+ future release will provide a customization mechanism.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":default-extension">
+ <description>
+ Specifies a default extension to be appended to a file name
+ if the user fails to provide one. Any embedded periods `.'
+ will be removed. Also, only the first three characters are used.
+ </description>
+ </argument>
+ <argument name=":filters">
+ <description>
+ This initarg accepts a list of conses, CAR holding a string that
+ describes a filter, e.g., `Text Files', and CDR specifying the actual
+ filter pattern, e.g., `*.TXT'. Note that multiple filter patterns can
+ be grouped with a single description by separating them with semicolons,
+ e.g., `*.TXT;*.BAK'.
+ </description>
+ </argument>
+ <argument name=":initial-directory">
+ <description>
+ This initarg accepts a directory <refclhs>namestring</refclhs> identifying
+ the location in the file system whose contents are to be browsed by the
+ file dialog. Note: setting this value will result in the side-effect of
+ changing the current working directory of the lisp process. Also, the
+ supplied value is used only if the <refclhs>namestring</refclhs> supplied
+ for :initial-filename does not contain a path.
+ </description>
+ </argument>
+ <argument name=":initial-filename">
+ <description>
+ This initarg accepts a file <refclhs>namestring</refclhs> for the following
+ purposes:
+ <itemizedlist mark="bullet" spacing="compact">
+ <listitem>
+ populate the edit field in the file dialog with the file name and extension
+ </listitem>
+ <listitem>
+ set the initial directory of the file dialog (and hence the current
+ working directory of the lisp process) if it contains a directory path
+ </listitem>
+ <listitem>
+ if a file actually exists in the directory, set the other components of
+ the dialog to reflect the attributes of the file.
+ </listitem>
+ </itemizedlist>
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ A <refclhs>list</refclhs> of keyword symbols specifying how the font dialog
+ is to look and behave. One or more of the following:
+ <enum>
+ <argument name=":add-to-recent">
+ <description>
+ This enables the system to add a link to the selected file in the
+ directory that contains the user's most recently used documents.
+ </description>
+ </argument>
+ <argument name=":multiple-select">
+ <description>
+ This configures the dialog to accept multiple selections.
+ </description>
+ </argument>
+ <argument name=":path-must-exist">
+ <description>
+ This keyword enables a validation check that constrains the user's
+ selection to file paths that actually exist. A warning dialog will
+ be displayed if the user supplies a non-existent path.
+ </description>
+ </argument>
+ <argument name=":show-hidden">
+ <description>
+ This keyword enables the dialog to display files marked hidden by
+ the system. Note: files marked both hidden and system will not be
+ displayed in any case. Also, be aware that using this keyword
+ effectively overrides the user's preference settings.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name=":text">
+ <description>
+ This initarg accepts a <clhs>string</clhs> that will become the title of
+ the file dialog. By default, a file dialog with the :open style flag will
+ display `Open' whereas the :save style flag will result in a title of
+ `Save As'.
+ </description>
+ </argument>
+ <argument name=":owner">
+ <description>
+ A value is required for this initarg, which may be either a
+ <reftopic>gfw:window</reftopic> or a <reftopic>gfw:dialog</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="font-dialog">
+ <description>
+ <hierarchy>
+ <inherits>
+ <reftopic>gfw:widget</reftopic>
+ </inherits>
+ </hierarchy>
+ <para role="normal">
+ This class provides a standard dialog for choosing attributes of a
+ font, either from scratch or relative to an existing font. A variety
+ of style options may be selected, including strikeout and font color.
+ </para>
+ <para role="normal">
+ The <reftopic>gfw:with-font-dialog</reftopic> macro wraps the creation
+ of a font-dialog and provides a new <reftopic>gfg:font</reftopic> object
+ based on the user's selections. However, applications may choose to implement
+ these steps manually, in which case the <reftopic>gfw:font-dialog-results</reftopic>
+ function can be called to obtain the results of the user's selections. Manual
+ construction of an instance must be followed by an explicit call to
+ <reftopic>gfs:dispose</reftopic>.
+ </para>
+ <para role="normal">
+ Like other system dialogs in Graphic-Forms, font-dialog is derived from
+ <reftopic>gfw:widget</reftopic> rather than <reftopic>gfw:dialog</reftopic>
+ since the majority of its functionality is implemented by the system. A
+ future release will provide a customization mechanism.
+ </para>
+ </description>
+ <initargs>
+ <argument name=":gc">
+ <description>
+ This required initarg accepts a <reftopic>gfg:graphics-context</reftopic>
+ object providing context for the font selection, such as when the set of
+ fonts to be offered depends on a printer device.
+ </description>
+ </argument>
+ <argument name=":initial-color">
+ <description>
+ This initarg accepts a <reftopic>gfg:color</reftopic> object which the
+ font dialog will use for its initial color selection (as long as the
+ :no-effects style is not set).
+ </description>
+ </argument>
+ <argument name=":initial-font">
+ <description>
+ This initarg accepts a <reftopic>gfg:font</reftopic> object which the
+ font dialog will use for its initial font attribute selections. If not
+ specified, the dialog will be set to the system font's attributes.
+ </description>
+ </argument>
+ <argument name=":style">
+ <description>
+ A <refclhs>list</refclhs> of keyword symbols specifying how the font dialog
+ is to look and behave. One or more of the following:
+ <enum>
+ <argument name=":all-fonts">
+ <description>
+ This is a convenience style, used by default if no other font criteria
+ are specified, that enables the dialog to offer all possible fonts.
+ </description>
+ </argument>
+ <argument name=":fixed-pitch-fonts">
+ <description>
+ Enables the dialog to offer fixed pitch fonts.
+ </description>
+ </argument>
+ <argument name=":no-effects">
+ <description>
+ Causes the font dialog to hide the controls that allow the user to
+ specify strikeout, underline, and text color attributes.
+ </description>
+ </argument>
+ <argument name=":printer-fonts">
+ <description>
+ Enables the dialog to offer fonts supported by the printer associated
+ with the <reftopic>gfg:graphics-context</reftopic> supplied via the
+ :gc initarg.
+ </description>
+ </argument>
+ <argument name=":screen-fonts">
+ <description>
+ Enables the dialog to offer screen fonts supported by the system.
+ </description>
+ </argument>
+ <argument name=":truetype-fonts">
+ <description>
+ Enables the dialog to offer TrueType fonts.
+ </description>
+ </argument>
+ <argument name=":wysiwyg-fonts">
+ <description>
+ Enables the dialog to offer the intersection of the sets of fonts
+ available on the screen and the printer associated with the
+ <reftopic>gfg:graphics-context</reftopic> specified by the :gc
+ initarg.
+ </description>
+ </argument>
+ </enum>
+ </description>
+ </argument>
+ <argument name=":owner">
+ <description>
+ A value is required for this initarg, which may be either a
+ <reftopic>gfw:window</reftopic> or a <reftopic>gfw:dialog</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="window">
<description>
<hierarchy>
Modified: trunk/docs/website/index.html
==============================================================================
--- trunk/docs/website/index.html (original)
+++ trunk/docs/website/index.html Fri Oct 20 20:34:05 2006
@@ -36,7 +36,7 @@
interface. The library can be extended via
<a href="http://www.lisp.org">Common Lisp</a> bindings for system APIs.</p>
<p>Long-term goals for this project may include implementing an application
- framework on top of the toolkit, or a rapid UI development language, or a
+ framework on top of the toolkit, a rapid UI development language, a
UI design tool, or some combination thereof.</p>
<h3>Status</h3>
@@ -51,9 +51,9 @@
<p>The supported Lisp implementations are:
<ul>
- <li><a href="http://clisp.cons.org/">CLISP 2.38 or later</a></li>
+ <li><a href="http://clisp.cons.org/">CLISP 2.38</a> or later</li>
<li><a href="http://www.lispworks.com/">LispWorks 4.4.6</a></li>
- <li><a href="http://www.sbcl.org/">SBCL 0.9.15</a></li>
+ <li><a href="http://www.sbcl.org/">SBCL 0.9.15</a> or later</li>
</ul>
<p>The supported Windows versions are:
More information about the Graphic-forms-cvs
mailing list