From 909c2d4678b5b19a9e34589590bff03cfb4f3982 Mon Sep 17 00:00:00 2001
From: lecoanet
Date: Mon, 2 Sep 2002 12:31:59 +0000
Subject: *** empty log message ***

---
 doc/refman.tex | 91 ++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 53 insertions(+), 38 deletions(-)

(limited to 'doc/refman.tex')

diff --git a/doc/refman.tex b/doc/refman.tex
index 489e0a7..8af2ff7 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -1290,9 +1290,9 @@ reference) and all list parameters are given as array references.
         pathname {\bf addtag} tag ancestors tagOrId ?tagOrId2?\\
         \$zinc->{\bf addtag}(tag, 'ancestors', tagOrId, ?tagOrId2?);}
 
-	Selects all ancestors (i.e. parent groups) of tagOrId.  If
-    	{\tt tagOrId} names more than one item, the first, (or the topmost)
-	of these items in the display list will be used. If ?tagOrId2? is specified,
+        Selects all ancestors (i.e. parent groups) of tagOrId.  If
+        {\tt tagOrId} names more than one item, the first, (or the topmost)
+        of these items in the display list will be used. If ?tagOrId2? is specified,
         only parent groups with this tag are selected.
 
   \item{\tt\large
@@ -1508,8 +1508,9 @@ false.
 \end{blockindent}
 
 
-\zinccmd{contour}{tagOrId operatorSpec coordListOrTagOrId}
+\zinccmd{contour}{tagOrId ?operatorSpec coordListOrTagOrId?}
 
+{\tt\large \$zinc->{\bf contour}(tagOrId);}
 {\tt\large \$zinc->{\bf contour}(tagOrId, operatorSpec, coordListOrTagOrId);}
 
 \begin{blockindent}
@@ -1519,6 +1520,15 @@ false.
   {\tt tagOrId} specifies the item whose contours will be modified.  If {\tt tagOrId}
   describes more than one item, the first in display list order will be used.
   
+  If the command is invoked with only the tagOrId parameter, it returns the number of
+  contours composing the item. In fact it always returns the number of contours after
+  a command has been conducted, it happens that with this reduced form nothing is done
+  except returning the number of contours..
+
+  On items that do not support the contour command, the returned value is 0 or 1 depending
+  on the item having a contour or not. For example {\tt Tracks} yield 0 while
+  {\tt Rectangles} yield 1.
+
   {\tt coordListOrTagOrId} specifies a list of coordinates or an item describing a
   contour. If a list is specified it should contain a pair number of floating point values
   specifying the contour vertices X and Y in order. If a tag or an id is specified, it is
@@ -1734,41 +1744,41 @@ false.
   various {\tt args}. The items are sorted in drawing order, topmost first. \\
   For example:\\
   \code{ \# to get the item under the mouse cursor:\\
-	\$item = \$zinc->find('withtag', 'current');\\
-	\# to get the closest item of a point:\\ \$closest = \$zinc->find ('closest', \$x, \$y);
+        \$item = \$zinc->find('withtag', 'current');\\
+        \# to get the closest item of a point:\\ \$closest = \$zinc->find ('closest', \$x, \$y);
   }
   As detailled in \cmdref{addtag} command the following searchCommands are possible:
   \begin{itemize}
-	\item{\tt\large
-        	pathname {\bf find} above tagOrId \\
-        	\$zinc->{\bf find}('above', tagOrId);}
-	\item{\tt\large
-       		pathname {\bf find} all ?inGroup? ?recursive?\\
-        	\$zinc->{\bf find}('all', ?inGroup?, ?recursive?);}
-	\item{\tt\large
-        	pathname {\bf find} atpriority priority ?tagOrId?\\
-        	\$zinc->{\bf find}('atpriority', priority, ?tagOrId?);}
-	\item{\tt\large
-        	pathname {\bf find} ancestors tagOrId ?tagOrId2?\\
-        	\$zinc->{\bf find}('ancestors', tagOrId, ?tagOrId2?);}
-	\item{\tt\large
-        	pathname {\bf find} below tagOrId\\ 
-        	\$zinc->{\bf find}('below', tagOrId);}
-	\item{\tt\large
-        	pathname {\bf find} closest x y ?halo? ?startItem?, ?recursive?\\ 
-        	\$zinc->{\bf find}('closest', x, y, ?halo?, ?startItem?, ?recursive?);}
-	\item{\tt\large
-        	pathname {\bf find} enclosed xo yo xc yc ?inGroup? ?recursive?\\ 
-        	\$zinc->{\bf find}('enclosed', xo, yo, xc, yc, ?inGroup?, ?recursive?);}
-	\item{\tt\large
-        	pathname {\bf find} overlapping xo yo xc yc ?inGroup? ?recursive?\\ 
-        	\$zinc->{\bf find}('overlapping', xo, yo, xc, yc, ?inGroup?, ?recursive?);}
-	\item{\tt\large
-        	pathname {\bf find} withtag tagOrId\\ 
-        	\$zinc->{\bf find}('withtag', tagOrId);}
-	\item{\tt\large
-        	pathname {\bf find} withtype type ?tagOrId?\\ 
-        	\$zinc->{\bf find}('withtype', type, ?tagOrId?);}
+        \item{\tt\large
+                pathname {\bf find} above tagOrId \\
+                \$zinc->{\bf find}('above', tagOrId);}
+        \item{\tt\large
+                pathname {\bf find} all ?inGroup? ?recursive?\\
+                \$zinc->{\bf find}('all', ?inGroup?, ?recursive?);}
+        \item{\tt\large
+                pathname {\bf find} atpriority priority ?tagOrId?\\
+                \$zinc->{\bf find}('atpriority', priority, ?tagOrId?);}
+        \item{\tt\large
+                pathname {\bf find} ancestors tagOrId ?tagOrId2?\\
+                \$zinc->{\bf find}('ancestors', tagOrId, ?tagOrId2?);}
+        \item{\tt\large
+                pathname {\bf find} below tagOrId\\ 
+                \$zinc->{\bf find}('below', tagOrId);}
+        \item{\tt\large
+                pathname {\bf find} closest x y ?halo? ?startItem?, ?recursive?\\ 
+                \$zinc->{\bf find}('closest', x, y, ?halo?, ?startItem?, ?recursive?);}
+        \item{\tt\large
+                pathname {\bf find} enclosed xo yo xc yc ?inGroup? ?recursive?\\ 
+                \$zinc->{\bf find}('enclosed', xo, yo, xc, yc, ?inGroup?, ?recursive?);}
+        \item{\tt\large
+                pathname {\bf find} overlapping xo yo xc yc ?inGroup? ?recursive?\\ 
+                \$zinc->{\bf find}('overlapping', xo, yo, xc, yc, ?inGroup?, ?recursive?);}
+        \item{\tt\large
+                pathname {\bf find} withtag tagOrId\\ 
+                \$zinc->{\bf find}('withtag', tagOrId);}
+        \item{\tt\large
+                pathname {\bf find} withtype type ?tagOrId?\\ 
+                \$zinc->{\bf find}('withtype', type, ?tagOrId?);}
   \end{itemize}
 \end{blockindent}
 
@@ -1835,7 +1845,7 @@ false.
 \end{blockindent}
 
 
-\zinccmd{gname}{gradientName}
+\zinccmd{gname}{?gradientDesc? gradientName}
 
 {\tt\large \$zinc->{\bf gname}('black:100|white:0/0', 'fading');}
 {\tt\large \$exist = \$zinc->{\bf gname}('nameOrGradient');}
@@ -2259,9 +2269,11 @@ false.
 \end{blockindent}
 
 
-\zinccmd{tsave}{tagOrId tName}
+\zinccmd{tsave}{?tagOrId? tName ?invert?}
 
+{\tt\large \$zinc->{\bf tsave}(tName);}
 {\tt\large \$zinc->{\bf tsave}(tagOrdId, tName);}
+{\tt\large \$zinc->{\bf tsave}(tagOrdId, tName, invert);}
 
 \begin{blockindent}
   Create (or reset) a transform associated with the name {\tt tName} which has for initial
@@ -2269,6 +2281,9 @@ false.
   more than one item, the topmost in display list order is used. If {\tt tagOrId} doesn't
   describe any item, an error is raised. If {\tt tName} already exists, the transform is
   set to the new value. This command is the only way to create a named transform.
+  If {\tt tagOrId} is not specified, the command returns a boolean telling if the
+  name is already in use. The {\tt invert} boolean, if specified, cause the transform
+  to be inverted prior to be saved.
 \end{blockindent}
 
 
-- 
cgit v1.1

