[Plplot-cvs] SF.net SVN: plplot:[12958] trunk/doc/docbook/src

[<ai...@us...>]

Revision: 12958
          http://sourceforge.net/p/plplot/code/12958
Author:   airwin
Date:     2014-01-25 19:47:30 +0000 (Sat, 25 Jan 2014)
Log Message:
-----------
Document plgdrawmode and plsdrawmode.

Modified Paths:
--------------
    trunk/doc/docbook/src/api.xml
    trunk/doc/docbook/src/plplotdoc.xml.in

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2014-01-24 08:34:51 UTC (rev 12957)
+++ trunk/doc/docbook/src/api.xml	2014-01-25 19:47:30 UTC (rev 12958)
@@ -5266,6 +5266,45 @@
 
   </sect1>
 
+  <sect1 id="plgdrawmode" renderas="sect3">
+    <title>
+      <function>plgdrawmode</function>: Get drawing mode (depends on
+device support!)
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plgdrawmode</function>
+	  </funcdef>
+	  <paramdef></paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Get drawing mode.  Note only one device driver (cairo) currently
+      supports this at the moment, and for that case the PLINT value
+      returned by this function is one of
+      <literal>PL_DRAWMODE_DEFAULT</literal>,
+      <literal>PL_DRAWMODE_REPLACE</literal>,
+      <literal>PL_DRAWMODE_XOR</literal>, or
+      <literal>PL_DRAWMODE_UNKNOWN</literal>. This function returns
+      <literal>PL_DRAWMODE_UNKNOWN</literal> for the rest of the
+      device drivers.  See also &plsdrawmode;.
+    </para>
+
+    <para>
+      Redacted form: <function>plgdrawmode()</function>
+    </para>
+
+    <para>
+      This function is used in example 34.
+    </para>
+
+  </sect1>
+
   <sect1 id="plgfam" renderas="sect3">
     <title>
       <function>plgfam</function>: Get family file parameters
@@ -5337,7 +5376,6 @@
 
   </sect1>
 
-
   <sect1 id="plgfci" renderas="sect3">
     <title>
       <function>plgfci</function>: Get FCI (font characterization integer)
@@ -12757,6 +12795,55 @@
 
   </sect1>
 
+  <sect1 id="plsdrawmode" renderas="sect3">
+    <title>
+      <function>plsdrawmode</function>: Set drawing mode (depends on
+device support!)
+    </title>
+
+    <para>
+      <funcsynopsis>
+	<funcprototype>
+	  <funcdef>
+	    <function>plsdrawmode</function>
+	  </funcdef>
+	  <paramdef>mode</paramdef>
+	</funcprototype>
+      </funcsynopsis>
+    </para>
+
+    <para>
+      Set drawing mode.  Note only one device driver (cairo) currently
+      supports this at the moment.  See also &plgdrawmode;.
+    </para>
+
+    <variablelist>
+      <varlistentry>
+	<term>
+	  <parameter>mode</parameter>
+	  (<literal>PLINT</literal>, input)
+	</term>
+	<listitem>
+	  <para>
+	    Control variable which species the drawing mode (one of
+           <literal>PL_DRAWMODE_DEFAULT</literal>,
+	   <literal>PL_DRAWMODE_REPLACE</literal>, or
+	   <literal>PL_DRAWMODE_XOR</literal>) to use.
+	  </para>
+	</listitem>
+      </varlistentry>
+    </variablelist>
+
+    <para>
+      Redacted form: <function>plsdrawmode(mode)</function>
+    </para>
+
+    <para>
+      This function is used in example 34.
+    </para>
+
+  </sect1>
+
   <sect1 id="plseed" renderas="sect3">
     <title>
       <function>plseed</function>: Set seed for internal random 

Modified: trunk/doc/docbook/src/plplotdoc.xml.in
===================================================================
--- trunk/doc/docbook/src/plplotdoc.xml.in	2014-01-24 08:34:51 UTC (rev 12957)
+++ trunk/doc/docbook/src/plplotdoc.xml.in	2014-01-25 19:47:30 UTC (rev 12958)
@@ -125,6 +125,7 @@
 <!ENTITY plgdiori '<link linkend="plgdiori"><function>plgdiori</function></link>'>
 <!ENTITY plgdiplt '<link linkend="plgdiplt"><function>plgdiplt</function></link>'>
 <!ENTITY plGetCursor '<link linkend="plGetCursor"><function>plGetCursor</function></link>'>
+<!ENTITY plgdrawmode '<link linkend="plgdrawmode"><function>plgdrawmode</function></link>'>
 <!ENTITY plgfam '<link linkend="plgfam"><function>plgfam</function></link>'>
 <!ENTITY plgfci '<link linkend="plgfci"><function>plgfci</function></link>'>
 <!ENTITY plgfnam '<link linkend="plgfnam"><function>plgfnam</function></link>'>
@@ -197,6 +198,7 @@
 <!ENTITY plsdiori '<link linkend="plsdiori"><function>plsdiori</function></link>'>
 <!ENTITY plsdiplt '<link linkend="plsdiplt"><function>plsdiplt</function></link>'>
 <!ENTITY plsdiplz '<link linkend="plsdiplz"><function>plsdiplz</function></link>'>
+<!ENTITY plsdrawmode '<link linkend="plsdrawmode"><function>plsdrawmode</function></link>'>
 <!ENTITY plseed '<link linkend="plseed"><function>plseed</function></link>'>
 <!ENTITY plsesc '<link linkend="plsesc"><function>plsesc</function></link>'>
 <!ENTITY plsescfortran95 '<link linkend="plsescfortran95"><function>plsescfortran95</function></link>'>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.