aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/refman.tex83
1 files changed, 24 insertions, 59 deletions
diff --git a/doc/refman.tex b/doc/refman.tex
index a6be781..b8f6c98 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 pre-3.3 (3.2.97) Reference Manual.},
+ pdfsubject={The pre-3.3 (3.2.99) Reference Manual.},
pdfkeywords={tk tcl perl x11 canvas opengl script gui TkZinc},
pagebackref,
pdfpagemode=None,
@@ -208,7 +208,7 @@
\setlength{\marginparwidth}{20pt}
\setlength{\textwidth}{480pt}
-\title{Zinc, an advanced scriptable Canvas.\\The pre 3.3 (3.2.97) Reference Manual.\\\small{[CENA technical Note NT03-532]} }
+\title{Zinc, an advanced scriptable Canvas.\\The pre 3.3 (3.2.99) Reference Manual.\\\small{[CENA technical Note NT03-532]} }
\author{Patrick Lecoanet, Christophe Mertz}
\date{1 April 2004}
@@ -289,7 +289,17 @@ document, it is given first in Tcl/Tk idiom and then in Perl/Tk idiom.
This document is also referenced as CENA technical note NT03-532.
-\section{Differences with previous version}
+\section{Differences with previous versions}
+
+\subsection{Differences between 3.2.99 and 3.2.97 release}
+This release has been mainly focused on producing a stable code
+base that compile and run on all three supported platforms with
+as little effort as possible. The next releases up to the final
+3.3 will share the same goals.
+
+The only functional change is the integration of the fieldbbox
+command into the bbox command.
+
\subsection{Differences between 3.2.97 and 3.2.6 release}
\begin{itemize}
@@ -350,40 +360,6 @@ and ``fillrule''. Many Perl/Tk demos have been ported to Tcl/Tk.
format documentation has been enhanced.
\end{itemize}
-\subsection{Differences between 3.2.6 and 3.2.4 release}
-\begin{itemize}
-\item many bug corrections, of course!
-\item this documentation has been improved (changelog, new figures, completions)
-\item the contour command can return the contour number
-\item the ZincDebug.pm Perl module has been fairly augmented
-\item the find command may return item ancestor(s)
-\item the TkZinc command may return the version number
-\item icom items may be scaled and rotated (needs openGL)
-\item anti-overlapping of tracks labels works again
-\item tsave can now be used to know if a named transform is already defined
-\item gname can now be used to know if a named gradient is already defined
-\item new tags can now be used : ``pathTags'' to go through groups.
-\item find and addtag commands have been modified to be ``pathTag'' compliant
-\item the clone command only clone one item when using a tag.
-\item all items have now a -composealpha option
-\item it is again an error to configure an unexisting option of an item
-\item all items can now get the keyboard focus; thus focus and 'select item' return a list of two elements.
-\item new tagged index (bol, eol, bow, eow, up, down) for text items and labels of track, waypoint and tabular
-\end{itemize}
-
-\subsection{Differences between 3.2.4 and 3.2.2 release}
-\begin{itemize}
-\item many bug corrections, of course!
-\item TkZinc can now use openGL capablities
-\item many new item options (due to openGL capablilites) and a new triangles item
-\item a new Perl module : ZincDebug.pm to interactively browse the item hierarchy
-\item as color are all gradient (with alpha transparency) the -alpha option has been removed
-\item a set of TkZinc demontrations are available with the zinc-demos command
-\item many new explanations in this doc: groups, item ids and tags ...
-\item the postscript version of this doc has been replaced by a pdf version
-\item configuring an unexisting option of an item is no more an error (this was a design mistake)
-\item a Perl module ZincText.pm make it easier to implement text input
-\end{itemize}
\section{Where can I find TkZinc and documentation ?}
@@ -1504,7 +1480,7 @@ In this chapter, we first list all commands by categories, then we details each
\cmdref{coords} \cmdref{gettags} \cmdref{group} \cmdref{itemcget} \cmdref{itemconfigure}
\item{Accessing field attributes of track, waypoint and tabular} : \cmdref{currentpart}
-\cmdref{hasfields} \cmdref{fieldbbox} \cmdref{itemcget} \cmdref{itemconfigure} \cmdref{numparts}
+\cmdref{hasfields} \cmdref{itemcget} \cmdref{itemconfigure} \cmdref{numparts}
\item{Transformations} : \cmdref{coords} \cmdref{rotate} \cmdref{scale} \cmdref{skew} \cmdref{tapply}
\cmdref{tcompose} \cmdref{tdelete} \cmdref{tget} \cmdref{transform} \cmdref{translate} \cmdref{treset}
@@ -1521,7 +1497,7 @@ In this chapter, we first list all commands by categories, then we details each
\item{Bindings} : \cmdref{bind} \cmdref{focus}
\item{Coordinates} : \cmdref{anchorxy} \cmdref{bbox} \cmdref{coords} \cmdref{contour}
-\cmdref{fieldbbox} \cmdref{fit} \cmdref{hasanchor} \cmdref{smooth} \cmdref{transform} \cmdref{vertexat}
+\cmdref{fit} \cmdref{hasanchor} \cmdref{smooth} \cmdref{transform} \cmdref{vertexat}
\item{Named resources} : \cmdref{gname} \cmdref{gdelete} \cmdref{tsave}
@@ -1770,16 +1746,21 @@ reference) and all list parameters are given as array references.
\end{blockindent}
-\zinccmd{bbox}{tagOrId ?tagOrId ...?}
+\zinccmd{bbox}{?-field fieldNo? ?-label? tagOrId ?tagOrId ...?}
-{\tt\large (\$xo, \$yo, \$xc, \$yc) = \$zinc->{\bf bbox}(tagOrId, ?tagOrId ...?);}
+{\tt\large (\$xo, \$yo, \$xc, \$yc) = \\
+\$zinc->{\bf bbox}(?-field fieldNo? ?-label? tagOrId, ?tagOrId ...?);}
\begin{blockindent}
Returns a list of 4 numbers describing the \emph{window coordinates} of the origin
and corner of a rectangle bounding all the items named by the {\tt tagOrId}
arguments.
- If no items are named by {\tt tagOrId} or if the matching items
- have an empty bounding box, an empty string is returned.
+ If no items are named by {\tt tagOrId} or if the matching items have an empty bounding
+ box, an empty string is returned.
+ The {\tt -field} and {\tt -label} options can be used to query the bounding box
+ of an item's field or an item's label. These two options are mutually exclusives.
+ When one of these options is specified, the bbox command is applied t o the first
+ item selected by the tagOrId arguments.
\end{blockindent}
@@ -2141,22 +2122,6 @@ false.
\end{blockindent}
-\zinccmd{fieldbbox}{tagOrId fieldIndex}
-
-{\tt\large (\$xo, \$yo, \$xc, \$yc) = \$zinc->{\bf fieldbbox}(tagOrId, fieldIndex);}
-
-\begin{blockindent}
- Returns a list of 4 numbers describing the \emph{window coordinates} of the origin
- and corner of a rectangle bounding the item field indexed by {\tt fieldIndex}
- of the item named by the {\tt tagOrId} argument. If a tag is used the
- first matching item is used. If no item is named by {\tt tagOrId} or
- if the matching item field have an empty bounding box, an empty string is returned.
- If {\tt fieldIndex} is ``label'' the bounding box of the label itself is returned.
- If the item does not support fields an empty
- string is returned.
-\end{blockindent}
-
-
\zinccmd{find}{searchCommand ?arg arg ...?}
{\tt\large @items = \$zinc->{\bf find}(searchCommand, ?arg?, ...);}