[graphic-forms-cvs] r360 - trunk/docs/manual
junrue at common-lisp.net
junrue at common-lisp.net
Fri Oct 20 00:40:26 UTC 2006
Author: junrue
Date: Thu Oct 19 20:40:25 2006
New Revision: 360
Added:
trunk/docs/manual/constants.xml
Modified:
trunk/docs/manual/Makefile
trunk/docs/manual/api.xml
trunk/docs/manual/clhs-table.xml
trunk/docs/manual/gfg-symbols.xml
trunk/docs/manual/graphic-forms.xml
Log:
Modified: trunk/docs/manual/Makefile
==============================================================================
--- trunk/docs/manual/Makefile (original)
+++ trunk/docs/manual/Makefile Thu Oct 19 20:40:25 2006
@@ -5,6 +5,9 @@
# Copyright (c) 2006, Jack D. Unrue
#
+CHM-DEPS = gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml constants.xml api.xml \
+ catalog.xml glossary.xml graphic-forms.xml image-data-plugins.xml \
+ introduction.xml legal.xml miscellaneous-topics.xml
COMMON-DEPS = gf-data.xsl gf-package.xsl clhs-table.xml win32-api-table.xml
TMP-XML = gfs-tmp-pkg.xml gfs-tmp-syms.xml gfg-tmp-pkg.xml gfg-tmp-syms.xml \
@@ -12,7 +15,7 @@
XSLT-PROC = xsltproc --nonet
-graphic-forms.chm: gfs-tmp-pkg.xml gfg-tmp-pkg.xml gfw-tmp-pkg.xml
+graphic-forms.chm: $(CHM-DEPS)
$(XSLT-PROC) graphic-forms.xsl graphic-forms.xml
-hhc htmlhelp.hhp; exit 0 # muffle Error Ignored msg due to hhc exit value 1
find . \( -name "*~" -o -name "*.html" -o -name "*.hhk" -o -name "*.hhc" -o -name "*.hhp" \) -exec rm {} \;
Modified: trunk/docs/manual/api.xml
==============================================================================
--- trunk/docs/manual/api.xml (original)
+++ trunk/docs/manual/api.xml Thu Oct 19 20:40:25 2006
@@ -10,6 +10,7 @@
This chapter documents the Graphic-Forms programming interface.
</para>
+ &constants;
&gfgpkg;
&gfspkg;
&gfwpkg;
Modified: trunk/docs/manual/clhs-table.xml
==============================================================================
--- trunk/docs/manual/clhs-table.xml (original)
+++ trunk/docs/manual/clhs-table.xml Thu Oct 19 20:40:25 2006
@@ -8,6 +8,7 @@
<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="float" url="http://www.lispworks.com/documentation/HyperSpec/Body/t_float.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"/>
Added: trunk/docs/manual/constants.xml
==============================================================================
--- (empty file)
+++ trunk/docs/manual/constants.xml Thu Oct 19 20:40:25 2006
@@ -0,0 +1,80 @@
+<!--
+ constants.xml
+
+ Copyright (c) 2006, Jack D. Unrue
+-->
+<chapter>
+ <title>Constants and Variables</title>
+ <indexterm><primary>constants</primary></indexterm>
+
+ <para role="normal">
+ This section lists the symbols for constants and variables exported from
+ each package.
+ </para>
+
+ <bridgehead renderas="sect2">character sets [GFG]</bridgehead>
+
+ <informaltable frame="none">
+ <anchor id="character sets"/>
+ <indexterm><primary>character sets</primary></indexterm>
+ <tgroup cols="1">
+ <tbody>
+ <row><entry><para role="normal">+ansi-charset+</para></entry></row>
+ <row><entry><para role="normal">+arabic-charset+</para></entry></row>
+ <row><entry><para role="normal">+baltic-charset+</para></entry></row>
+ <row><entry><para role="normal">+chinesebig5-charset+</para></entry></row>
+ <row><entry><para role="normal">+default-charset+</para></entry></row>
+ <row><entry><para role="normal">+easteurope-charset+</para></entry></row>
+ <row><entry><para role="normal">+gb2312-charset+</para></entry></row>
+ <row><entry><para role="normal">+greek-charset+</para></entry></row>
+ <row><entry><para role="normal">+hangeul-charset+</para></entry></row>
+ <row><entry><para role="normal">+hangul-charset+</para></entry></row>
+ <row><entry><para role="normal">+hebrew-charset+</para></entry></row>
+ <row><entry><para role="normal">+johab-charset+</para></entry></row>
+ <row><entry><para role="normal">+mac-charset+</para></entry></row>
+ <row><entry><para role="normal">+oem-charset+</para></entry></row>
+ <row><entry><para role="normal">+russian-charset+</para></entry></row>
+ <row><entry><para role="normal">+shiftjis-charset+</para></entry></row>
+ <row><entry><para role="normal">+symbol-charset+</para></entry></row>
+ <row><entry><para role="normal">+thai-charset+</para></entry></row>
+ <row><entry><para role="normal">+turkish-charset+</para></entry></row>
+ <row><entry><para role="normal">+vietnamese-charset+</para></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <bridgehead renderas="sect2">colors [GFG]</bridgehead>
+
+ <informaltable frame="none">
+ <anchor id="colors"/>
+ <indexterm><primary>colors</primary></indexterm>
+ <tgroup cols="1">
+ <tbody>
+ <row><entry><para role="normal">*color-black*</para></entry></row>
+ <row><entry><para role="normal">*color-blue*</para></entry></row>
+ <row><entry><para role="normal">*color-green*</para></entry></row>
+ <row><entry><para role="normal">*color-red*</para></entry></row>
+ <row><entry><para role="normal">*color-white*</para></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <bridgehead renderas="sect2">system icons [GFG]</bridgehead>
+
+ <informaltable frame="none">
+ <anchor id="system icons"/>
+ <indexterm><primary>system icons</primary></indexterm>
+ <tgroup cols="1">
+ <tbody>
+ <row><entry><para role="normal">+application-icon+</para></entry></row>
+ <row><entry><para role="normal">+error-icon+</para></entry></row>
+ <row><entry><para role="normal">+information-icon+</para></entry></row>
+ <row><entry><para role="normal">+question-icon+</para></entry></row>
+ <row><entry><para role="normal">+warning-icon+</para></entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+
+ <para role="normal"/>
+
+</chapter>
Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml (original)
+++ trunk/docs/manual/gfg-symbols.xml Thu Oct 19 20:40:25 2006
@@ -143,7 +143,7 @@
</argument>
<argument name=":system">
<description>
- An icon identifier constant.
+ A <reftopic label="system icon">system icons</reftopic> constant.
</description>
</argument>
<argument name=":transparency-pixel">
@@ -437,7 +437,7 @@
<arguments>
<argument name=":char-set">
<description>
- A <reftopic label="character set">xxx</reftopic> constant value.
+ A <reftopic>character sets</reftopic> constant value.
</description>
</argument>
<notarg name="integer"/>
@@ -738,6 +738,47 @@
<!-- GENERIC FUNCTIONS -->
+ <generic-function name="load">
+ <syntax>
+ <arguments>
+ <argument name="self">
+ <description>
+ The object to be populated with data.
+ </description>
+ </argument>
+ <argument name="pathname">
+ <description>
+ A <refclhs>string</refclhs> or <refclhs>pathname</refclhs>
+ identifying the graphics data file to be loaded.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>list</refclhs>
+ </return>
+ </syntax>
+ <description>
+ <para role="normal">
+ Certain graphics objects have a persistent representation, which may
+ be deserialized with the appropriate implementation of this function.
+ <arg0/> will be re-initialized with data from the file identified by
+ <arg1/>. Certain serialized object formats (e.g., ICO) may actually
+ describe multiple instances. To facilitate such formats, this function
+ returns <arg0/> plus any additional instances in a <refclhs>list</refclhs>,
+ ordered the same as they are read from the file.
+ </para>
+
+ <para role="normal">
+ Note: this symbol shadows the Common Lisp symbol of the same name.
+ </para>
+ </description>
+ <seealso>
+ <reftopic>gfg:image-data</reftopic>
+ <reftopic>Image Data Plugins</reftopic>
+ <reftopic>gfg:image</reftopic>
+ </seealso>
+ </generic-function>
+
<generic-function name="font">
<syntax with-setf="t">
<arguments>
@@ -1088,6 +1129,34 @@
</seealso>
</slot-accessor>
+ <slot-accessor name="miter-limit">
+ <syntax with-setf="t">
+ <arguments>
+ <argument name="graphics-context">
+ <description>
+ The <reftopic>gfg:graphics-context</reftopic> whose pen width
+ value is to be retrieved or set.
+ </description>
+ </argument>
+ </arguments>
+ <return>
+ <refclhs>float</refclhs>
+ </return>
+ </syntax>
+ <description>
+ Returns (sets) a <refclhs>float</refclhs> value describing the allowable
+ ratio of miter length to line width. The miter length is the distance
+ from the intersection of the line walls on the inside of a join to the
+ intersection of the line walls on the outside of the same join. The
+ default value is 10.0. This value affects the :miter-join pen style.
+ </description>
+ <seealso>
+ <reftopic>gfg:pen-style</reftopic>
+ <reftopic>gfg:pen-width</reftopic>
+ <reftopic>gfg:draw-line</reftopic>
+ </seealso>
+ </slot-accessor>
+
<!-- MACROS -->
<macro name="with-image-transparency">
Modified: trunk/docs/manual/graphic-forms.xml
==============================================================================
--- trunk/docs/manual/graphic-forms.xml (original)
+++ trunk/docs/manual/graphic-forms.xml Thu Oct 19 20:40:25 2006
@@ -9,6 +9,7 @@
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY api SYSTEM "api.xml">
+ <!ENTITY constants SYSTEM "constants.xml">
<!ENTITY gfgpkg SYSTEM "gfg-tmp-pkg.xml"> <!-- generated file -->
<!ENTITY gfspkg SYSTEM "gfs-tmp-pkg.xml"> <!-- generated file -->
<!ENTITY gfwpkg SYSTEM "gfw-tmp-pkg.xml"> <!-- generated file -->
More information about the Graphic-forms-cvs
mailing list