From 8b12f70b40230b12fb5617e3a7589e71401e80a1 Mon Sep 17 00:00:00 2001
From: lecoanet
Date: Mon, 13 Nov 2000 09:04:06 +0000
Subject: Correction et �claircissements sur certaines commandes.

---
 doc/refman.tex | 104 +++++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 83 insertions(+), 21 deletions(-)

(limited to 'doc/refman.tex')

diff --git a/doc/refman.tex b/doc/refman.tex
index 532b643..bf3ca09 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -446,7 +446,7 @@ of the \ident{canvas} command set.
   search specification. If the tag is already present on some item,
   nothing is done for that item. The command has no effect if no
   item satisfy the given criteria. The command returns an empty
-  string. The search specification an the associated arguments can
+  string. The search specification and the associated arguments can
   take the following forms:
   \begin{description}
   \item{\tt above tagOrId ?inGroup? ?recursive?} \\
@@ -608,12 +608,12 @@ of the \ident{canvas} command set.
   defaults to false.
 \end{blockindent}
 
-\zinccmd{clone}{tagOrId ?option value ...?}
+\zinccmd{clone}{tagOrId ?attr value ...?}
 \begin{blockindent}
   Create an exact copy of all the items described by {\tt tagOrId}.
   The copy goes recursively for group items (deep copy). After copying
-  the pairs {\tt option value} are used, if any, to reconfigure
-  the items. Any option that as no meaning in the context of some item
+  the pairs {\tt attr value} are used, if any, to reconfigure
+  the items. Any attribute that as no meaning in the context of some item
   is ignored. The items down the hierarchy of group items are not
   concerned by the configuration phase. The command returns the list
   of cloned items id in creation order (display list order of the models).
@@ -761,7 +761,7 @@ of the \ident{canvas} command set.
 \begin{blockindent}
   Returns a string specifying the item part over which the pointer is.
   If the current item doesn't have parts or if the pointer is not over
-  an item (no item has the \ident{current} tag) the command return -1.
+  an item (no item has the \ident{current} tag) the command return {\tt ""}.
   The string can be either an integer describing a field index or the
   name of a special part of the item. Consult each item description to
   find out which part names can be reported.
@@ -935,10 +935,13 @@ of the \ident{canvas} command set.
 \zinccmd{itemconfigure}{tagOrId ?field? ?attr? ?value? ?attr value ...?}
 \begin{blockindent}
   Query or modify the attributes of an item or field. If no attribute
-  is given, returns a list describing all the supported attributes. If
-  a single attribute is specified without a value, the command returns
-  a list describing the name attribute. For these two form of the command
-  the topmost item described by {\tt tagOrId} is used.
+  is given, returns a list of lists describing all the supported attributes.
+  If a single attribute is specified without a value, the command returns
+  a list describing the named attribute. Each attribute is described by a
+  list with the following content: the attribute name, the attribute type,
+  a boolean telling if the attribute is read-only, an empty string, and
+  the current value of the attribute. In the two querying forms of the
+  command the topmost item described by {\tt tagOrId} is used.
 
   If at least one attribute - value pair is given, then the corresponding
   attributes are changed for all the items described by {\tt tagOrId} and
@@ -958,7 +961,10 @@ of the \ident{canvas} command set.
   {\tt belowThis} name more than one item, the bottom most them is used.
   If {\tt belowThis} doesn't name an item, an error is raised. If
   {\tt belowThis} is omitted the items are put at the bottom most
-  position. The command returns an empty string.
+  position of their respective groups. The command ignore all items named
+  by {\tt tagOrId} that are not in the same group than {\tt belowThis} or,
+  if not specified, in the same group than the first item named by
+  {\tt tagOrId}. The command returns an empty string.
   As a side affect of this command, the \ident{priority} attribute of
   all the reordered items is ajusted to match the priority of the
   {\tt belowThis} item (or the priority of the bottom most item).
@@ -997,7 +1003,10 @@ of the \ident{canvas} command set.
   {\tt aboveThis} name more than one item, the topmost in display
   list order is used. If {\tt aboveThis} doesn't name an item, an error
   is raised. If {\tt aboveThis} is omitted the items are put at the top most
-  position. The command returns an empty string.
+  position of their respective groups. The command ignore all items named
+  by {\tt tagOrId} that are not in the same group than {\tt aboveThis} or,
+  if not specified, in the same group than the first item named by
+  {\tt tagOrId}. The command returns an empty string.
   As a side affect of this command, the \ident{priority} attribute of
   all the reordered items is ajusted to match the priority of the
   {\tt aboveThis} item (or the priority of the top most item).
@@ -1159,10 +1168,13 @@ of the \ident{canvas} command set.
 
 \zinccmd{vertexat}{tagOrId x y}
 \begin{blockindent}
-  Return the vertex index closest to the device coordinates {\tt x} and
-  {\tt y} in the item described by {\tt tagOrId}. If {\tt tagOrId}
-  describes more than one item, the first item in display list order
-  that supports vertex picking is used.
+  Return a list of values describing the vertex and edge closest to the
+  device coordinates {\tt x} and {\tt y} in the item described by {\tt tagOrId}.
+  If {\tt tagOrId} describes more than one item, the first item in display list
+  order that supports vertex picking is used. The list consists of the index
+  of the contour containing the returned vertices, the index of the
+  closest vertex and the index of a vertex next to the closest vertex that
+  identify the closest edge (located between the two returned vertices).
 \end{blockindent}
 
 
@@ -1926,7 +1938,9 @@ Applicable attributes for \ident{reticle}:
 \section{Map items}
 
 \object{map}
-Applicable attributes for \ident{map}:
+
+
+  Applicable attributes for \ident{map}:
 
 \attribute{color}{color}{Specifies the color usedd to draw or fill the map. The
   texts and symbols that are part of the map are also drawn in this color.
@@ -1960,7 +1974,16 @@ Applicable attributes for \ident{map}:
 \section{Rectangle items}
 
 \object{rectangle}
-Applicable attributes for \ident{rectangle}:
+
+  Items of type \ident{rectangle} display a rectangular shape, optionally
+  filled. The rectangle is described by its bottom-left and top-right corners.
+
+  It is possible to use this item as a clip item for its group. It is also
+  possible to use the rectangle in a \ident{contour} command to build a complex
+  shape in a \ident{curve} item. The two points describing the rectangle
+  can be read and modified with the \ident{coords} command.
+
+  Applicable attributes for \ident{rectangle}:
 
 \attribute{composerotation}{boolean}{Specifies if the current rotation should
   be composed with the local transform. The default value is {\tt true}.}
@@ -2009,7 +2032,19 @@ Applicable attributes for \ident{rectangle}:
 \section{Arc items}
 
 \object{arc}
-Applicable attributes for \ident{arc}:
+
+  Items of type \ident{arc} display an oval section, optionally filled,
+  delimited by two angles. The oval is described by its enclosing rectangle.
+  The arc can be closed either by a straight line joining its end points
+  or by two segments going throught the center to form a pie-slice.
+  
+  It is possible to use this item as a clip item for its group, the clip
+  shape will be the polygon obtained by closing the arc. It is also possible
+  to use this polygon in a \ident{contour} command to build a complex shape
+  in a \ident{curve} item. The two points describing the enclosing rectangle
+  can be read and modified with the \ident{coords} command.
+
+  Applicable attributes for \ident{arc}:
 
 \attribute{closed}{boolean}{Specifies if the outline of the arc should be
   closed. This is only pertinent if the arc extent is less than 360 degrees.
@@ -2074,7 +2109,19 @@ Applicable attributes for \ident{arc}:
 \section{Curve items}
 
 \object{curve}
-Applicable attributes for \ident{curve}:
+
+  Items of type \ident{curve} display a path of line segments connected by their
+  end points. It is possible to build curve items with more than one path
+  to describe complex shapes with the \ident{contour} command. This command can be
+  used to perform boolean operations between a curve and almost any other item
+  available in \ident{zinc} including another curve. The polygon delimited by the
+  path can optionally be filled.
+  
+  It is possible to use this item as a clip item for its group, the clip shape will
+  be the polygon obtained by closing the path. The vertices can be read, modified,
+  added or removed with the \ident{coords} command.
+
+  Applicable attributes for \ident{curve}:
 
 \attribute{capstyle}{capstyle}{Specifies the form of the outline ends. This
   attribute is only applicable if the curve is not closed and the outline relief is
@@ -2144,7 +2191,20 @@ Applicable attributes for \ident{curve}:
 
 \object{bezier}
 
-
+  Items of type \ident{bezier} display a path of Bezier cubic segments connected
+  by their end points. Each segment is described by four control points, two
+  located at the ends of the segment and two located off curve. The last segment
+  can contain less than four points but at least two. If it contains two points
+  a straight line segment is drawn, if it contains three points, the second
+  point is used as the two off-curve control points. The polygon delimited by the
+  path can optionally be filled.
+  
+  It is possible to use this item as a clip item for its group, the clip
+  shape will be the polygon obtained by closing the path. It is also possible
+  to use this polygon in a \ident{contour} command to build a complex shape
+  in a \ident{curve} item. The controls points can be read, modified, added or
+  removed with the \ident{coords} command.
+  
 Applicable attributes for \ident{bezier}:
 
 \attribute{capstyle}{capstyle}{Specifies the form of the outline ends. This
@@ -2206,7 +2266,9 @@ Applicable attributes for \ident{bezier}:
 \object{window}
 
   Items of type \ident{window} display an X11 window at a given position in the
-  widget. It is possible to use this item as a clip item for its group, the clip
+  widget.
+
+  It is possible to use this item as a clip item for its group, the clip
   shape will be the window rectangle. It is also possible to use the rectangular
   shape of the window item in a \ident{contour} command to build a complex shape
   in a \ident{curve} item. The position of the window, relative to the anchor,
-- 
cgit v1.1

