aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/refman.tex45
1 files changed, 24 insertions, 21 deletions
diff --git a/doc/refman.tex b/doc/refman.tex
index 210961b..8ffa0a9 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -36,7 +36,7 @@
citecolor=webbrightgreen,
pdftitle={Zinc, an advanced scriptable Canvas.},
pdfauthor={Patrick Lecoanet, Christophe Mertz, Centre d'Étude de la Navigation Aérienne},
- pdfsubject={The 3.3 Reference Manual.},
+ pdfsubject={The pre-3.4 Reference Manual.},
pdfkeywords={tk tcl perl x11 canvas opengl script gui TkZinc},
pagebackref,
pdfpagemode=None,
@@ -205,9 +205,9 @@
\setlength{\marginparwidth}{20pt}
\setlength{\textwidth}{480pt}
-\title{Zinc, an advanced scriptable Canvas.\\The 3.3 Reference Manual.\\\small{[CENA technical Note NT03-532]} }
+\title{Zinc, an advanced scriptable Canvas.\\The 3.4 pre-release Reference Manual.\\\small{[CENA technical Note NT03-532]} }
\author{Patrick Lecoanet, Christophe Mertz}
-\date{15 January 2003}
+\date{18 February 2003}
\begin{document}
@@ -286,7 +286,7 @@ This document is also referenced as CENA technical note NT03-532.
\section{Differences with previous version}
-\subsection{Differences between 3.3 release and 3.2.6 release}
+\subsection{Differences between 3.4 pre-release and 3.2.6 release}
\begin{itemize}
\item bezier items have been suppressed; they can now be easily replaced by curve items.
\item curve items support now a higher level of description: they may be composed of line
@@ -1444,10 +1444,10 @@ reference) and all list parameters are given as array references.
points defining the perimeter. If \attributeref{triangles}{fan} is false, the
triangles are arranged in a strip.
\item{\objectref{tabular}, \objectref{track}, \objectref{waypoint}}\\
- These types expects the number of fields they will manage in the label or
+ These types expect the number of fields they will manage in the label or
tabular form. This number must be greater or equal to zero.
\item{\objectref{group}, \objectref{icon}, \objectref{map}, \objectref{reticle}, \objectref{text}, \objectref{window}}\\
- These types doesn't expect type specific arguments.
+ These types do not expect type specific arguments.
\end{description}
Following the creation args the command accept any number of
@@ -1635,7 +1635,7 @@ reference) and all list parameters are given as array references.
between {\tt sequence} and {\tt command} is established, overriding any existing binding
for the sequence. If the first character of {\tt command} is ``+'', then {\tt command}
augments the existing binding instead of replacing it. In this case the command returns
- an empty string. If the {\tt command} parameter is omitted, the command return the {\tt
+ an empty string. If the {\tt command} parameter is omitted, the command returns the {\tt
command} associated with {\tt tagOrId} and {\tt sequence} or an error is raised if there
is no such binding. If only {\tt tagOrId} is specified the command returns a list of all
the sequences for which there are bindings for {\tt tagOrId}.
@@ -1723,7 +1723,7 @@ false.
chapter \conceptref{Widget options}{options} for a list of available options). If an
{\tt option} is specified without a {\tt value}, the command returns a list describing
the named option in the standard Tk format. If some {\tt option - value} pairs are
- given, then the corresponding options are changed and the command return an empty
+ given, then the corresponding options are changed and the command returns an empty
string.
\end{blockindent}
@@ -1745,9 +1745,11 @@ false.
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.
+ On items that do not support multiple contours, the returned value is 0 or 1 depending
+ on the item having a contour or not. \objectref{track}, \objectref{waypoint},
+ \objectref{reticle}, \objectref{group}, \objectref{map}, and yield 0
+ while \objectref{rectangle}, \objectref{tabular}, \objectref{arc}, \objectref{icon},
+ \objectref{triangles}, \objectref{text}, and \objectref{window} yield 1.
{\tt coordListOrTagOrId} specifies a list of coordinates (either a flat list of X and Y, or
a list similar to the one allowed for a curve item) or an item describing a
@@ -1909,7 +1911,7 @@ false.
\begin{blockindent}
Returns a string specifying the item part that has the pointer. 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 {\tt ""}. The string can be either an integer
+ \ident{current} tag) the command returns {\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.
\end{blockindent}
@@ -2143,7 +2145,7 @@ false.
\begin{blockindent}
This command returns a number which is the numerical index in the item described by {\tt
tagOrId} corresponding to {\tt index}. The possible forms for {\tt index} are described
- in \conceptref{Text indices}{indices}. The command return a value between 0 and the
+ in \conceptref{Text indices}{indices}. The command returns a value between 0 and the
number of character in the item. If {\tt tagOrId} describes more than one item, the index
is processed in the first item supporting text indexing in display list order.
\end{blockindent}
@@ -2196,12 +2198,12 @@ false.
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 the command return an empty
+ changed for all the items described by {\tt tagOrId} and the command returns an empty
string. If {\tt field} is given, it must be a valid field index for the item or an
error will be reported. If a field index is given, the command will interpret the given
attributes as field attributes, otherwise they will be interpreted as item attributes.
- If an attribute does not belong to the item or field, it will be silently ignored. This
- is done to preserve the usefulness of \cmdref{itemconfigure} on tags.
+ If an attribute does not belong to the item or field, an error is reported. When configuring
+ a set of item defiend by a tag, all items must then accept these attributes.
\end{blockindent}
@@ -2427,9 +2429,10 @@ false.
given in {\tt coordList} from the coordinate space of the transform or item described by
{\tt tagOrIdFrom} to the coordinate space of the transform or item described by {\tt
tagOrIdTo}. If {\tt tagOrIdFrom} is omitted it defaults to the window coordinate
- space. If either {\tt tagOrId} describes more than one item, the topmost in display list
- order is used. If {\tt tagOrId} doesn't describe either a transform or an item, an error
- is raised. The {\tt coordList} should either be a flat list containing an even number of
+ space. If either {\tt tagOrIdFrom} or {\tt tagOrIdTo} describes more than one item,
+ the topmost in display list order is used. If either {\tt tagOrIdFrom} or {\tt tagOrIdTo}
+ doesn't describe either a transform or an item, an error is raised.
+ The {\tt coordList} should either be a flat list containing an even number of
coordinates each point having two coordinates, or a list of lists each sublist of the form
[ X Y ?pointtype? ]. The returned coordinates list will be isomorphic to the list given
as argument.
@@ -2499,8 +2502,8 @@ false.
\zinccmd{tsave}{?tagOrId? tName ?invert?}
-{\tt\large \$zinc->{\bf tsave}(tName);}
-{\tt\large \$zinc->{\bf tsave}(tagOrdId, tName);}
+{\tt\large \$zinc->{\bf tsave}(tName);}\\
+{\tt\large \$zinc->{\bf tsave}(tagOrdId, tName);}\\
{\tt\large \$zinc->{\bf tsave}(tagOrdId, tName, invert);}
\begin{blockindent}