[graphic-forms-cvs] r363 - trunk/docs/manual

[junrue at common-lisp.net]

Author: junrue
Date: Thu Oct 19 23:56:22 2006
New Revision: 363

Modified:
   trunk/docs/manual/gfg-symbols.xml
Log:
 

Modified: trunk/docs/manual/gfg-symbols.xml
==============================================================================
--- trunk/docs/manual/gfg-symbols.xml	(original)
+++ trunk/docs/manual/gfg-symbols.xml	Thu Oct 19 23:56:22 2006
@@ -1484,6 +1484,76 @@
     </seealso>
   </generic-function>
 
+  <generic-function name="draw-text">
+    <syntax>
+      <arguments>
+        <argument name="graphics-context">
+          <description>
+            A <reftopic>gfg:graphics-context</reftopic> on which to draw.
+          </description>
+        </argument>
+        <argument name="string">
+          <description>
+            A <refclhs>string</refclhs> to be rendered, which may contain
+            characters that will be interpreted specially; see <arg3/>.
+          </description>
+        </argument>
+        <argument name="point">
+          <description>
+            A <reftopic>gfg:point</reftopic> specifying the upper-left
+            corner of the rectangle bounding <arg1/>.
+          </description>
+        </argument>
+        <notarg name="&optional"/>
+        <argument name="style">
+          <description>
+            A <refclhs>list</refclhs> containing one or more of the following
+            keyword symbols:
+            <enum>
+              <argument name=":mnemonic">
+                <description>
+                  Underline the mnemonic character, specified in <arg1/> with
+                  an ampersand.
+                </description>
+              </argument>
+              <argument name=":tab">
+                <description>
+                  Expand tabs embedded in <arg1/>; see <arg4/>.
+                </description>
+              </argument>
+              <argument name=":transparent">
+                <description>
+                  The background of the drawing area where <arg1/> will be
+                  rendered is preserved.
+                </description>
+              </argument>
+            </enum>
+          </description>
+        </argument>
+        <argument name="tab-width">
+          <description>
+            A positive <refclhs>integer</refclhs> specifying the number of
+            pixels into which tabs should be expanded; the default is 8.
+          </description>
+        </argument>
+      </arguments>
+      <return>
+        <emphasis>undefined</emphasis>
+      </return>
+    </syntax>
+    <description>
+      Draws <arg1/>, optionally expanding tabs and underlining the mnemonic
+      character.
+    </description>
+    <seealso>
+      <reftopic>gfg:foreground-color</reftopic>
+      <reftopic>gfg:background-color</reftopic>
+      <reftopic>gfg:font</reftopic>
+      <reftopic>gfg:text-extent</reftopic>
+      <reftopic>gfg:metrics</reftopic>
+    </seealso>
+  </generic-function>
+
   <generic-function name="load">
     <syntax>
       <arguments>