path: root/doc/refman.tex

\documentclass[11pt,twoside]{book}

\newif\ifpdf
\ifx\pdfoutput\undefined
    \pdffalse           % we are not running PDFLaTeX
\else
    \pdfoutput=1        % we are running PDFLaTeX
    \pdftrue
\fi
%----------------------------------------------------------------------

\ifpdf
    \usepackage[pdftex,
        colorlinks=true,
        urlcolor=rltblue,
        anchorcolor=rltbrightblue,
        filecolor=rltgreen,
        linkcolor=rltred,
        menucolor=webdarkblue,
        citecolor=webbrightgreen,
        pdftitle={Zinc, an advanced scriptable Canvas.},
        pdfauthor={Patrick Lecoanet, Centre d'étude de la Navigation Aérienne},
        pdfsubject={The 3.2 Reference Manual.},
        pdfkeywords={tk tcl perl x11 canvas opengl script gui zinc},
        pagebackref,
        pdfpagemode=None,
        bookmarksopen=true
        ]{hyperref}
        \pdfcompresslevel=9
        \usepackage[pdftex]{graphicx}
        \usepackage{thumbpdf}
\else
    \usepackage{graphicx}
    \usepackage{html}
\fi
\usepackage{a4wide}
\usepackage{makeidx}
\usepackage{color}
\definecolor{rltred}{rgb}{0.75,0,0.20}
\definecolor{rltgreen}{rgb}{0,0.5,0}
\definecolor{rltblue}{rgb}{0,0,0.75}

\newcommand{\cident}[1] {%
  {\tt #1}}

\newcommand{\code}[1] {%
  {\tt #1}}

\newcommand{\ident}[1] {%
  {\tt\large #1}}

\newenvironment{blockindent}{\begin{quotation}}{\end{quotation}\vspace{\parskip}}

\newcommand{\option}[3]{%
  \label{opt:#1}
  \index{#1}
  \ifpdf
  \hyperdef{opt}{#1}{}
  \else
  \htmlrule[WIDTH="300" left]
  \fi
  \begin{tabular}{rl}
    Command line switch: & \ident{-#1} \\
    Database name: & \ident{#2} \\
    Database class: & \ident{#3} \\
  \end{tabular}}

\newcommand{\command}[3]{%
  \label{cmd:#2}
  \index{#2}
  \ifpdf
  \hyperdef{cmd}{#2}{}
  \else
  \htmlrule[WIDTH="300" left]
  \fi
  {\tt\large #1 {\bf #2} #3}}

\newcommand{\zinccmd}[2]{%
  \command{pathname}{#1}{#2}}

\newcommand{\mapinfocmd}[3]{%
  \label{mpcmd:#2}
  \index{#2}
  \ifpdf
  \hyperdef{mapcmd}{#2}{}
  \else
  \htmlrule[WIDTH="300" left]
  \fi
  {\tt\large mapinfo #1 {\bf #2} #3}\\
  {\tt\large \$zinc->mapinfo(#1, {\bf #2}, #3) }
  % slightly buggy XXX : missing commas when #3 contains many words
}

\newcommand{\attrtype}[1]{%
  \label{attrtype:#1}
  \index{#1}
  \ifpdf
  \hyperdef{attrtype}{#1}{}
  \else
  \htmlrule[WIDTH="300" left]
  \fi
  {\tt {\bf #1}}
  \vspace{-2\parskip}}

\newcommand{\available}[1]{%
  \ifpdf
  \hyperlink{obj.#1}{\ident{#1}}
  \else
  \hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{obj:#1}
  \fi
  }

\newcommand{\refopt}[1]{%
  \ifpdf
  \hyperlink{opt.#1}{\ident{#1}}
  \else
  \hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{opt:#1}
  \fi
  }

\newcommand{\cmdref}[1]{%
  \index{#1}
  \ifpdf
  \hyperlink{cmd.#1}{\ident{#1}}
  \else
  \hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{cmd:#1}
  \fi
  }

\newcommand{\attribute}[3]{%
  \label{attribute:#1}
  \ident{-#1 }%
  \ifpdf%
  \hyperlink{attrtype.#2}{\ident{#2}}
  \else%
  \hyperref[no]{\tt \bf #2}{\ident{#2}}{attrtype:#2}%
  \fi%
  \begin{quotation}#3\end{quotation}
  }

\newcommand{\attributeref}[1]{%
  \ifpdf%
  \hyperlink{attribute.#1}{\ident{-#1}}
  \else%
  \hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{attribute:#1}
  \fi%
  }

\newcommand{\object}[1]{%
  \label{obj:#1}
  \ifpdf
  \hyperdef{obj}{#1}{}
  \fi  
  }

\newcommand{\concept}[1]{%
  \label{concept:#1}
  \ifpdf
  \hyperdef{concept}{#1}{}
  \fi  
  }

\newcommand{\objectref}[1]{%
  \ifpdf
  \hyperlink{obj.#1}{\ident{#1}}
  \else
  \hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{obj:#1}
  \fi
  }

\newcommand{\conceptref}[2]{%
  \ifpdf
  \hyperlink{concept.#2}{\ident{#1}}
  \else
  \hyperref[page]{#1}{#1 (page }{)}{concept:#2}
  \fi
  }



\makeindex

\parindent 0cm
\parskip 0.2cm

\title{Zinc, an advanced scriptable Canvas.\\The 3.2 Reference Manual.}
\author{Patrick Lecoanet}
\date{8 March 2002}


\begin{document}

\DeclareGraphicsExtensions{.png,.ps,.eps,.pdf}

\maketitle

\tableofcontents

\concept{introduction}
\chapter{Introduction}

\section{What is this document about?}

This reference manual describes the Tk \ident{zinc} widget interface. It shows
how to create and configure a \ident{zinc} widget, and how to use the commands
it provides to create and manipulate items. As the \ident{zinc} widget is very similar
to the Tk canvas widget, this document is structured in a very similar way. The next chapter
\conceptref{Widget options}{options} describes how to create a new widget and which options
and resources are available. The chapter \conceptref{Groups, Display List and Transformations}{coordinates}
describes the use of groups and coordinates transformations. The chapter
\conceptref{Item IDs and Tags}{tagOrId} describes the Items ID as well as tags and some special
tags. It also describes the notion of field tags used with some items (\objectref{track},
\objectref{waypoint}, \objectref{tabular}) and the notion of partNames for items \objectref{track} and
\objectref{waypoint}. Then the chapter \conceptref{Indices}{indices} describes the use of indices XXX.
The important {\bf chapter \conceptref{Widget commands}{commands}} describes the 50 commands which
apply to a  \ident{zinc} widget. They are used for
creating, modifying or deleting objects, applying transformation... The chapter
\conceptref{Attributes Types}{types} describes the type of all attributes (or options)
available for the items described in the important {\bf chapter \conceptref{Item types}{items}}.
The chapter \conceptref{Labels, fields and label}{labelsandfields} describes the use of labels,
the possible attributes of label fields and finally the labelformat syntax. The chapter
\conceptref{The mapinfo commands}{mapinfocmds} describes the use of mapinfo, a kind of
simple map, which can be build by commands listed in this chapter. The chapter
\conceptref{The videomap commands}{videomapcmds} describes the use of videomap,
a proprietary format of simple map file used in french Air Traffic Control Centres.
Finally the chapter \conceptref{Other resources provided by the widget}{otherresources}
describes some resources provided by \ident{zinc}.

\section{What is \ident{zinc}?}

\ident{Zinc} widgets are very similar to Tk \ident{canvas}es in that they support
structured graphics. Like the \ident{canvas}, \ident{zinc} implements items used to
display graphical entities. Those items can be manipulated and bindings can be
associated with them to implement interaction behaviors. But unlike the \ident{canvas},
\ident{zinc} can structure the items in a hierarchy (with the use of group items),
has support for affine 2D transforms (i.e. translation, scaling, and rotation),
clipping can be set for sub-trees of the item hierarchy and the item
set is quite more powerful including field specific items for Air Traffic systems.

Since the 3.2.3 version, \ident{zinc} also offers the support of some openGL
features such as transparency, color gradient and even a new item type : \objectref{triangles}.
You need the support of the GLX extension on your X11 server. Of course, performances
will be dependant of your graphic card. At time of writing, NVidia drivers
for XFree86 R4.1 are doing a nice job. A laptop with an ATI mobility graphic card works nice.
We also succeded in using zinc with openGL on the Exceed X11 server
(running on windows and developped by Hummingbird) with the 3D extension.

As an exemple of \ident{zinc} capabilities when combined with openGL, we reproduced in
 \ident{ZincLogo.pm} a perl module, the tk Zinc logo. This logo (see just below) was designed
 with Illustrator (from Adobe) and then programmed as a perl module. It is now delivered
 as a \ident{zinc} goodies.

\ifpdf
  \includegraphics{tkzinclogo}
\else
\latexhtml{
  \htmladdimg{tkzinclogo.png}
  }
\fi

\ifpdf
\begin{figure}[htbp]            
\centering
\includegraphics{tkzinclogo}    
\caption{Logo Zinc written as a Perl/zinc module}
\label{fig:logozinc}
\end{figure}
\else
\latexhtml{
  \htmladdimg{tkzinclogo.png}
  }
\fi



The \ident{zinc} widget is available for the Tcl/Tk and the Perl/Tk environment.
A binding over Tcl/Tk is also provided for Python. This document is Tcl/Tk and Perl/Tk
oriented but it should be easy for Python programmers to adapt. Every time a
\ident{zinc} command is described in this document, it is given first in Tcl/Tk
idiom and then in Perl/Tk idiom.

\section{Where can I find zinc and documentation?}

\ident{Zinc} is available at http://www.openatc.org/zinc or
http://freshmeat.net/projects/zincisnotcanvas/. The software is available as
tar.gz files and as Debian or RedHat/Mandrake packages.

For people from CENA, its possible to get the zinc source code through
a private CVS server. Please contact directly lecoanet@cena.fr for mùore informations.

This documentation is available as a part of the \ident{zinc} software.
It is also available apart on those web sites. The source of
this document is \ident{latex}, and its current format
is either html pages or a pdf file.

As a complement to this ``Reference Manual'', small Perl/Tk demos
of \ident{zinc} are also available
through a small application named \ident{zinc-demos}, highly inspired
from the ``widget'' application included in Perl/Tk. The aims of these
demos are both to demonstrates the power of \ident{zinc} and to help
newcomers starting using \ident{zinc} with small examples.

\section{Copyright and Licence}

\ident{zinc} has been developed by the CENA (Centres d'Etudes de la Navigation
Aérienne) for its own needs in advanced HMI (Human Machine Interfaces or Interactions).
Because we are confident in the benefit of free software, the CENA delivered this
toolkit under the GNU Library General Public License.

This code is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.

This code is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Library General Public License for more details.

You should have received a copy of the GNU Library General Public
License along with this code; if not, write to the Free
Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
MA 02111-1307, USA.

\section{Authors and credits}

\ident{Zinc} has been developed by Patrick Lecoanet. He also developed two
previous version called ``Radar Widget'' which share some caracteristics of
this version. The ``Radar Widget'' was heavily used at CENA for many projects
over nearly 10 years. The release 2 is still in used. It was even enhanced
and then used for Radar Images in two main Air Traffic Control Centres in
France 24 hours a day. Dominique Ruiz, Frederic Lepied, and Didier Pavet
helped a lot in the developement of \ident{zinc} and its previous versions.
\ident{Zinc} also benefits from many discussions with Jean-Luc Vinot. Jean-Luc
has a background of Graphic Designer and is now an HMI developer at CENA. He
envisions many, many new ideas for advanced HMI. Many of them could never or
hardly be implemented without \ident{zinc}. And \ident{zinc} would have been
less interesting without his ideas. Didier Pavet and his team as well as Daniel
Etienne and Herve Damiano were first users and cope with Patrick either by
reporting bugs, problems or solutions. Thanks to all these people and to the
CENA for supporting this work.

The core of this documentation has been written by  Patrick Lecoanet,
the main author of \ident{zinc}. This documentation has been enriched
and by Christophe Mertz.

\section{How may I contribute to zinc development}

If you think \ident{zinc} is an interesting tool, they are many ways to contribute
in \ident{zinc} development. We are managing a mailing list. To subscribe, please
consult the web site http://www.openatc.org/Zinc/ .

\begin{itemize}
\item The very first way to contribute is to use \ident{zinc} and to report any bug or
problem you may experiment. Of course, if you propose a correction or a patch, your
report will be easer to take into account.
\item The second way to contribute is by commenting and proposing enhancement to this
reference manual. As it has been written by french native writers, native english
writers may really help in making this document easier to read. If you really
feel ambitious, you may even try to write a tutorial, but that is a real challenge!
\item The third way to contribute (and may be the funniest way) is to enriche the set
of small demos (see chapter \conceptref{Other resources provided by the widget}{otherresources}).
Feel free to send us your productions. They may be simple but demonstrative or more complex.
It is up to you! They will be integrated in the next release of \ident{zinc} if they are
worth it.
\end{itemize}


\concept{options}
\chapter{Widget options}

The \ident{zinc} command creates a new \ident{zinc} widget, the general form is
\begin{quotation}
  {\tt\large zinc pathname ?options?}\\
  {\tt\large \$mainwindow->{\bf zinc}(?option=>value?, ..., ?option=>value?);}
\end{quotation}

{\tt pathname} name the new widget and specifies where in the widget hierarchy
it will be located. Any number of options may be specified on the command line
or in the option database to modify the global behavior of the widget. Available
options are described below in this chapter.

Any new \ident{zinc} widget comes with an initial group, always identified by
the id 1. This group will contain all other items, either directly or
indirectly through other groups created themselves (directly or in other groups... )
in group 1. The chapter \conceptref{Groups, Display List and Transformations}{coordinates}
describes the use of groups)


\option{borderwidth}{borderWidth}{BorderWidth}
\begin{blockindent}
  Specifies the width of the 3d border that should be displayed around the widget
  window. This border does not overlap the active zinc display area. The area
  requested from the geometry manager (or the window manager if applicable)
  is the overall area, display area plus borders. This value can be given
  in any of the forms valid for coordinates (See \cident{TkGet\_Pixels}).
  The default value is 2.
\end{blockindent}

\option{backcolor}{backColor}{BackColor}
\begin{blockindent}
  This is the color that will be used to fill the zinc window. It is also
  used as a default color for some item attributes of type color. See each
  color attribute for the actual source of the default color. Its default
  value is white.
\end{blockindent}

\option{cursor}{cursor}{Cursor}
\begin{blockindent}
  Specifies the cursor to use when the pointer is in the zinc window.
  The default value is set to preserve the cursor provided at widget
  creation.
\end{blockindent}

\option{font}{font}{Font}
\begin{blockindent}
  The font specified by this option is used as a default font
  for item attributes of type font. Its default value is
  -adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*.
\end{blockindent}

\option{forecolor}{foreColor}{ForeColor}
\begin{blockindent}
  The color specified by this option is used as a default color
  for many item attributes of type color. See each each color
  attribute for the actual source of the default color. Its
  default value is black.
\end{blockindent}

\option{fullreshape}{fullReshape}{FullReshape}
\begin{blockindent}
  If this option is True, the shape applied to the zinc window will
  propagate up the window hierarchy to the top level window. The
  result will be a shaped top level. See also the \refopt{reshape} option,
  it controls whether a shape is applied to the zinc window or not.
  The default is True.
\end{blockindent}

\option{height}{height}{Height}
\begin{blockindent}
  Specifies the height of the actual zinc area (i.e, this dimension
  does not include the border width). This value can be given in any of
  the forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is
  100 pixels.
\end{blockindent}

\option{highlightbackground}{highlightBackground}{HighlightBackground}
\begin{blockindent}
  Specifies the color to display in the traversal highlight region when the
  widget does not have the input focus. The default value is \#c3c3c3.
\end{blockindent}

\option{highlightcolor}{highlightColor}{HighlightColor}
\begin{blockindent}
  Specifies the color to use for the traversal highlight rectangle that is
  drawn around the widget when it has the input focus. The default value
  is Black.
\end{blockindent}

\option{highlightthickness}{highlightThickness}{HighlightThickness}
\begin{blockindent}
  Specifies a non-negative value indicating the width of the highlight
  rectangle drawn around the outside of the widget when it has the input
  focus. The value may have any of the forms acceptable to \cident{Tk\_GetPixels}.
  If the value is zero, no focus highlight is drawn around the widget.
  The default value is 2.
\end{blockindent}

\option{insertbackground}{insertBackground}{InsertBackground}
\begin{blockindent}
  Specifies the color to use as background in the area covered by the
  insertion cursor. This color will normally override either the normal
  background for the widget (or the selection background if the insertion
  cursor happens to fall in the selection). The default value is Black.
\end{blockindent}

\option{insertofftime}{insertOffTime}{InsertOffTime}
\begin{blockindent}
  Specifies a non-negative integer value indicating the number of
  milliseconds the insertion cursor should remain off in each blink cycle.
  If this option is zero then the cursor is on all the time. The
  default value is 300.
\end{blockindent}

\option{insertontime}{insertOnTime}{InsertOnTime}
\begin{blockindent}
  Specifies a non-negative integer value indicating the number of
  milliseconds the insertion cursor should remain on in each blink cycle.
  The default value is 600.
\end{blockindent}

\option{insertwidth}{insertWidth}{InsertWidth}
\begin{blockindent}
  Specifies a value indicating the width of the insertion cursor.
  The value may have any of the forms acceptable to \cident{Tk\_GetPixels}.
  The default value is 2.
\end{blockindent}

\option{mapdistancesymbol}{mapDistanceSymbol}{MapDistanceSymbol}
\begin{blockindent}
  This option specifies the symbol to be used as a milestone
  along map lines. This option can be given any Tk bitmap which
  can be obtained by \cident{Tk\_GetBitmap}. The spacing between markers is
  10 nautic miles. The default value is AtcSymbol19
  (see \conceptref{Resources}{otherresources}).
\end{blockindent}

\option{maptextfont}{mapTextFont}{MapTextFont}
\begin{blockindent}
  Specifies the font used to draw the texts contained in maps. The
  default is -adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*.
\end{blockindent}

\option{overlapmanager}{overlapManager}{OverlapManager}
\begin{blockindent}
  This option accepts an item id. It specifies if the label overlapping
  avoidance algorithm should be allowed to do its work on the track labels
  and which group should be considered to look for tracks. The default
  is to enable the avoidance algorithm in the top group (id 1).
\end{blockindent}

\option{pickaperture}{pickAperture}{PickAperture}
\begin{blockindent}
  Specifies the size of an area around the pointer that is used to tell
  if the pointer is inside an item. This is useful to lessen the precision
  required when picking graphical elements. This value must be a positive
  integer. It defaults to 1.
\end{blockindent}

\option{relief}{relief}{Relief}
\begin{blockindent}
  Specifies the border relief. This option can be given any legal value
  for a relief (See \cident{Tk\_GetRelief} for a description of possible values).
\end{blockindent}

\option{render}{render}{render}
\begin{blockindent}
  Specifies whether to use or not the openGL rendering. When True, requires
  the GLX extension to the X server. Must be defined at widget creation time.
  This option is readonly and can be used to ask if the widget is running
  GLX or X (to adapt the application code for example).
  The default value is False.
\end{blockindent}

\option{reshape}{reshape}{Reshape}
\begin{blockindent}
  Specifies if the clipping shape that can be set in the top group item
  should clip the top group children or be used to reshape the zinc
  window. This option can be used with the fullreshape option to reshape
  the toplevel window as well. The default value is True.
\end{blockindent}

\option{selectbackground}{selectBackground}{SelectBackground}
\begin{blockindent}
  Specifies the background color to use for displaying the selection
  in text items. The default value is \#a0a0a0.
\end{blockindent}

\option{speedvectorlength}{speedVectorLength}{SpeedVectorLength}
\begin{blockindent}
  Specifies the duration of track speed vectors. This option is expressed
  using a time unit that should be chosen by the application (often minutes)
  and kept coherent with the unit of the track attribute \ident{speedvector}
  (often nautic mile / minutes). The default value is 3.
\end{blockindent}

\option{takefocus}{takeFocus}{TakeFocus}
\begin{blockindent}
  (From the Tk options manpage).
  
  Determines whether the window accepts the focus during keyboard traversal
  (e.g., Tab and Shift-Tab). Before setting the focus to a window, the
  traversal scripts consult the value of the takeFocus option. A value of 0
  means that the window should be skipped entirely during keyboard traversal.
  1 means that the window should receive the input focus as long as it is
  viewable (it and all of its ancestors are mapped). An empty value for the
  option means that the traversal scripts make the decision about whether or
  not to focus on the window: the current algorithm is to skip the window if
  it is disabled, if it has no key bindings, or if it is not viewable. If the
  value has any other form, then the traversal scripts take the value, append
  the name of the window to it (with a separator space), and evaluate the
  resulting string as a Tcl script. The script must return 0, 1, or an empty
  string: a 0 or 1 value specifies whether the window will receive the input
  focus, and an empty string results in the default decision described above.
  Note: this interpretation of the option is defined entirely by the Tcl scripts
  that implement traversal: the widget implementations ignore the option
  entirely, so you can change its meaning if you redefine the keyboard traversal
  scripts. The default value is empty.
\end{blockindent}

\option{tile}{tile}{Tile}
\begin{blockindent}
  Specifies an image name to be used as a tile for painting the zinc window
  background. The default value is none (the empty string).
\end{blockindent}

\option{trackmanagedhistorysize}{trackManagedHistorySize}{TrackManagedHistorySize}
\begin{blockindent}
  This option accepts only positive integers. It specifies the size of
  the past position list that can be maintained by the track items. See
  also the \refopt{trackmanagehistory} option and the \ident{visiblehistorysize}
  track attribute. The default value is 6.
\end{blockindent}


\option{trackmanagehistory}{trackManageHistory}{TrackManageHistory}
\begin{blockindent}
  This option accepts any form valid for a boolean. It specifies if
  the track items should maintain a list of their past positions to be
  displayed as trailing speckles. If this option is turned off and then
  back on, the history list is erased and the collection is resumed at
  the next available position. The number of position collected in the
  history list is specified by the option \refopt{trackmanagedhistorysize}.
  When this many positions are collected, the oldest is dropped to make
  room for the new one on a first in first out basis. The number of past
  positions actually displayed if specified for each track by the
  attribute \ident{visiblehistorysize}.
  The default is to enable the history collection.
\end{blockindent}


\option{width}{width}{Width}
\begin{blockindent}
  Specifies the width of the actual zinc area (i.e, this dimension
  does not include the border width). This value can be given in any of
  the forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is
  100 pixels.
\end{blockindent}


\concept{coordinates}
\chapter{Groups, Display List and Transformations}

Groups items are very powerful objects in \ident{zinc}. They have many uses in
\ident{zinc} and we will describe them in this chapter. The main usages are:
\itemize
\item to apply them transformation (translation, rotation or scaling)
\item appl

\section{The root group 1}
When creating an other item
(such as an \objectref{track}, a \objectref{rectangle}, or a \objectref{curve}) it is
always put inside a group. Only the root group, the group 1, is not explicitly created
in a group; in fact it is created jointly with the \ident{zinc} widget, and by convention,
the group of group 1 is in the group 1 itself. It is not possible to change the
group of the root group 1.

\section{Priority and display list}

Groups and the items  \ident{-priority} attributes are sued together for ordering the order
in which objects are displayed. The algorithm is the following :
\begin{itemize}
\item{rule 1} The drawing starts from the root group 1
\item{rule 2} Inside a group, items with the lowest priority are drawn
  below those with the highest priority.
\item{rule 3} Inside a group, when items have the same priority, the items are
  displayed according to their creation order (first created are below last created)
\item{rule 4} If one of the item of group A is a group B, every items inside the group B are displayed
 according to the rules 2 and 3 during the display of the group B.
 That means that a group is always entirely drawn before treating a sibling (having priority).
\end{itemize}

To change the priority of an item you can use the following commands: \cmdref{raise}, \cmdref{lower}, or \cmdref{itemconfigure} with the attribute \ident{-priority}.

\section{Transformation and groups}

Items grouped together inside a same group can be transformed together. By translating a group
you translate every items contained in this group. This also apply to items included in sub-groups
of the translated group. In fact the transformation is recursively applied to all children of
the transformated group.

However, every object have the attributes \ident{-composescale} and \ident{-composerotation}. These attributes
are defaulted to \ident{true}. If set to \ident{false} a transformation (respectively a \cmdref{scale} and \cmdref{rotate} to its group will not be applied to the item.

For converting coordinates between two coordinates systems, (i.e. between two groups) you must use the \cmdref{transform} command. For being able to convert to/from the device coordinate, the only way to proceed is to use the \cmdref{transform} comman to/from a group having the same coordinate system as the device coordinate. That is why {\bf it is highly recommended not to apply transforms to the root group 1}. This garantee that the coordinate system of group 1 is always equivalent to the device coordinates (except for a translation depending on the toplevel window position).

\section{Attributes propagated to the group children}

The following attributes are propagated to the group children:
\begin{itemize}
\item\ident{-sensitive} : the sensitivity (to keyboards or mouse event) can be set at the group level,
\item\ident{-visible} : the visibility  can be set at the group level,
\item\ident{-alpha} : the alphablending (i.e. the transparency) can be set at the group level. However this will work only if the \ident{zinc} widget support the openGL rendering.
\end{itemize}

\section{Clipping and groups}

All the items inside a group can be clipped with one of the item (the ``clipper'') of the group. The clipper item must be of the following type: \objectref{rectangle}, \objectref{curve}, \objectref{bezier}, \objectref{arc}. XXX TBC! As items \objectref{curve} can have multiple contours (i.e. with hole(s) or made of disjoint parts) this allows the design of some objects very trickky or weird to implement with other widgets or toolkits.   

\section{Other functions related to groups}

A group may be \attributeref{atomic}. This means that the group will catch and treat events normally caught by the group children. The typical use is for binding the same callbacks to many items composing a group. As \attributeref{atomic} is an attribute, it may be modified dynamically, thus modifying the group comportment.

A group may be cloned with the \cmdref{clone} command. This will clone the group and all its children.

Finally, a group may be deleted as a whole with the \cmdref{remove} command. However, it is also possible to delete only a child, by applying the \cmdref{remove} command directly to the child.


\concept{tagOrId}
\chapter{Item IDs and Tags}

id
tag all
tag current
tags speciaux dans les items textes
tags
tags dans bind (syntaxe pour spécifier les parties et les champs).

Décrire les ids, tags, fieldIds et partNames. Les deux derniers
n'étant employes que par bind doit-on les décrire ici ou dans la commande ?
Parler de current, all.


\concept{indices}
\chapter{Indices}

XXX c'est quoi? Voir la commande index.

\concept{commands}
\chapter{Widget commands}

The available commands are listed in alphabetical order.

The command set for the \ident{zinc} widget is much inspired by the \ident{canvas}
command set. Someone comfortable with the \ident{canvas} should not have much trouble
using the \ident{zinc}'s commands. Eventually, the command set will be a superset
of the \ident{canvas} command set.

In the perl/tk version, the commands returning a list, return a perl array (not a
reference) and all list parameters are given as array references.

\vspace{.5cm}
\zinccmd{add}{?type group? ?initargs? ?option value? ... ?option? value?}

{\tt\large @types = \$zinc->{\bf add}();}\\
{\tt\large \$id = \$zinc->{\bf add}(type, group);}\\
{\tt\large \$id = \$zinc->{\bf add}(type, group, initargs);}\\
{\tt\large \$id = \$zinc->{\bf add}(type, group, initargs, option=>value, ..., ?option=>value?);}

\begin{blockindent}
  This command is used to create new items in a zinc widget. It can be called with
  no parameters to return the list of all item types currently known by
  the zinc widget. It can also be called with a valid item type as first
  parameter and a group item as second parameter to create a new item of this
  type in the given group.

  After these first two parameters come some item type specific arguments.
  Here is detailed description of these arguments by type:
  \begin{description}
  \item{\bf arc} \\
    The arc type expects a list of four floating point numbers ``xo yo xc yc'',
    giving the coordinates of the origin and the corner of the enclosing rectangle.
    The origin should be the top left vertex of the enclosing rectangle and the
    corner the bottom right vertex of the rectangle.
  \item{\bf bezier} \\
    The bezier type expects a list of floating point numbers ``x0 y0 x1 y1 ... xn yn'',
    giving the coordinates of the bezier segment controls. The number of values
    should be pair (or the last value will be discarded), and there should be at
    least two control points. The segments are built as follow: if there is at
    least four points, they are used as the four controls of a cubic Bezier. Then,
    if more than four points are provided , the first three are discarded and
    the process is restarted using as first control the last control of the previous
    segment. The process is repeated until there is less than four points left.
    If three points are left, a segment is drawn using the second point for the
    two off-curve controls. If two points are left, a line segment is drawn
    between the two.
  \item{\bf curve} \\
    The curve type expects a list of floating point numbers ``x0 y0 x1 y1 ... xn yn'',
    giving the coordinates of the curve vertices. The number of values should be
    pair (or the last value will be discarded) but the list can be empty to build
    an empty invisible curve. This curve can be defined later with the \cmdref{contour}
    or \cmdref{coords} commands. As a side effect of the curve behavior, a one vertex
    curve is essentially the same as an empty curve, it only waste some more memory.
  \item{\bf rectangle} \\
    The rectangle type expects a list of four floating point numbers ``xo yo xc yc'',
    giving the coordinates of the origin and the corner of the rectangle.
  \item{\bf triangles} \\
    The triangles type expects a list of (at least 6) floating point numbers ``x0 y0 x1 y1 ... xn yn'',
    giving the coordinates of the vertices of the triangles composing this item. The triangles layout
    is defined by the attribute \ident{fan}. If \ident{fan} is true, the triangles are arranged in
    a fan with the first point being the center and the other points defining the perimeter.
    If \ident{fan} is false, the triangles are arranged in a strip. (Afficher un diagramme avec l'ordre
    des sommets).
  \item{\bf tabular, track, waypoint} \\
    These types expects the number of fields they will manage in the label or
    tabular form. This number must be greater or equal to zero.
  \item{\bf group, icon, map, reticle, text, window} \\
    These types doesn't expect type specific arguments.
  \end{description}
  
  Following the creation args the command accept any number of
  attributes\ -\ values pairs to configure the newly created item.
  All the configurable item type attributes are valid in this context. The
  command returns the item id.
\end{blockindent}

\zinccmd{addtag}{tag searchSpec ?arg arg ...?}

{\tt\large \$zinc->{\bf addtag}(tag, searchSpec);}

\begin{blockindent}
  This command add the given tag to all items matching the
  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.

  Many commands take a group as a starting point for the search. If no
  group is given, the top group is assumed. In any cases, the starting
  group will not be reported in the search result. This means that the
  top group will never be reported in a search and that tags cannot be
  attached to it except in specifying its id.
  
  The search specification and the associated arguments can
  take the following forms:

  \begin{description}
  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag above tagOrId ?inGroup? ?recursive?\\
          \$zinc->{\bf addtag}(tag, 'above', tagOrId, ?inGroup?, ?recursive?);\\
        }}
    Selects the item just above the one given by {\tt tagOrId}. If
    {\tt tagOrId} names more than one item, the topmost of these
    items in the display list will be used. If {\tt tagOrId} does
    not refer to any item then nothing happen. The inGroup and
    recursive optional parameters can be specified to restrict the
    search with a tag matching several items. inGroup specifies a
    group to start with instead of the top group and recursive
    tells if the search should descend in the item tree or not.

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag all ?inGroup? ?recursive?\\
          \$zinc->{\bf addtag}(tag, 'all', tagOrId, ?inGroup?, ?recursive?);\\
        }}
    Selects all the items in the widget. The inGroup and
    recursive can be specified to restrict the search. inGroup specifies
    a group to start with instead of the top group and recursive tells
    if the search should descend in the item tree or not.

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag atpriority priority ?inGroup? ?recursive?\\
          \$zinc->{\bf addtag}(tag, 'atpriority', priority, ?inGroup?, ?recursive?);\\
        }}
    Selects all the items at the given priority. The inGroup and
    recursive can be specified to restrict the search. inGroup specifies
    a group to start with instead of the top group and recursive tells
    if the search should descend in the item tree or not.

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag below tagOrId ?inGroup? ?recursive?\\
          \$zinc->{\bf addtag}(tag, 'below', tagOrId, ?inGroup?, ?recursive?);\\
        }}
    Selects the item just below the one given by {\tt tagOrId}. If
    {\tt tagOrId} names more than one item, the lowest of these
    items in the display list will be used. If {\tt tagOrId} does
    not refer to any item then nothing happen. The inGroup and
    recursive optional parameters can be specified to restrict the
    search with a tag matching several items. inGroup specifies a
    group to start with instead of the top group and recursive
    tells if the search should descend in the item tree or not.

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag closest x y ?halo? ?startItem?\\
          \$zinc->{\bf addtag}(tag, 'closest', x, y, ?halo?, ?startItem?);\\
        }}
    Selects the item closest to the point {\tt x - y}. Any item overlapping
    the point is considered as closest and the topmost is selected. If {\tt halo}
    is given, it defines the size of the point {\tt x - y}. {\tt halo} must
    be a non negative integer. If {\tt start} is specified, it must be
    an item tag or id. If it names a valid item (for a tag, the lowest
    item with the tag is considered), the search starts with the item
    below {\tt start} instead of the first item in the display
    order. If {\tt startItem} does not name a valid item, it is ignored.

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag enclosed xo yo xc yc\\
          \$zinc->{\bf addtag}(tag, 'enclosed', xo, yo, xc, yc);\\
        }}
    Selects all the items completely enclosed in the rectangle whose
    origin is at {\tt xo - yo} and corner at {\tt xc - yc}. {\tt xc}
    must be no greater than {\tt xo} and {\tt yo} must be no greater
    than {\tt yc}. All coordinates must be integers.

    It may be necessary to update the zinc internal geometry with a call
    to {\tt update} if the current state is not stable (i.e before calling
    the main loop or in a callback after modifying the transform or doing
    something else affecting the geometry of items).

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag overlapping xo yo xc yc\\
          \$zinc->{\bf addtag}(tag, 'overlapping', xo, yo, xc, yc);\\
        }}
    Selects all the items that overlaps or are enclosed in the rectangle
    whose origin is at {\tt xo - yo} and corner at {\tt xc - yc}. {\tt xc}
    must be no greater than {\tt xo} and {\tt yo} must be no greater than
    {\tt yc}. All coordinates must be integers. See also the {\tt enclosed}
    variant above for a discussion on updating the geometry.    

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag withtag tagOrId ?inGroup? ?recursive?\\
          \$zinc->{\bf addtag}(tag, 'withtag', tagOrId, ?inGroup?, ?recursive?);\\
        }}
    Selects all the items given by {\tt tagOrId}. The inGroup and
    recursive can be specified to restrict the search. inGroup specifies
    a group to start with instead of the top group and recursive tells
    if the search should descend in the item tree or not.

  \item{\bigskip
        {\tt\large pathname {\bf addtag} tag withtype type ?inGroup? ?recursive?\\
          \$zinc->{\bf addtag}(tag, 'withtype', tagOrId, ?inGroup?, ?recursive?);\\
        }}
    Selects all the items of type {\tt type}. The inGroup and
    recursive can be specified to restrict the search. inGroup specifies
    a group to start with instead of the top group and recursive tells
    if the search should descend in the item tree or not.
  \end{description}
\end{blockindent}

\zinccmd{anchorxy}{tagOrId anchor}

{\tt\large @(\$x, \$y) = \$zinc->{\bf anchorxy}(tagOrId, anchor);}

\begin{blockindent}
  Returns the (device) coordinates of an item anchor. If no item is
  named by {\tt tagOrId} or if the item doesn't support anchors, an
  error is raised. If more than one item match {\tt tagOrId}, the topmost
  in display list order is used.
\end{blockindent}

\zinccmd{bbox}{tagOrId ?tagOrId ...?}

{\tt\large @(xo, yo, xc, yc) = \$zinc->{\bf bbox}(tagOrId, ?tagOrId, ...?);}

\begin{blockindent}
  Returns a list of 4 numbers describing the (device) 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 the {\tt tagOrId} or if the matching items
  have an empty bounding box, an empty string is returned.
\end{blockindent}

\zinccmd{becomes}{}

{\tt\large \$zinc->{\bf becomes}();}

\begin{blockindent}
  Not yet implemented.
\end{blockindent}

\zinccmd{bind}{tagOrId ?sequence? ?command?}

{\tt\large @bindings = \$zinc->{\bf bind}(tagOrId);}\\
{\tt\large @binding = \$zinc->{\bf bind}(tagOrId, sequence);}\\
{\tt\large \$zinc->{\bf bind}(tagOrId, sequence, '');}\\
{\tt\large \$zinc->{\bf bind}(tagOrId, sequence, command);}\\

\begin{blockindent}
  This command associates {\tt command} with the item tag, item id, part tag
  {\tt tagOrId}. If an event sequence matching {\tt sequence}
  occurs for an item, or an item part, the command will be invoked.
  If all parameters are specified a new binding 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 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}.
  
  This widget command is similar to the \ident{bind} command except that
  it operates on \ident{zinc} items instead of widgets. Another difference
  with the \ident{bind} command is that only mouse and keyboard related events
  can be specified (such as \ident{Enter}, \ident{Leave}, \ident{ButtonPress},
  \ident{ButtonRelease}, \ident{Motion}, \ident{KeyPress}, \ident{KeyRelease}).
  The \ident{bind} manual page is the most accurate place to look for a
  definition of {\tt sequence} and {\tt command} and for a general understanding
  of how the binding mecanism works.

  The handling of events in the widget is done with respect to the
  current item and when applicable the current item part (see
  \conceptref{Item IDs and tags}{tagOrId} for a discussion of the
  \ident{current} tag and the special tags used in bindings). \ident{Enter}
  and \ident{Leave} events are trigerred for an item when it becomes or cease
  to be the current item. Mouse related events are reported with respect to
  the current item. Keyboard related events are reported with respect to the
  focus item (which can be the current item or none).

  It is possible that several bindings match a particular event sequence.
  When this occurs, all matching bindings are triggered. The order of
  invocation is as follow: the binding associated with the tag \ident{all}
  is invoked first, followed by the bindings associated with the item tags
  in order, followed by followed bindings associated with the part tags if
  relevant, followed by the binding associated with the item id, followed
  by the binding associated with the item part if relevant.
  If there are more than one binding for a single tag, only the most
  specific is triggered.
  
  If bindings have been registered for the widget window using the
  \ident{bind} command, they are invoked in addition to bindings registered
  for the items using this widget command. The bindings for items will be
  invoked before the bindings for the window.
\end{blockindent}

\zinccmd{cget}{option}

{\tt\large \$val = \$zinc->{\bf cget}(option);}

\begin{blockindent}
  Returns the current value of the widget option given by {\tt option}.
  {\tt option} may be any of the options described in the
  chapter \conceptref{Widget options}{options}.
\end{blockindent}

\zinccmd{chggroup}{tagOrId group ?adjustTransform?}

{\tt\large \$zinc->{\bf chggroup}(tagOrId, group, ?adjustTransform.?);}

\begin{blockindent}
  Move the item described by {\tt tagOrId} in the group described
  by {\tt group}. If {\tt tagOrId} or {\tt group} describe more
  than one item, the first in display list order will be used.
  If {\tt adjustTransform} is specified, it will be interpreted
  as a boolean. A true value will lead to an adjustment of the
  item transform in order to maintain an identical display
  rendering of the item regardless of its new position in the
  display hierarchy. If {\tt adjustTransform} is omitted, it
  defaults to false.
\end{blockindent}

\zinccmd{clone}{tagOrId ?attr value ...?}

{\tt\large \$id = \$zinc->{\bf 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 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).
  No item id will be returned for items cloned in the hierarchy of
  cloned groups.

\end{blockindent}

\zinccmd{configure}{?option? ?value? ?option value ...?}

{\tt\large @options = \$zinc->{\bf configure}();}\\
{\tt\large @option = \$zinc->{\bf configure}(option);}\\
{\tt\large \$zinc->{\bf configure}(option=>value, ?option=>value, ...?);}

\begin{blockindent}
  Query or modify the options of the widget. If no {\tt option}
  is given, returns a list describing all the supported options in the
  standard format for Tk options (see the
  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 string.
\end{blockindent}

\zinccmd{contour}{tagOrId operatorSpec coordListOrTagOrId}

{\tt\large \$zinc->{\bf contour}(tagOrId, operatorSpec, coordListOrTagOrId);}

\begin{blockindent}
  Manipulate contours on items that can handle multiples geometric
  contours. Currently only curve items can do this.

  {\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.
  
  {\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 should be from one of these classes: arc, bezier curve,
  icon, rectangle, tabular, text, window. The external shape of
  the item will be used as the contour. If {\tt coordListOrTagOrId}
  describes more than one item, the first in display list order
  will be used.

  {\tt operator} specifies the operation that will be carried. This
  can be:
  
  \begin{description}
  \item{diff} Substract the given contour from the item contours
  \item{inter} Intersect the given contour and the item contours,
    replacing the original contours by the intersection.
  \item{union} Compute the union of the given contour and the
    item's contours, replacing the original contours by the union.
  \item{xor} Compute the exclusive or of the given contour and the
    item's contours, replacing the original contours by the result.
  \end{description}

  An error in generated if the items are not of a correct type or if
  the coordinate list is malformed.

  The order of the contours generated by the command is not easily
  predictable, as a result, it is not easy to use the coords command
  to edit those contours. Another side effect is the reordering of
  the contours vertices depending whether the contour is classified
  as an internal hole or as an external contour (externals are clockwise
  while holes are counter-clockwise). This is usually not
  a problem if the curve item is used to describe polygonal areas but
  can lead to unpredicted effects on real unclosed curves.
  
  \emph{NOTE: This command is available only when GPC support has been
    built in Zinc.}
\end{blockindent}

\zinccmd{coords}{tagOrId ?add/remove? ?contour? ?index? ?coordList?}

{\tt\large \$zinc->{\bf coords}(tagOrId, ?add/remove?, ?contour?, ?index?, ?coordList?);}

\begin{blockindent}
  Query or changes the coordinates of the item described by {\tt tagOrId}.
  If {\tt tagOrId} describes more than one item, the first in display
  list order is used. The optional {\tt contour} gives the contour, if
  available, that should be operated. The default contour is 0. The
  optional {\tt index} gives the vertex index that should be operated
  in the given contour. The optional {\tt coordList} is a list of one or
  more vertices described as X, Y floating point values that will be used
  to replace or add coordinates to the current contour.

  Almost all items can be manipulated by this command, the map item is
  the only current exception. The effect of the command can be quite
  different depending on the item. For icons, texts, windows, tabulars,
  the coordinates of the anchor can be modified or read. For groups, the
  coordinates of the origin of the transformation can be set or read. For
  tracks and waypoints, the coordinates of the current position can be set
  or read. For tracks setting the current position this way will make the
  previous position shift into the history. For reticles, the coordinates
  of the center can be set or read. For arcs and rectangles, the coordinates
  of the origin and corner can be set or read. For beziers, the coordinates
  of the vertices can be set or read and it is possible to remove or add
  vertices to an existing item. For curves, the capabilities of bezier are
  extended to support multiple contours. For all items that do not support
  multiple contours (currently all except curves) the {\tt contour} parameter
  should be omitted or specified as zero.
  
  The optional parameters must be combined to produce a given behavior.
  Here are the various form recognized by the command:

  \begin{description}
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId contourIndex\\
          @coords = \$zinc->{\bf coords}(tagOrId, contourIndex);\\
        }}
    Get all coordinates of contour at contourIndex. All items can answer if
    contourIndex is zero. Curves can handle other contours.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId contourIndex coordList\\
          \$zinc->{\bf coords}(tagOrId, contourIndex, coordList);\\
        }}
    Set all coordinates of contour at contourIndex. All items can do it if
    contourIndex is zero.  Curves can handle other contours.
    For groups, icons, texts, windows, tabulars, reticles, tracks,
    waypoints, only the first vertex will be used. For rectangles and
    arcs, only the first two vertices will be used. Beziers and curves can
    handle any number of vertices.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId contourIndex coordIndex\\
          @(\$x, \$y) = \$zinc->{\bf coords}(tagOrId, contourIndex, coordIndex);\\
         }}
    Get coordinate at coordIndex in contour at contourIndex. All items can answer if
    contourIndex is zero. Curves can handle other contours.  For groups, icons, texts,
    windows, tabulars, reticles, tracks, waypoints, coordIndex must be zero.
    For rectangles and arcs, index must zero or one.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId contourIndex coordIndex coordList\\
          \$zinc->{\bf coords}(tagOrId, contourIndex, coordIndex, coordList);\\
        }}
    Set coordinate at coordIndex in contour at contourIndex. All items can do it
    if contourIndex is zero.  Curves can handle other contours. For groups, icons, texts,
    windows, tabulars, reticles, tracks, waypoints, coordIndex must be zero.
    For rectangles and arcs, coordIndex must zero or one.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId remove contourIndex coordIndex\\
          \$zinc->{\bf coords}(tagOrId, 'remove', contourIndex, coordIndex);\\
        }}
    Remove coordinate at coordIndex in contour at contourIndex. Can only be handled
    by beziers and curves. Only curves can handle contourIndex other than zero.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId add contourIndex coordList\\
          \$zinc->{\bf coords}(tagOrId, 'add', contourIndex, coordList);\\
        }}
    Add coordinates at the end of contour at contourIndex. Can only be handled by beziers
    and curves. Only curves can handle contourIndex other than zero.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId add contourIndex coordIndex coordList\\
          \$zinc->{\bf coords}(tagOrId, 'add', contourIndex, coordIndex, coordList);\\
        }}
    Add coordinates at coordIndex in contour at contourIndex. Can only be handled by beziers
    and curves. Only curves can handle contourIndex other than zero.
  \end{description}
  
  And the slightly abbreviated forms:
  
  \begin{description}
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId\\
          @coords = \$zinc->{\bf coords}(tagOrId);\\
        }}
    Get all coordinates of contour 0. See first form.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId coordList\\
          \$zinc->{\bf coords}(tagOrId, coordList);\\
        }}
    Set all coordinates of contour 0. See second form.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId remove coordIndex\\
          \$zinc->{\bf coords}(tagOrId, 'remove', coordIndex);\\
        }}
    Remove coordinate at coordIndex in contour 0. See fifth form.
    
  \item{\bigskip
        {\tt\large pathname {\bf coords} tagOrId add coordList\\
          \$zinc->{\bf coords}(tagOrId, 'add', coordList);\\
        }}
    Add coordinates at the end of contour 0. See sixth form.
  \end{description}
\end{blockindent}

\zinccmd{currentpart}{}

{\tt\large \$num = \$zinc->{\bf currentpart}();}

\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 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}

\zinccmd{cursor}{tagOrId index}

{\tt\large \$zinc->{\bf cursor}(tagOrId, index);}

\begin{blockindent}
  Set the position of the insertion cursor for the items described by
  {\tt tagOrId} to be just before the character at {\tt index}. If
  some of the items described by {\tt tagOrId} don't support an
  insertion cursor, the command doesn't change them. The possible
  values for {\tt index} are described in the \cmdref{index} command.
  The command returns an empty string.
\end{blockindent}

\zinccmd{dchars}{tagOrId first ?last?}

{\tt\large \$zinc->{\bf dchars}(tagOrId, first);}\\
{\tt\large \$zinc->{\bf dchars}(tagOrId, first, last);}

\begin{blockindent}
  Delete the character range defined by the parameters {\tt first} and
  {\tt last} inclusive in all the items described by {\tt tagOrId}.
  Items that doesn't support text indexing are skipped by the command.
  If {\tt last} is not specified, the command deletes the character
  located at {\tt first}. The command returns an empty string.
\end{blockindent}

\zinccmd{dtag}{tagOrId ?tagToDelete?}

{\tt\large \$zinc->{\bf dtag}(tagOrId);}\\
{\tt\large \$zinc->{\bf dtag}(tagOrId, tagToDelete);}

\begin{blockindent}
  Delete the tag {\tt tagToDelete} from the list of tags associated
  with each item named by {\tt tagOrId}. If an item doesn't have
  the tag then it is leaved unaffected. If {\tt tagToDelete} is
  omitted, {\tt tagOrId} is used instead. The command returns an
  empty string as result.
\end{blockindent}

\zinccmd{find}{searchCommand ?arg arg ...?}

{\tt\large @items = \$zinc->{\bf find}(searchCommand, ?arg?, ...);}

\begin{blockindent}
  This command returns the list of all items selected by {\tt searchCommand}
  and the {\tt args}. See the \cmdref{addtag} command for an explanation of
  {\tt searchCommand} and the various {\tt args}. The items are sorted in
  drawing order, topmost first.

  For example: \$zinc->find('withtag', 'current'); \# returns the item under the pointer.

\end{blockindent}

\zinccmd{fit}{coordList error}

{\tt\large @controls = \$zinc->{\bf fit}(coordList, error);}

\begin{blockindent}
  This command fits a sequence of Bezier segments on the curve described
  by the vertices in {\tt coordList} and returns a list of vertices describing
  the control points for the generated segments. All the points on the fitted
  segments will be within {\tt error} distance from the given curve.
  {\tt coordList} should contain a pair number of coordinates in x, y order.
  The returned control point list consists of four control points per Bezier
  segment with two consecutive segments sharing their last/first control point.
  The control points are in x, y order and can be used to create or change a
  Bezier item.
\end{blockindent}

\zinccmd{focus}{?tagOrId?}

{\tt\large \$item = \$zinc->{\bf focus}();}\\
{\tt\large \$zinc->{\bf focus}(tagOrId);}

\begin{blockindent}
  Set the keyboard focus to the item describe by {\tt tagOrId}. If {\tt tagOrId}
  describe more than one item, the first item in display list order that supports
  an insertion cursor is used. If no such item exists, the command has no effect.
  If {\tt tagOrId} is an empty string the focus is reset and no item has the focus.
  If {\tt tagOrId} is not specified, the command returns the id of the item
  with the focus or an empty string if no item has the focus.

  When the focus has been set to a text item, the text item will display an
  insertion cursor and the keyboard events will be directed to that item.

  The widget receive keyboard events only if it has the window focus. It may be
  necessary to use the Tk focus command to force the focus to the widget window.

  NB: currently (Version 3.2.3) only text items are really getting the focus. Focus
  will be extended to many/all other items in a near future.

\end{blockindent}

\zinccmd{gdelete}{name}

{\tt\large \$zinc->{\bf gdelete}('fading');}

\begin{blockindent}
  This command breaks the binding between the given gradient name and
  the named gradient. When the gradient will be no longer used it will
  be deallocated.
\end{blockindent}

\zinccmd{gettags}{tagOrId}

{\tt\large @tags = \$zinc->{\bf gettags}(tagOrId);}

\begin{blockindent}
  This command returns the list of all the tags associated with
  the item specified by {\tt tagOrId}. If more than one item is
  named by {\tt tagOrId}, then the topmost in display list order
  is used to return the result. If no item is named by {\tt tagOrId},
  then the empty list is returned.
\end{blockindent}

\zinccmd{gname}{gradient name}

{\tt\large \$zinc->{\bf gname}('black:100|white:0/0', 'fading');}

\begin{blockindent}
  This command sets a name binding between the given gradient
  description and the given name. The name can be used in the
  same way the gradient description would be. The gradient
  will not be deallocated until the \cmdref{gdelete} command is
  invoqued on the name (and no item use the gradient). This feature
  can be a big performance gain when using many gradients in
  an animation, the name acts here as a caching mecanism.
\end{blockindent}

\zinccmd{group}{tagOrId}

{\tt\large \$group = \$zinc->{\bf group}(tagOrId);}

\begin{blockindent}
  Returns the group containing the item described by {\tt tagOrId}.
  If more than one item is named by {\tt tagOrId}, then the topmost
  in display list order is used to return the result.
\end{blockindent}

\zinccmd{hasanchors}{tagOrId}

{\tt\large \$bool = \$zinc->{\bf hasanchor}(tagOrId);}

\begin{blockindent}
  This command returns a boolean telling if the item specified by
  {\tt tagOrId} supports anchors. If more than one item is named by
  {\tt tagOrId}, then the topmost in display list order is used to
  return the result. If no items are named by {\tt tagOrId}, an error
  is raised.
\end{blockindent}

\zinccmd{hasfields}{tagOrId}

{\tt\large \$bool = \$zinc->{\bf hasfields}(tagOrId);}

\begin{blockindent}
  This command returns a boolean telling if the item specified by
  {\tt tagOrId} supports fields. If more than one item is named by
  {\tt tagOrId}, then the topmost in display list order is used to
  return the result. If no items are named by {\tt tagOrId}, an error
  is raised.
\end{blockindent}

\zinccmd{hastag}{tagOrId tag}

{\tt\large \$bool = \$zinc->{\bf hastag}(tagOrId, tag);}

\begin{blockindent}
  This command returns a boolean telling if the item specified by
  {\tt tagOrId} has the specified tag. If more than one item is
  named by {\tt tagOrId}, then the topmost in display list order
  is used to return the result. If no items are named by {\tt tagOrId},
  an error is raised.
\end{blockindent}

\zinccmd{index}{tagOrId index}

{\tt\large \$num = \$zinc->{\bf index}(tagOrId, index);}

\begin{blockindent}
  This command returns a number which is the numerical index in the item
  described by {\tt tagOrId} corresponding to {\tt index}. {\tt index}
  should be a textual description of a text index that can have the
  following forms:
  \begin{description}
  \item{\ident{number}} This should be an integer giving the character position
    within the text of the item. The indices are zero based. A number
    less than zero is treated as zero and a number greater than the
    text length is rounded to the text length. A number equal to the
    text length refers to the position past the last character in the
    text.
  \item{\ident{end}} Refers to the position past the last character in the
    text. This is the same as specifying a number equal to the text
    length.
  \item{\ident{insert}} Refers to the character just before the insertion
    cursor in the item.
  \item{\ident{sel.first}} Refers to the first character of the selection in
    the item. If the selection is not in the item, this form returns
    an error.
  \item{\ident{sel.last}} Refers to the last character of the selection in
    the item. If the selection is not in the item, this form returns
    an error.
  \item{\ident{@x,y}} Refers to the character at the point given by x and y,
    x and y are interpreted as device coordinates. If the point lies
    outside of the area corvered by the item, they refer to the first
    or last character in the line that is closest to the point.
  \end{description}
  
  The command return a value between 0 and the number of character in
  the item. If {\tt tagOrId} describe more than one item the index is
  processed in the first item supporting text indexing in display list
  order.
\end{blockindent}

\zinccmd{insert}{tagOrId before string}

{\tt\large \$zinc->{\bf insert}(tagOrId, before, string);}

\begin{blockindent}
  This command inserts {\tt string} in each item described by {\tt tagOrId}
  just before the text position described by {\tt before}. The possible
  values for {\tt before} are described in the \cmdref{index} command.
  Items that doesn't support text indexing are skipped by the command.
  The command returns an empty string.
\end{blockindent}

\zinccmd{itemcget}{tagOrId ?fieldId? attr}

{\tt\large \$val = \$zinc->{\bf itemcget}(tagOrId, attr);}\\
{\tt\large \$val = \$zinc->{\bf itemcget}(tagOrId, field, attr);}

\begin{blockindent}
  Returns the current value of the attribute given by {\tt attr} for
  the item named by {\tt tagOrId}. If {\tt tagOrId} name more than
  one item, the topmost in display list order is used. 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 {\tt attr}
  as a field attribute (see \objectref{field}), otherwise it will be interpreted
  as an item attribute (see the chapter \conceptref{Item types}{items}).
  If the attribute is not available for the field or item type, an error is
  reported.
\end{blockindent}

\zinccmd{itemconfigure}{tagOrId ?fieldId? ?attr? ?value? ?attr value ...?}

{\tt\large @attribs = \$zinc->{\bf itemconfigure}(tagOrId);}\\
{\tt\large @attrib = \$zinc->{\bf itemconfigure}(tagOrId, attrib);}\\
{\tt\large \$zinc->{\bf itemconfigure}(tagOrId, attrib=>value, ?attrib=>value, ...?);}
{\tt\large @attrib = \$zinc->{\bf itemconfigure}(tagOrId, fieldId, attrib);}\\
{\tt\large \$zinc->{\bf itemconfigure}(tagOrId, fieldId, attrib=>value, ?attrib=>value, ...?);}

\begin{blockindent}
  Query or modify the attributes of an item or field. If no attribute
  is given, returns a list of lists describing all the supported attributes
  in the same format as for a single attribute, as described next.
  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
  the command return 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.
\end{blockindent}

\zinccmd{lower}{tagOrId ?belowThis?}

{\tt\large \$zinc->{\bf lower}(tagOrId);}\\
{\tt\large \$zinc->{\bf lower}(tagOrId, belowThis);}

\begin{blockindent}
  Reorder all the items given by {\tt tagOrId} so that they will be
  under the item given by {\tt belowThis}. If {\tt tagOrId} name more
  than one item, their relative order will be preserved. If
  {\tt tagOrId} doesn't name an item, an error is raised. If
  {\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 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).
\end{blockindent}

\zinccmd{monitor}{?onOff?}

{\tt\large \$bool = \$zinc->{\bf monitor}();}\\
{\tt\large \$zinc->{\bf lower}(onOff);}

\begin{blockindent}
  This command controls the gathering of performance data. The data
  gathering is inited and turned on when the command is called with
  a boolean true parameter. The gathering is stopped if the command
  is called with a boolean false parameter. If the command is called
  with no parameters or with a boolean false parameter, it returns a
  string describing the currently collected data. The other form of
  the command returns the empty string.
\end{blockindent}

\zinccmd{numparts}{tagOrId}

{\tt\large \$bool = \$zinc->{\bf numparts}(tagOrId);}

\begin{blockindent}
  This command tells how many fieldId are available for event bindings
  or for field configuration commands in the item specified by {\tt tagOrId}.
  If more than one item is named by {\tt tagOrId}, the topmost in display
  list order is used to return the result. If no items are named by
  {\tt tagOrId}, an error is raised.
\end{blockindent}

\zinccmd{postscript}{}

{\tt\large \$zinc->{\bf postscript}();}

\begin{blockindent}
  Not yet implemented.
\end{blockindent}

\zinccmd{raise}{tagOrId ?aboveThis?}

{\tt\large \$zinc->{\bf raise}(tagOrId);}\\
{\tt\large \$zinc->{\bf raise}(tagOrId, aboveThis);}

\begin{blockindent}
  Reorder all the items given by {\tt tagOrId} so that they will be
  above the item given by {\tt aboveThis}. If {\tt tagOrId} name more
  than one item, their relative order will be preserved. If
  {\tt tagOrId} doesn't name an item, an error is raised. If
  {\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 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).
\end{blockindent}

\zinccmd{remove}{tagOrId ?tagOrId ...?}

{\tt\large \$zinc->{\bf remove}(tagOrId, ?tagOrId?, ...);}

\begin{blockindent}
  Delete all the items named by each {\tt tagOrId}. The
  command returns an empty string.
\end{blockindent}

\zinccmd{rotate}{tagOrId angle ?centerX centerY?}

{\tt\large \$zinc->{\bf rotate}(tagOrId, angle);}\\
{\tt\large \$zinc->{\bf rotate}(tagOrId, angle, centerX, centerY);}

\begin{blockindent}
  Add a rotation to the items or the transform described by
  {\tt tagOrId}. If {\tt tagOrId} describe a named transform
  then this transform is used to do the operation. If {\tt tagOrId}
  describe more than one item then all the items are affected by
  the operation. If {\tt tagOrId} describe neither a named transform
  nor an item, an error is raised. The angle is given in radians.
  The optional parameters describe the center of rotation, which
  defaults to the origin.

  When a rotation appears in a transformation, all items do not behave
  exactly in the same manner. Textual and icon elements do not rotate.
  Only their anchor position moves according to the rotation:

  \begin{itemize}
  \item \ident{track} The graphical part (i.e position, past positions, speedvector, marker) is fully
    transformed. The label is computed relative to the new position.
  \item \ident{waypoint} The position is fully transformed. The label is computed relative to the
    new position.
  \item \ident{tabular}, \item \ident{text}, \ident{icon} Only the anchor position is affected.  
  \item \ident{reticle} Only the center and the spacing between circles are affected.
  \item \ident{map} lines and arcs are fully transformed. For texts and symbols only the position
    is affected.
  \item \ident{rectangle}, \ident{arc}, \ident{curve}, and \ident{bezier} are fully transformed.
  \item \ident{window} Only the position is affected.
  \end{itemize}

\end{blockindent}

\zinccmd{scale}{tagOrId xFactor yFactor}

{\tt\large \$zinc->{\bf scale}(tagOrId, xFactor, yFactor);}

\begin{blockindent}
  Add a scale factor to the items or the transform described by
  {\tt tagOrId}. If {\tt tagOrId} describe a named transform
  then this transform is used to do the operation. If {\tt tagOrId}
  describe more than one item then all the items are affected by
  the opration. If {\tt tagOrId} describe neither a named transform
  nor an item, an error is raised. A separate factor is specified for
  X and Y.
\end{blockindent}

\zinccmd{select}{option ?tagOrId? ?arg?}

{\tt\large \$zinc->{\bf select}(option, ?tagOrId?, ?arg?);}

\begin{blockindent}
  Manipulates the selection as requested by {\tt option}. {\tt tagOrId}
  Describe the target item. This item must support text indexing and
  selection. If more than one item is referred to by {\tt tagOrId}, the
  first in display list order that support both text indexing and selection
  will be used. Some forms of the command include an {\tt index} parameter,
  this parameter describe a textual position within the item and should
  be a valid index as described in the \cmdref{index} command.
  The valid forms of the command are :

  \begin{description}
  \item{\bigskip
        {\tt\large pathname {\bf select} adjust tagOrId index\\
          \$zinc->{\bf select}('adjust', tagOrdId, index);
          \smallskip}} \\
    Adjust the end of the selection in {\tt tagOrId} that is nearest to
    the character given by {\tt index} so that it is at {\tt index}. The
    other end of the selection is made the anchor for future select to
    commands. If the selection is not currently in {\tt tagOrId}, this
    command behaves as the select to command. The command returns an empty
    string.
  \item{\bigskip
        {\tt\large pathname {\bf select} clear\\
          \$zinc->{\bf select}('clear');
          \smallskip}} \\
    Clear the selection if it is in the widget. If the selection is not
    in the widget, the command has no effect. Return an empty string.
  \item{\bigskip
        {\tt\large pathname {\bf select} from tagOrId index\\
          \$zinc->{\bf select}('from', tagOrdId, index);
          \smallskip}} \\
    Set the selection anchor point for the widget to be just before
    the character given by {\tt index} in the item described by
    {\tt tagOrId}. The command has no effect on the selection, it
    sets one end of the selection so that future select to can actually
    set the selection. The command returns an empty string.
  \item{\bigskip
        {\tt\large pathname {\bf select} item\\
          \$item = \$zinc->{\bf select}('item');
          \smallskip}} \\
    Returns the id of the selected item, if the selection is in an item
    on this widget. Otherwise the command returns an empty string.
  \item{\bigskip
        {\tt\large pathname {\bf select} to tagOrId index\\
          \$zinc->{\bf select}('to', tagOrdId, index);
          \smallskip}} \\
    Set the selection to be the characters that lies between the selection
    anchor and {\tt index} in the item described by {\tt tagOrId}. The
    selection includes the character given by {\tt index} and includes the
    character given by the anchor point if {\tt index} is greater or
    equal to the anchor point. The anchor point is set by the most recent
    select adjust or select from command issued for this widget. If the
    selection anchor point for the widget is not currently in {\tt tagOrId},
    it is set to the character given by index. The command returns an empty
    string.
  \end{description}

\end{blockindent}

\zinccmd{smooth}{coordList}

{\tt\large @coords = \$zinc->{\bf smooth}(coordList);}

\begin{blockindent}
  This command computes a sequence of Bezier segments in order to smooth the
  curve described by the vertices in {\tt coordList} and returns a list of
  vertices describing the control points for the generated segments.
  {\tt coordList} should contain a pair number of coordinates in x, y order.
  The returned control point list consists of four control points per Bezier
  segment with two consecutive segments sharing their last/first control point.
  The control points are in x, y order and can be used to create or change a
  Bezier item.
\end{blockindent}

\zinccmd{tapply}{}

{\tt\large \$zinc->{\bf tapply}();}

\begin{blockindent}
  Not yet implemented.
\end{blockindent}

\zinccmd{tdelete}{tName}

{\tt\large \$zinc->{\bf tdelete}(tName);}

\begin{blockindent}
  Destroy a named transform. If the given name is not found
  among the named transforms, an error is raised.
\end{blockindent}

\zinccmd{transform}{?tagOrIdFrom? tagOrIdTo coordList}

{\tt\large @coords = \$zinc->{\bf transform}(tagOrIdTo, coordList);}\\
{\tt\large @coords = \$zinc->{\bf transform}(tagOrIdFrom, tagOrIdTo, coordList);}

\begin{blockindent}
  This command returns a list of coordinates obtained by transforming
  the coordinates 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 device coordinate
  space. If either {\tt tagOrId} describe 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.

  It is possible to convert from device coordinate space (i.e window coordinate
  space) to the coordinate space of any item. This is done by omitting ?tagOrIdFrom?
  an specifying in tagOrIdTo, the id of the item.

  It is also possible to convert from the coordinate space of an item to the
  device coordinate space but it is a bit more tricky. In order to be able
  to do so, the root group (the initial group of id 1) must not have any
  transform. Its coordinate space is thus the device coordinate space. In this
  case it is possible to use this group as the tagOrIdTo of the transform command to
  obtain the desired effect.

  For example: XXX
\end{blockindent}

\zinccmd{translate}{tagOrId xAmount yAmount}

{\tt\large \$zinc->{\bf translate}(tagOrdId, xAmount, yAmount);}

\begin{blockindent}
  Add a translation to the items or the transform described by
  {\tt tagOrId}. If {\tt tagOrId} describe a named transform
  then this transform is used to do the operation. If {\tt tagOrId}
  describe more than one item then all the items are affected by
  the opration. If {\tt tagOrId} describe neither a named transform
  nor an item, an error is raised. A separate value is specified for
  X and Y.
\end{blockindent}

\zinccmd{treset}{tagOrId}

{\tt\large \$zinc->{\bf treset}(tagOrdId);}

\begin{blockindent}
  Set the named transform or the transform for the items described
  by {\tt tagOrId} to identity. If {\tt tagOrId} describe neither
  a named transform nor an item, an error is raised.
\end{blockindent}

\zinccmd{trestore}{tagOrId tName}

{\tt\large \$zinc->{\bf trestore}(tagOrdId, tName);}

\begin{blockindent}
  Set the transform for the items described by {\tt tagOrId} to the
  transform named by {\tt tName}. If {\tt tagOrId} doesn't describe
  any item or if the transform named {\tt tName} doesn't exist, an
  error is raised.
\end{blockindent}

\zinccmd{tsave}{tagOrId tName}

{\tt\large \$zinc->{\bf tsave}(tagOrdId, tName);}

\begin{blockindent}
  Create (or reset) a transform associated with the name {\tt tName}
  which has for initial value the transform associated with the item
  {\tt tagOrId}. If {\tt tagOrId} describe 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.
\end{blockindent}

\zinccmd{type}{tagOrId}

{\tt\large \$name = \$zinc->{\bf type}(tagOrdId);}

\begin{blockindent}
  This command returns the type of the item specified by {\tt tagOrId}.
  If more than one item is named by {\tt tagOrId}, then the type of
  the topmost item in display list order is returned.
  If no items are named by {\tt tagOrId}, an error is raised.
\end{blockindent}

\zinccmd{vertexat}{tagOrId x y}

{\tt\large (\$contour, \$vertex, \$edgevertex) = \$zinc->{\bf vertexat}(tagOrdId, x, y);}

\begin{blockindent}
  Return a list of values describing the vertex and edge closest to the
  {\bf 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}


\concept{types}
\chapter{Attribute types}

\attrtype{alignment}
\begin{blockindent}
  Specifies the horizontal alignment of an entity.
  The legal values are: {\tt left}, {\tt right}, {\tt center}.
\end{blockindent}

\attrtype{alpha}
\begin{blockindent}
  Specifies the transparency of an item. The value must be an integer from
  0 (fully transparent) to 100 (fully opaque).
\end{blockindent}

\attrtype{anchor}
\begin{blockindent}
  Specifies one of the nine caracteristic points of a rectangle
  or bounding box that will be used to position the object.
  These points include the four corners the four edge centers
  and the center of the rectangle. The possible values are: {\tt nw},
  {\tt n}, {\tt ne}, {\tt e}, {\tt se}, {\tt s}, {\tt sw}, {\tt w},
  {\tt center}.
\end{blockindent}

\attrtype{angle}
\begin{blockindent}
  Specifies an angle in degrees, the value must be an integer from
  0 to 360 inclusive.
\end{blockindent}

\attrtype{autoalignment}
\begin{blockindent}
  Specifies the horizontal alignments that should be used for track
  or way point fields depending on the label position relative to
  the position of the item. The attribute may have two forms: a
  single dash {\tt -} means turning of the automatic alignment feature
  for the field; The other form consists in three letters which
  describe in order: the alignment to be used when the label is to
  the left of the item position, above or below the item position and
  to the right of the item position. The possible values for each
  letter is: {\tt l} for left alignment, {\tt c} for center
  alignment and {\tt r} for right alignment. Here is an example:
  {\tt rll} means right align the field if the label is on the
  left side of the item, and left align if the label is above, below
  or on the right of the item.
\end{blockindent}

\attrtype{bitmap}
\begin{blockindent}
  This should be a string naming a valid Tk bitmap. The bitmap should
  be known to Tk prior to its use. Zinc registers a set of bitmaps that
  can be used for any bitmap valued attribute (see \ref{builtinbitmaps}).
  Extensions to Tk are available to create or manipulate bitmaps from a
  script. The value may also name a file containing a valid X11 bitmap
  description. The syntax in this cas is {\tt @filename}.
\end{blockindent}

\attrtype{bitmaplist}
\begin{blockindent}
  This is an extension of the \ident{bitmap} attribute type. It describes
  a list of bitmaps that will be the value of the attribute.
\end{blockindent}

\attrtype{boolean}
\begin{blockindent}
  This is the description of a standard Tcl boolean value. The possible
  values are {\tt 0}, {\tt false}, {\tt no} or {\tt off} for the false
  value and {\tt 1}, {\tt true}, {\tt yes} or {\tt on} for the true value.
\end{blockindent}

\attrtype{capstyle}
\begin{blockindent}
  This the description of a line cap. The possible values are {\tt butt},
  {\tt projecting} and {\tt round}.
\end{blockindent}

\attrtype{color}
\begin{blockindent}
  This is a string that describes a color. The description may have one of
  two forms, a colorname such as {\tt green} or {\tt LemonChiffon} or an
  rgb specification in one of the following formats, {\tt \#rgb}, {\tt \#rrggbb},
  {\tt \#rrrgggbbb} or {\tt \#rrrrggggbbbb}. If less than four digits are provided
  for a color component, they represent the most significant bits of the
  component. For example {\tt \#3a7} is equivalent to {\tt \#3000a0007000}.
\end{blockindent}

\attrtype{dimension}
\begin{blockindent}
  This is a string that represent distance. The string consists in a floating
  point signed number.
\end{blockindent}

\attrtype{edgelist}
\begin{blockindent}
  This is a list describing the edges of a border that should be considered
  for processing (e.g for drawing). The possible values are {\tt left},
  {\tt right}, {\tt top}, {\tt bottom}, {\tt contour}, {\tt oblique} and
  {\tt counteroblique}. The {\tt contour} value is the same as the
  {\tt "left top right bottom"} list. The {\tt oblique} and {\tt counteroblique}
  values describe diagonal segments from top-left to bottom-right and from
  top-right to bottom-left respectively.
\end{blockindent}

\attrtype{font}
\begin{blockindent}
  This is a string describing a font. For an exhaustive description of
  what is legal as a font description, refer to the Tk \ident{font}
  command man page. Just to mention to popular methods, it is possible to
  specify a font by it's X11 font name or by a list whose elements are the
  font family, the font size and then zero or more styles including {\tt normal},
  {\tt bold}, {\tt roman}, {\tt italic}, {\tt underline}, {\tt overstrike}.
\end{blockindent}

\attrtype{gradientcolor}
\begin{blockindent}
  This is a string describing a color gradient to be used for example to fill
  a surface.

  The string may consist in a single color name that will be used
  to paint a solid surface or can be a list of gradient steps separated by
  '|' characters.

  The general pattern is:
  {\tt\large gradient\_step1|...|gradient\_stepn/angle} for an axial gradient,
  {\tt\large gradient\_step1|...|gradient\_stepn(x y} for a radial gradient and
  {\tt\large gradient\_step1|...|gradient\_stepn[x y} for a path gradient.

  The /angle section tells that the gradient is an axial gradient and give the
  angle of the gradient.

  The (x y section tells that the gradient is a radial gradient and give the
  center of the gradient.

  The [x y section tells that the gradient is a path gradient and give the
  center of the gradient.

  If none of the above gradient type specification is given, the gradient will
  be drawn as an axial gradient with a null angle.

  Each gradient segment section has the general form:
    {\tt\large color\_name:alpha color\_position mid\_span\_position}

  Each color can be specified as a valid X color (either name or \#value). An alpha
  value can be applied to the color using the optional :alpha parameter.

  The color position tells where in the gradient surface, measured
  as a percentage of the total gradient distance, the color should start. The first
  gradient segment has its position set to 0 and the last segment has its position
  set to 100, regardless of the specification. The position can thus be safely omitted
  for these segments.
  The in between segments must have a position explicitly set. If not given, a position
  will default to 0.

  The mid span position tells where in the current gradient segment should be the median
  color. The position is given in percentage of the current gradient segment distance.
  The mid span position can be used to obtain a non linear gradient segment, this is useful
  to describe relief shapes.
  This parameter can be omitted in which case it defaults to 50 and the gradient segment
  is perfectly linear.

  A gradient segment can be specified as a single color. In this case a flat uniform fill
  will result.
\end{blockindent}

\attrtype{image}
\begin{blockindent}
  This should be the name of a previously registered Tk image. In pure
  Tk only GIF, PPM and bitmap formats are available as source for images.
  With the Img extension many others popular formats are added including
  JPEG, XPM and PNG.
\end{blockindent}

\attrtype{integer}
\begin{blockindent}
  Describes a signed integer value.
\end{blockindent}

\attrtype{item}
\begin{blockindent}
  Describes an item id or a tag. If a tag is provided an item will be
  searched for the tag and the first matching in display list order will
  be used.
\end{blockindent}

\attrtype{joinstyle}
\begin{blockindent}
  Describes a join style. The possible values are {\tt bevel}, {\tt miter}
  and {\tt round}.
\end{blockindent}

\attrtype{labelformat}
\begin{blockindent}
  The new format is as follow. Parameters between [] are
  optional and take default values when omitted. The spaces can appear
  between blocks but not inside.
  
  \verb+[WidthxHeight] [field0Spec] [field1Spec] [fieldnSpec]+\\
  
  Width and Height set the size of the clipping box surrounding
  the label. If it is not specified, there will be no clipping.
  It it is specified alone it is the size of the only displayed
  field (0).
  
  fieldSpec is:
  \verb+sChar fieldWidth sChar fieldHeight [pChar fieldX pChar fieldY]+.
  
  Each field description refers to the field of same index in the field
  array.
  If \verb+sChar+ is \verb+'x'+, the dimension is in pixel. If \verb+sChar+ is
  \verb+'f'+, the dimension is in percentage of the mean width/height of a
  character (in the field font). If \verb+sChar+ is \verb+'i'+, the dimension
  is in percentage of the size of the image in the field. If \verb+sChar+ is
  \verb+'a'+, the dimension is automatically adjusted to match the field's
  content plus the given value in pixels. If \verb+sChar+ is \verb+'l'+,
  the dimension is automatically adjusted to match the global size of the
  label (not counting fields with \verb+'l'+ size specs). The positional
  parameter is not used with this size specification (always 0) and it is not
  possible to reference the field in another field spec.
  
  If \verb+pChar+ is \verb-'+'- the position is in pixel (possibly negative).
  If it is \verb+'<'+ the position is the index of the field at the left/top
  of which the current field should be  attached. If it is \verb+'>'+ the
  position is the index of the field at the right/bottom of which the current
  field should be attached. If \verb+pChar+ is \verb+'^'+ the position is
  the index of the field used to align the left/top border (left on left or
  top on top). If \verb+pChar+ is \verb+'$'+ the %$ position is the index
  of the field used to align the right/bottom border (right on right or
  bottom on bottom).
  
  The positional parameters can be omitted if there is only one field.  
\end{blockindent}

\attrtype{leaderanchors}
\begin{blockindent}
  Describe where to attach the label leader on the label. These are not
  to be confused with the regular rectangular anchors.
  
  The format is: lChar leftLeaderAnchor [lChar rightLeaderAnchor]
  
  If lChar is a '|', leftLeaderAnchor and rightLeaderAnchor
  are the indices of the field that serve to anchor the label's leader. More
  specifically the bottom right corner is used when leftLeaderAnchor is active
  and the bottom left corner is used when rightLeaderAnchor is active.

  If lChar is '\%', leftLeaderAnchor and rightLeaderAnchor should be specified
  as widthPercentxheightPercent, each value being a percentage (between 1 and 100)
  of the width/height of the label bounding box. If rightLeaderAnchor is not
  specified it defaults to leftLeaderAnchor. If neither of them are specified, the
  center of the label is used as an anchor.
\end{blockindent}

\attrtype{lineend}
\begin{blockindent}
  Describe the shape of the arrow at the beginning or end of a path.
  This is a list of three numbers describing the arrow shape in the
  following order:
  distance along the axis from neck to tip of the arrowhead,
  distance from trailing points to tip and distance from outside
  edge of the line to the trailing points (see canvas).
  If an empty list is given, there is no arrow.
\end{blockindent}

\attrtype{lineshape}
\begin{blockindent}
  Describes the shape of a path connecting two points. The possible
  values are {\tt straight}, {\tt rightlightning}, {\tt leftlightning},
  {\tt rightcorner}, {\tt leftcorner}, {\tt doublerightcorner} and
  {\tt doubleleftcorner}.
\end{blockindent}

\attrtype{linestyle}
\begin{blockindent}
  Describes the style of the dashes that should be used to draw a line.
  The possible values are {\tt simple}, {\tt dashed}, {\tt mixed} and
  {\tt dotted}.
\end{blockindent}

\attrtype{mapinfo}
\begin{blockindent}
  This is the name of a previously registered mapinfo object
  (see the chapter \conceptref{The mapinfo commands}{mapinfocmds}) that will define
  the lines, symbols, texts an other graphical parts displayed in a map item.
\end{blockindent}

\attrtype{number}
\begin{blockindent}
  This is floating point value. It can be optionally expressed in
  exponent notation.
\end{blockindent}

\attrtype{position}
\begin{blockindent}
  This is a list of two floating point values that describes a point
  position or some two dimensional delta (used for example to describe
  the speed vector of a track item).
\end{blockindent}

\attrtype{relief}
\begin{blockindent}
  Describes a border relief. The possible values are {\tt flat}, {\tt groove},
  {\tt raised}, {\tt ridge} and {\tt sunken}.
\end{blockindent}

\attrtype{string}
\begin{blockindent}
  Just what its name implies, a string.
\end{blockindent}

\attrtype{taglist}
\begin{blockindent}
  This should be a list of strings describing the tags that are set
  for an item.
\end{blockindent}

\attrtype{window}
\begin{blockindent}
  A string describing an X window id. This id can be returned by the
  {\tt winfo id a-widget-path} command.
\end{blockindent}



\concept{labelsandfields}
\chapter{Labels, label formats and fields}

\concept{label}
\concept{labelformat}
\section {Labels, label formats}

\object{field}
\section{Attributes for fields}

Fields are item parts of items supporting labelformat (i.e.
  \objectref{track}, \objectref{waypoint} and \objectref{tabular}).
They can be configured in a similar way of items themselves, with
the command \cmdref{itemconfigure}, but this command requires an additionnal
parameter (in second position) the \ident{fieldId}. To get the value of a
field attribute, you can use the command {itemcget} with the \ident{fieldId}
as an addtionnal second paramter.

Applicable attributes for fields are:


\attribute{alignment}{alignment}{
  The horizontal alignment of both the text and the image. The default value
  is {\tt left}.}
\attribute{autoalignment}{autoalignment}{
  The dynamic horizontal alignments used depending on the label orientation.
  The default value is {\tt "-"} which means do not use dynamic alignment.}
\attribute{backcolor}{color}{
  The field background color. The default value is the current value of the widget
  option \ident{-foreground}.}
\attribute{border}{edgelist}{
  The border description edge by edge. The border is a one pixel wide outline that
  is drawn around the field outside the relief. Some border edges can be omitted,
  this attribute describe the edges that should be displayed as part of the border.
  The default value is {\tt ""}.}
\attribute{bordercolor}{color}{
  The border color. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{color}{color}{
  The text color. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{filled}{boolean}{
  Specifies if the field background should be filled. The default value is
  {\tt false}.}
\attribute{fillpattern}{bitmap}{
  The fill pattern used when filling the background. This attribute is overrided
  by the tile attribute. The default value is {\tt ""}.}
\attribute{font}{font}{
  The text font. The default value is the current value of the widget option
  \ident{-font}.}
\attribute{image}{image}{
  An image to be displayed in the field. The image will be centered vertically
  in the field. The default value is {\tt ""}.}
\attribute{relief}{relief}{
  Specifies the relief to be drawn around the field, inside the border. The
  default value is {\tt flat}.}
\attribute{reliefthickness}{dimension}{
  Width of the relief drawn around the field. The default value is {\tt 0}
  which means that no relief should be drawn around the field.}
\attribute{sensitive}{boolean}{
  Specifies if the field should react to input events. The default value is
  {\tt true}.}
\attribute{text}{string}{
  A line of text to be displayed in the field. The text will be centered vertically
  in the field. The default value is {\tt ""}.}
\attribute{tile}{image}{
  Specifies an image that will be tiled over the field background is the field
  is filled. This attribute has precedence over the \ident{fillpattern} attribute.
  The default value is {\tt ""}.}
\attribute{visible}{boolean}{
  Specifies if the field is displayed. The default value is {\tt true}.}


\concept{items}
\chapter{Item types}

This chapter introduces the item types that can be used in \ident{zinc}. Each
item type provides a set of options that may be used to query or change the
item behavior. Some item types cannot be used with some widget commands, or
use special parameters with some command. Those cases are noted in the description
of the item.


\object{group}
\section{Group items}

Group items are used for grouping objects together. Their usage is
very powerfull and their use is best described in a previous chapter
\conceptref{Groups, Display List and Transformations}{coordinates}.

Applicable attributes for \ident{group} are:

\attribute{alpha}{alpha}{Specifies the transparency to apply to the group children. Needs the openGL extension. XXX alpha type to be defined}
\attribute{atomic}{boolean}{Specifies if the group should report itself
  or its components during a search or for binding related operations. This
  attribute enable the use of a group as a single complex object build from
  smaller parts. It is possible to search for this item or use it in bindings
  without dealing with its smaller parts. The defaut value is {\tt false}.}
\attribute{clip}{item}{The item used to clip the children of the group. The shape
  of this item define an area that is used as a clipping shape when drawing the
  children of the group. Most items can be used here but notable exceptions are
  the \ident{reticle} and \ident{map} items. The default value is {\tt ""} which
  means that no clipping will be performed.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should be
  composed with the local transform. The defaut value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The defaut value is {\tt true}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 6}.}
\attribute{sensitive}{boolean}{Specifies if the item and all its children should
  react to events. The defaut value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item and all its children is
  displayed. The defaut value is {\tt true}.}


\object{track}
\section{Track items}

Track items have been designed for figuring out typical radar information
for Air Traffic Control. However they may certainly be used by other kinds of
radar view and surely by other kind of plan view with many moving objects
and associated textual information.

A track is composed of two main parts:
\begin{itemize} 
\item The first one is purely graphic and is composed of many parts, some of them being identified by their ``partName'':

\begin{itemize}
\item the {\bf current position} of the object. Its partName is \ident{position}
\item a {\bf speed vector} which size depends on the
attribute \attributeref{speedvector} for the track and the option \refopt{speedvectorlength}.
This speed vector may be set visible or not, sensitive or other attributes can
be set such as color, width, ticks... Its partName is \ident{speedvector}
\item a {\bf leader} which links the current position to the label. The leader may be visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its partName is \ident{leader}
\item {\bf past positions} which are previous position after the track has been moved by the \cmdref{coords} command. The number of such past positions, their visibility and other graphic caracteristics can be be modified. This part is never sensitive.
\item a {\bf marker}, which is a circle around the current position. This marker can be visible or not and other graphic caracteristics can be configured. The marker is never sensitive.
\item a {\bf connection}, which is a link with another item. This connection may be visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its partName is \ident{connection}.
\end{itemize}
\begin{itemize}
\item the second part is a block of texts described by a labelformat (see chapter \conceptref{Labels, fields and Label formats}{labelformat}. Each text can have its graphic decorations (alignment, background, images, borders...). These attributes are listed in the chapter \conceptref{Labels, label formats and fields}{labelformat} and can be changed by the command \cmdref{itemconfigure}.
\end{itemize}
\end{itemize}

The following picture shows a simple \ident{track} with a label of 5 fields and 5 past positions. 

\ifpdf
  \includegraphics{trackexemple}
\else
\latexhtml{
  \htmladdimg{trackexemple.png}
  }
\fi

An other very important feature of \ident{track} is that \ident{zinc} offers an anti-overlap manager. This manager tries to avoid any overlap of tracks labels. It also avoids that the label overlap the speedvector. This manager is stable over time: there should be few cases where labels are moved to a very different position. This manager applies to all tracks included in a group (by default the group 1). It can be enabled/disabled with the attributes XXX. New labels positions are computed by the overlap  manager every time a track is moved, a track is created or destroyed and every time the \ident{zinc} widget is resized.  
Due to software licence limitation, \ident{zinc} {\bf DO NOT include} the very last version of this anti-overlap manager. 

Applicable attributes for \ident{track}

\attribute{circlehistory}{boolean}{If set to true the track history will
  be plotted as cricles otherwise it will be plotted as squares. The default
  value is {\tt false}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
  should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{The item at the other end of the connection link.
  The default value is {\tt ""} which means that no connection link will be drawn.}
\attribute{connectioncolor}{gradientcolor}{The color of the connection link. The
  default value is the current value of the widget option \ident{-foreground}.}
\attribute{connectionsensitive}{boolean}{Specifies if the connection link
  is sensitive. The actual sensitivity is the logical \ident{and} of this attribute and
  of the item {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{connectionstyle}{linestyle}{The line style of the connection link.
  The default value is {\tt simple}.}
\attribute{connectionwidth}{dimension}{The width of the connection link. The
  default value is {\tt 1}.}
\attribute{filledhistory}{boolean}{If set to true the track history will be
  filled otherwise it will be outlined. The default value is {\tt true}.}
\attribute{filledmarker}{boolean}{If set to true the circular marker will be
  filled otherwise it will be outlined. The default value is {\tt false}.}
\attribute{frozenlabel}{boolean}{Specifies if the label should be frozen at
  its current location to prevent the anti overlapping system from moving it. The
  default value is {\tt false}.}
\attribute{historycolor}{gradientcolor}{The color of the track history. The default value
  is the current value of the widget option \ident{-foreground}.}
\attribute{labelanchor}{anchor}{The anchor used in positionning the label. The
  default value is {\tt center}.}
\attribute{labelangle}{angle}{The angle in degrees between the label anchor
  and the normal to the speed vector. This attribute works with the {\tt labeldistance}
  attribute to specify a position for the label anchor with respect to the item
  origin. There is another alternative method for label positioning which is
  implemented with the {\tt labeldx} and {\tt labeldy} methods. Simultaneous
  use of the two methods should be done with care as there is no automatic update
  of values from the {\tt labeldx}, {\tt labeldy} set to the {\tt labeldistance},
  {\tt labelangle} set. The default value is {\tt 20}.}
\attribute{labelconvergencestyle}{dimension}{XXX New. To be documented. The default value is ??.}
\attribute{labeldistance}{dimension}{The minimum distance in pixels between
  the track position and the label anchor. See the explanation of the {\tt labelangle}
  attribute for some more details. The default value is 50.}
\attribute{labeldx}{dimension}{The X offset between the track position and the
  label anchor. The default value is computed from the values in the {\tt labeldistance}
  and {\tt labelangle} attributes.}
\attribute{labeldy}{dimension}{The Y offset between the track position and the label
  anchor. The default value is computed from the values in the {\tt labeldistance} and
  {\tt labelangle} attributes.}
\attribute{labelformat}{labelformat}{Geometry of the label fields. The default
  value is {\tt ""} which means that no label will be displayed.}
\attribute{labelpreferedangle}{angle}{XXX New. To be documented. The default value is ??.}
\attribute{lastasfirst}{boolean}{If set to true, the last position in the
  history will be drawn in the same color as the current position instead of
  being drawn in the history color. The default value is {\tt false}.}
\attribute{leaderanchors}{leaderanchors}{The attachments of the leader on the
  label side. The default value is {\tt ""} which means that both leader anchors are
  at the label center.}
\attribute{leadercolor}{gradientcolor}{The color of the label leader. The default value
  is the current value of the widget option \ident{-foreground}.}
\attribute{leaderfirstend}{lineend}{Describe the arrow shape at the current position
  end of the leader. The default value is {\tt ""}.}
\attribute{leaderlastend}{lineend}{Describe the arrow shape at the label end of
  the leader. The default value is {\tt ""}.}
\attribute{leadersensitive}{boolean}{Specifies if the label leader is sensitive.
  The actual sensitivity is the logical \ident{and} of this attribute and of the item
  {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{leadershape}{lineshape}{The shape of the label leader. The default
  value is {\tt straight}.}
\attribute{leaderstyle}{linestyle}{The line style of the label leader. The default
  value is {\tt simple}.}
\attribute{leaderwidth}{dimension}{The width of the label leader. The default
  value is {\tt 1}.}
\attribute{markercolor}{gradientcolor}{The color of the circular marker. The default
  value is the current value of the widget option \ident{-foreground}.}
\attribute{markerfillpattern}{bitmap}{The pattern to use when filling the
  circular marker. The default value is {\tt ""}.}
\attribute{markersize}{number}{The (scale sensitive) size of the circular marker.
  The default value is {\tt 0} which turn off the display of the marker.}
\attribute{markerstyle}{linestyle}{The line style of the marker outline. The
  default value is {\tt simple}.}
\attribute{mixedhistory}{boolean}{If true the track history will be plotted
  with dots every other positions. The default value is {\tt false}.}
\attribute{numfields}{integer}{Gives the number of fields available for the
  label. This attribute is read only.}
\attribute{position}{position}{The current location of the track. The default
  value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 5}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{speedvector}{position}{The speed vector $\Delta x$ and $\Delta y$
  in unit / minute. The default value is {\tt "0 0"} which results in no speed vector
  displayed.}
\attribute{speedvectorcolor}{gradientcolor}{The color of the track's speed vector. The
  default value is the current value of the widget option \ident{-foreground}.}
\attribute{speedvectormark}{boolean}{If set a small point is drawn at the end of
the speed vector. The point is drawn with the speed vector color. The default is
{\tt false}.}
\attribute{speedvectorsensitive}{boolean}{Specifies if the track's speed vector
  is sensitive. The actual sensitivity is the logical \ident{and} of this attribute and of
  the item {\tt sensitive} attribute. The default value is {\tt true}. }
\attribute{speedvectorticks}{boolean}{If set a mark is drawn at each minute position.
The default is {\tt false}.}
\attribute{speedvectorwidth}{width}{New. XXX To be documented. The default value is ??.}
\attribute{symbol}{bitmap}{The symbol displayed at the current position. The
  default value is {\tt AtcSymbol15}.}
\attribute{symbolcolor}{gradientcolor}{The color of the symbol displayed at the current
  position. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{symbolsensitive}{boolean}{Specifies if the current position's symbol
  is sensitive to events. The actual sensitivity is the logical \ident{and} of this attribute
  and of the item {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default value
  is {\tt true}.}
\attribute{visiblehistorysize}{integer}{The number of past positions that should
  be displayed. The default value is {\tt 6}.}


\object{waypoint}
\section{WayPoint items}

Waypoints items have been initially designed for figuring out typical fixed position
objects (i.e. beacons or fixes in the ATC vocabulary) with
associated block of texts on a radar display for Air Traffic Control. They supports
mouse event handling and interactions.
However they may certainly be used by other kinds of radar view or even by other kind
of plan view with many geographical objects and associated textual information.

A waypoint is composed of the following parts:
\begin{itemize} 
\item the {\bf position} of the waypoint. Its partName is \ident{position}
\item a {\bf leader} which links the current position to the label. The leader may be visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its partName is \ident{leader}
\item a {\bf label} which is a block of texts described by a labelformat (see chapter \conceptref{Labels, fields and Label formats}{labelformat}. Each text can have its graphic decorations (alignment, background, images, borders...). These attributes are listed in the chapter \conceptref{Labels, label formats and fields}{labelformat} and can be changed by the command \cmdref{itemconfigure}.
\item a {\bf connection}, which is a link with another item. This connection may be visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its partName is \ident{connection}.
\end{itemize}

Applicable attributes for \ident{waypoint} are:

\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}. }
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}. }
\attribute{connecteditem}{item}{The item at the other end of the connection link.
  The default value is {\tt ""} which means that no connection link will be drawn.}
\attribute{connectioncolor}{gradientcolor}{The color of the connection link. The default
  value is the current value of the widget option \ident{-foreground}.}
\attribute{connectionsensitive}{boolean}{Specifies if the connection link is
  sensitive. The actual sensitivity is the logical \ident{and} of this attribute and of the
  item {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{connectionstyle}{linestyle}{The line style of the connection link.
  The default value is {\tt simple}.}
\attribute{connectionwidth}{dimension}{The width of the connection link. The
  default value is {\tt 1}.}
\attribute{filledmarker}{boolean}{If set to true the circular marker will be
  filled otherwise it will be outlined. The default value is {\tt false}.}
\attribute{labelanchor}{anchor}{The anchor used in positionning the label. The
  default value is {\tt center}.}
\attribute{labelangle}{angle}{The angle in degrees between the label anchor and
  the normal to the speed vector. This attribute works with the {\tt labeldistance}
  attribute to specify a position for the label anchor with respect to the item origin.
  There is another alternative method for label positioning which is implemented with
  the {\tt labeldx} and {\tt labeldy} methods. Simultaneous use of the two methods
  should be done with care as there is no automatic update of values from the
  {\tt labeldx}, {\tt labeldy} set to the {\tt labeldistance}, {\tt labelangle} set.
  The default value is {\tt 20}.}
\attribute{labeldistance}{dimension}{The minimum distance in pixels between the
  way point position and the label anchor. See the explanation of the {\tt labelangle}
  attribute for some more details. The default value is 50.}
\attribute{labeldx}{dimension}{The X offset between the way point position and
  the label anchor. The default value is computed from the values in the
  {\tt labeldistance} and {\tt labelangle} attributes.}
\attribute{labeldy}{dimension}{The Y offset between the way point position and
  the label anchor. The default value is computed from the values in the
  {\tt labeldistance} and {\tt labelangle} attributes.}
\attribute{labelformat}{labelformat}{Geometry of the label fields. The default
  value is {\tt ""} which means that no label will be displayed.}
\attribute{leaderanchors}{leaderanchors}{The attachments of the leader on the
  label side. The default value is {\tt ""} which means that both leader anchors are
  at the label center.}
\attribute{leadercolor}{gradientcolor}{The color of the label leader. The default value
  is the current value of the widget option \ident{-foreground}.}
\attribute{leaderfirstend}{lineend}{Describe the arrow shape at the current position
  end of the leader. The default value is {\tt ""}.}
\attribute{leaderlastend}{lineend}{Describe the arrow shape at the label end of
  the leader. The default value is {\tt ""}.}
\attribute{leadersensitive}{boolean}{Specifies if the label leader is sensitive.
  The actual sensitivity is the logical \ident{and} of this attribute and of the item
  {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{leadershape}{lineshape}{The shape of the label leader. The default
  value is {\tt straight}.}
\attribute{leaderstyle}{linestyle}{The line style of the label leader. The
  default value is {\tt simple}.}
\attribute{leaderwidth}{dimension}{The width of the label leader. The default
  value is {\tt 1}.}
\attribute{markercolor}{gradientcolor}{The color of the circular marker. The default
  value is the current value of the widget option \ident{-foreground}.}
\attribute{markerfillpattern}{bitmap}{The pattern to use when filling the circular
  marker. The default value is {\tt ""}.}
\attribute{markersize}{number}{The (scale sensitive) size of the circular marker.
  The default value is {\tt 0} which turn off the display of the marker.}
\attribute{markerstyle}{linestyle}{The line style of the marker outline. The
  default value is {\tt simple}.}
\attribute{numfields}{integer}{Gives the number of fields available for the label.
  This attribute is read only.}
\attribute{position}{position}{The current location of the way point. The default
  value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 4}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{symbol}{bitmap}{The symbol displayed at the current position. The
  default value is {\tt AtcSymbol15}.}
\attribute{symbolcolor}{gradientcolor}{The color of the symbol displayed at the current
  position. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{symbolsensitive}{boolean}{Specifies if the current position's symbol
  is sensitive to events. The actual sensitivity is the logical \ident{and} of this attribute
  and of the item {\tt sensitive} attribute. The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{tabular}
\section{Tabular items}

Tabular items have been initially designed for displaying block of textual
information, organised in lists or spread out on a radar display.

A tabular item is mainly composed of a {\bf label} which
 is a block of texts described by a labelformat (see chapter
 \conceptref{Labels, fields and Label formats}{labelformat}.
 Each text can have its graphic decorations (alignment, background, images, borders...).
 This attributes are listed in the chapter \conceptref{Labels, label formats and fields}{labelformat}
 and can be changed by the command \cmdref{itemconfigure}.

Applicable attributes for \ident{tabular} are:

\attribute{anchor}{anchor}{The anchor used in positionning the item. The default
  value is {\tt nw}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this item
  is placed. The default value is {\tt ""}.}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected item.
  The default value is {\tt sw}.}
\attribute{labelformat}{labelformat}{Geometry of the label fields. The default
  value is {\tt ""} which means that nothing will be displayed.}
\attribute{numfields}{integer}{Gives the number of fields available for the
  label. This attribute is read only.}
\attribute{position}{position}{The item's position relative to the anchor
  (if no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 3}. }
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{text}
\section{Text items}

Text items are used for displaying text. They can also be used for text input.
 In this case, they must get the focus for keyboards events with the command \cmdref{focus}.
 Many \ident{zinc} options (see chapter \conceptref{Widget options}{options} can be used
 for configuring the text input (for example : \refopt{insertbackground}, \refopt{insertofftime}
 \refopt{insertontime}, \refopt{insertwidth}).

Applicable attributes for \ident{text} are:

\attribute{alignment}{alignment}{Specifies the horizontal alignment of the
  lines in the item. The default value is {\tt left}.}
\attribute{anchor}{anchor}{The anchor used in positionning the item. The default
  value is {\tt nw}.}
\attribute{color}{gradientcolor}{Specifies the color for drawing the text characters,
  the overstrike and underline lines. The default value is the current value
  of the widget option \ident{-foreground}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this item
  is placed. The default value is {\tt ""}.}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected item.
  The default value is {\tt sw}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern used to draw the text
  characters, the overstrike and underline lines. The default value is {\tt ""}.}
\attribute{font}{font}{Specifies the font for the text. The default value is
  the current value of the widget option \ident{-font}.}
\attribute{overstriked}{boolean}{If true, a thin line will be drawn horizontally
  across the text characters. The default value is {\tt false}.}
\attribute{position}{position}{The item's position relative to the anchor
  (if no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{spacing}{dimension}{Specifies a pixel value that will be added to
  the inter-line spacing specified in the font. The value can be positive to
  increase the spacing or negative to reduce it. The default value is {\tt 0}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{text}{string}{Specifies the text characters. Newline characters can
  be embedded to force line ends. The default value is {\tt ""}.}
\attribute{underlined}{boolean}{If true, a thin line will be drawn under the
  text characters. The default value is {\tt false}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}
\attribute{width}{dimension}{Specifies the maximum pixel width of the text, a
  line break will be automatically inserted at the closest character position to
  match this constraint. If the value is zero, the width is not under the item
  control and line breaks must be inserted in the text to have multiple lines.
  The default value is {\tt 0}.}


\object{icon}
\section{Icon items}

Icon items are used for XXX.

Applicable attributes for \ident{icon} are:

\attribute{anchor}{anchor}{The anchor used in positionning the item. The default
  value is {\tt nw}.}
\attribute{color}{gradientcolor}{Specifies the fill color used for drawing the bitmap.
  The default value is the current value of the widget option \ident{-foreground}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
  should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this
  item is placed}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected item.
  The default value is {\tt sw}.}
\attribute{image}{image}{Specifies a Tk image that will be displayed by the item.
  The image may have a mask (depend on the image format) that clip some parts. This
  option has precedence over the {\tt mask} option if both are specified. The
  default value is {\tt ""}.}
\attribute{mask}{bitmap}{Specifies a Tk bitmap that will be displayed by the
  item. The bitmap is filled with the color specified with the {\tt color} option.
  This option is inactive if an image has been specified with the {\tt image} option.}
\attribute{position}{position}{The item's position relative to the anchor (if
  no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{reticle}
\section{Reticle items}

Reticle items are used for XXX.

Applicable attributes for \ident{reticle} are:

\attribute{brightlinecolor}{gradientcolor}{This is the color of the highlighted
  circles. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{brightlinestyle}{linestyle}{This is the line style of the highlighted
  circles. The default value is {\tt simple}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{firstradius}{number}{This is the radius of the innermost circle of
  the reticle. The default value is {\tt 80}.}
\attribute{linecolor}{gradientcolor}{This is the color of the regular (not highlighted)
  circles. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{linestyle}{linestyle}{This is the line style of the regular (not
  highlighted) circles. The default value is {\tt simple}.}
\attribute{numcircles}{integer}{Specifies how many circles should be drawn.
  The default value is {\tt -1} which means draw as many circles as needed to
  encompass the current widget window. This does not take into account any possible
  clipping that can mask part of the reticle. The idea behind this trick is to draw
  an infinite reticle that is optimized for the current scale.}
\attribute{period}{integer}{Specifies the recurrence of the bright circles over
  the regulars. The default value is {\tt 5} which means that a bright circle is
  drawn then 4 regulars, etc.}
\attribute{position}{position}{Location of the center of the reticle. The default
  value is {\tt "0 0"}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt false} as the item cannot handle events.}
\attribute{stepsize}{number}{The (scale sensitive) size of the step between two
  consecutive circles. The default value is {\tt 80}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{map}
\section{Map items}


Map items are used for XXX.

  Applicable attributes for \ident{map} are:

\attribute{color}{gradientcolor}{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.
  The default value is the current value of the widget option \ident{-foreground}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{filled}{boolean}{If set to true the map wil be filled otherwise it
  will be drawn as thin lines. The default is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to be used when filling
  the map. The value should be a legal Tk bitmap. The default value is {\tt "}.}
\attribute{font}{font}{Specifies the font that will be used to drawn the texts of
  the map.  The default value is the current value of the widget option -maptextfont.}
\attribute{mapinfo}{mapinfo}{Specifies the lines, texts, symbols and other
  various graphical components that should be displayed by the map item. All these
  graphical components will share the graphical attributes (color, font, etc) of
  the item and its coordinate system. The default value is {\tt ""} which means
  that nothing will be displayed by the map.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 1}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt false} as the item cannot handle events.}
\attribute{symbols}{bitmaplist}{}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{rectangle}
\section{Rectangle items}


  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} are:

\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{fillcolor}{gradientcolor}{Specifies the color that will be used to fill
  the rectangle if requested by the \ident{filled} attribute. The default value is a
  one color gradient based on the current value of the widget option \ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
  value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
  item. The default value is {\tt ""}.}
\attribute{linecolor}{gradientcolor}{Specifies the color that will be used to draw
  the item outline. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
  outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
  the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
  scalable). The default value is {\tt 1}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{relief}{relief}{Specifies the relief used to drawn the rectangle
  outline. This attribute has priority over the \ident{linecolor}, \ident{linepattern}
  and \ident{linestyle} attributes. The default value is {\tt flat}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
  tiles. This will be done only if filling is requested by the \ident{filled} attribute.
  This attribute has priority over the \ident{fillcolor} attribute and the \ident{fillpattern}
  attribute. The default value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{arc}
\section{Arc items}


  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. The first point
  should be the top left vertex of the rectangle and the second should be the
  bottom right.

  Applicable attributes for \ident{arc} are:

\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.
  The default value is {\tt false}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{extent}{angle}{Specifies the angular extent of the arc relative to the
  start angle. The angle is expressed in degrees in the trigonometric system. The
  default value is {\tt 360}.}
\attribute{fillcolor}{gradientcolor}{ Specifies the color that will be used to fill
  the arc if requested by the \ident{filled} attribute. The default value is a
  one color gradient based on the current value of the widget option
  \ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
  value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
  item. The default value is {\tt ""}.}
\attribute{firstend}{lineend}{Describe the arrow shape at the start end of
  the arc. This attribute is applicable only if the item is not closed and not filled.
  The default value is {\tt ""}.}
\attribute{lastend}{lineend}{Describe the arrow shape at the extent end of
  the arc. This attribute is applicable only if the item is not closed and not filled.
  The default value is {\tt ""}.}
\attribute{linecolor}{gradientcolor}{Specifies the color that will be used to draw
  the item outline. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
  outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
  the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
  scalable). The default value is {\tt 1}.}
\attribute{pieslice}{boolean}{This attribute tells how to draw an arc whose
  extent is less than 360 degrees. If this attribute is true the arc open end
  will be drawn as a pie slice otherwise it will be drawn as a chord. The default
  value is {\tt false}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{startangle}{angle}{Specifies the arc starting angle. The angle is
  expressed in degrees in the trigonometric system. The default value is {\tt 0}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
  tiles. This will be done only if filling is requested by the \ident{filled} attribute.
  This attribute has priority over the \ident{fillcolor} attribute and the \ident{fillpattern}
  attribute. The default value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{curve}
\section{Curve items}


  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} are:

\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
  flat. The default value is {\tt round}.}
\attribute{closed}{boolean}{Specifies if the curve outline should be drawn
  between the first and last vertex or not. The default is {\tt true}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
  should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{fillcolor}{gradientcolor}{Specifies the color that will be used to fill
  the curve if requested by the \ident{filled} attribute. The default value is a
  one color gradient based on the current value of the widget option
  \ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
  value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
  item. The default value is {\tt ""}.}
\attribute{firstend}{lineend}{Describe the arrow shape at the start of the curve.
  This attribute is applicable only if the item is not closed, not filled and
  the relief of the outline is flat. The default value is {\tt ""}.}
\attribute{joinstyle}{joinstyle}{Specifies the form of the joint between the curve
  segments. This attribute is only applicable if the curve outline relief is flat.
  The default value is {\tt round}.}
\attribute{lastend}{lineend}{Describe the arrow shape at the end of the curve.
  This attribute is applicable only if the item is not closed, not filled and
  the relief of the outline is flat. The default value is {\tt ""}.}
\attribute{linecolor}{gradientcolor}{Specifies the color that will be used to draw
  the item outline. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
  outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
  the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
  scalable). The default value is {\tt 1}.}
\attribute{marker}{bitmap}{Specifies a bitmap that will be used to draw a mark at
  each vertex of the curve. This attribute is not applicable if the outline relief is
  not flat. The default value is {\tt ""} which means do not draw markers.}
\attribute{markercolor}{gradientcolor}{Specifies the color of the markers.
  The default value is the current value of the widget option \ident{-foreground}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{relief}{relief}{Specifies the relief used to drawn the curve
  outline. This attribute has priority over the \ident{linecolor}, \ident{linepattern}
  and \ident{linestyle} attributes. The default value is {\tt flat}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
  tiles. This will be done only if filling is requested by the \ident{filled} attribute.
  This attribute has priority over the \ident{fillcolor} attribute and the
  \ident{fillpattern} attribute. The default value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{bezier}
\section{Bezier items}


  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} are:

\attribute{capstyle}{capstyle}{Specifies the form of the outline ends. This
  attribute is only applicable if the bezier is not closed and the outline relief is
  flat. The default value is {\tt round}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{fillcolor}{gradientcolor}{Specifies the color that will be used to fill
  the bezier if requested by the \ident{filled} attribute. The default value is a
  one color gradient based on the current value of the widget option
  \ident{-foreground}.}
\attribute{filled}{boolean}{Specifies if the item should be filled. The default
  value is {\tt false}.}
\attribute{fillpattern}{bitmap}{Specifies the pattern to use when filling the
  item. The default value is {\tt ""}.}
\attribute{firstend}{lineend}{Describe the arrow shape at the start of the bezier.
  This attribute is applicable only if the item is not filled and the relief of the
  outline is flat. The default value is {\tt ""}.}
\attribute{lastend}{lineend}{Describe the arrow shape at the end of the bezier.
  This attribute is applicable only if the item is not filled and the relief of the
  outline is flat. The default value is {\tt ""}.}
\attribute{linecolor}{gradientcolor}{Specifies the color that will be used to draw
  the item outline. The default value is the current value of the widget option
  \ident{-foreground}.}
\attribute{linepattern}{bitmap}{Specifies the pattern to use when drawing the
  outline. The default value is {\tt ""}.}
\attribute{linestyle}{linestyle}{Specifies the line style to use when drawing
  the outline. The default value is {\tt simple}.}
\attribute{linewidth}{dimension}{Specifies the with of the item outline (not
  scalable). The default value is {\tt 1}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{relief}{relief}{Specifies the relief used to drawn the bezier
  outline. This attribute has priority over the \ident{linecolor}, \ident{linepattern}
  and \ident{linestyle} attributes. The default value is {\tt flat}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{tile}{image}{Specifies an image used for filling the item with
  tiles. This will be done only if filling is requested by the \ident{filled} attribute.
  This attribute has priority over the \ident{fillcolor} attribute and the
  \ident{fillpattern} attribute. The default value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{triangles}
\section{Triangles items}


 Triangles items are used for XXX.

 Applicable attributes for \ident{triangles} are:

\attribute{colors}{gradientarray}{Specifies the colors of each vertex of the triangles XXX.}
\attribute{composerotation}{boolean}{Specifies if the current rotation should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should be
  composed with the local transform. The default value is {\tt true}.}
\attribute{fan}{fantype}{XXX. The default value is {\tt XXX}.}
\attribute{priority}{integer}{The absolute position in the stacking order among
  siblings of the same parent group. The default value is {\tt 2}.}
\attribute{sensitive}{boolean}{Specifies if the item should react to events.
  The default value is {\tt true}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}


\object{window}
\section{Window items}

  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
  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,
  can be set or read with the \ident{coords} command (i.e. if no connected item
  is specified).

  One of the most frequent use of this item is to embed any Tk widget
  into zinc, including, of course, another zinc instance. Another less obvious
  use is to embed a whole Tk application into zinc, here is how to do it:
  The embedding application should create a frame with the \ident{-container}
  option set to true; Add a window item to the relevant zinc widget with the
  \ident{window} attribute set to the id of the container frame; The embedded
  application should create its toplevel with the \ident{-use} option set to
  the id of the container frame; Or, as an alternative, the embedded \cident{wish}
  can be launched with the \ident{-use} option set to the container frame id.
  
Applicable attributes for \ident{window} are:

\attribute{anchor}{anchor}{The anchor used in positionning the item.
  The default value is {\tt nw}.}
\attribute{composerotation}{boolean}{Specifies if the current rotation
  should be composed with the local transform. The default value is {\tt true}.}
\attribute{composescale}{boolean}{Specifies if the current scale should
  be composed with the local transform. The default value is {\tt true}.}
\attribute{connecteditem}{item}{Specifies the item relative to which this
  item is placed. The default value is {\tt ""}.}
\attribute{connectionanchor}{anchor}{Specifies the anchor on the connected
  item used for the placement. The default value is {\tt sw}.}
\attribute{height}{dimension}{Specifies the height of the item window in
  screen units. The default value is {\tt 0}.}
\attribute{position}{position}{The item's position relative to the anchor
  (if no connected item specified). The default value is {\tt "0 0"}.}
\attribute{priority}{integer}{Constraints of the underlying window sytem
  dictate the stacking order of window items. They can't be lowered under the
  other items. Additionally, to manipulate their stacking order, you must use
  the raise and lower Tk commands on the associated Tk window. The value of this
  attribute is meaningless.}
\attribute{sensitive}{boolean}{This option has no effect on window items.
  The default value is {\tt False}.}
\attribute{tags}{taglist}{The list of tags associated with the item. The default
  value is {\tt ""}.}
\attribute{visible}{boolean}{Specifies if the item is displayed. The default
  value is {\tt true}.}
\attribute{width}{dimension}{Specifies the width of the item window in
  screen units. The default value is {\tt 0}.}
\attribute{window}{window}{Specifies the X id of the window that is displayed
  by the item. This id can be obtained by the Tk command \ident{winfo id widgetname}.
  The default value is {\tt ""}.}


<<<<<<< variant A
\concept{mapinfocmds}
\chapter{The mapinfo commands}
>>>>>>> variant B
\chapter{The mapinfo command}
\label{mapinfocmd}
####### Ancestor
\chapter{The \ident{mapinfo} command}
\label{mapinfocmd}
======= end

  MapInfo objects are used to describe graphical primitives that will be
  displayed in map items. It is possible to describe lines, arcs, symbols
  and texts as part of a MapInfo. The \ident{mapinfo} and \ident{videomap}
  commands are provided to create and manipulate the mapinfo objects.
  
\begin{quotation}
  {\tt\large zinc pathname ?options?}\\
  {\tt\large \$mainwindow->{\bf zinc}(?option=>value?, ..., ?option=>value?);}
\end{quotation}

\mapinfocmd{name}{create}{}
\begin{blockindent}
  Create a new empty map description. The new mapinfo object named {\tt name}.
\end{blockindent}

\mapinfocmd{mapInfoName}{delete}{}
\begin{blockindent}
  Delete the mapinfo object named by {\tt mapInfoName}. All maps that refer to
  the deleted mapinfo are updated to reflect the change.
\end{blockindent}

\mapinfocmd{mapInfoName}{duplicate}{newName}
\begin{blockindent}
  Create a new mapinfo that is a exact copy of the mapinfo named {\tt mapInfoName}.
  The new mapinfo object will be named {\tt newName}.
\end{blockindent}

\mapinfocmd{name}{add}{type args}
\begin{blockindent}
  Add a new graphical element to the mapinfo object named by {\tt name}. The
  {\tt type} parameter select which element should be added while the {\tt args}
  arguments provide some type specific values such as coordinates. Here is
  a description of recognized types and their associated parameters.
  
  \begin{description}
  \item{line} \\
    This element describes a line segment. Its parameters consists in a line
    style ({\tt simple}, {\tt dashed}, {\tt dotted}, {\tt mixed}, {\tt marked}),
    an integer value setting the line width in pixels and four integer values
    setting the X and Y coordinates of the two end vertices.
  \item{arc} \\
    This element describes an arc segment. Its parameters consists in a line
    style ({\tt simple}, {\tt dashed}, {\tt dotted}, {\tt mixed}, {\tt marked}),
    an integer value setting the line width in pixels, two integer values
    setting the X and Y of the arc center, integer value setting the arc radius
    and two integer values setting the start angle and the angular extent of the
    arc.
  \item{symbol} \\
    This element describes a symbol. Its parameters consists in two integer values
    setting the X and Y of the symbol position and an integer setting the symbol
    index in the {\tt -symbols} list of the map item.
  \item{text} \\
    This element describes a line of text. Its parameters consists in a text style
    ({\tt normal}, {\tt underlined}), a line style ({\tt simple}, {\tt dashed},
    {\tt dotted}, {\tt mixed}, {\tt marked}) to be used for the underline, two
    integer values setting the X and Y of the text position and a string describing
    the text.
  \end {description}
  
\end{blockindent}

\mapinfocmd{name}{count}{type}
\begin{blockindent}
  Return an integer value that is the number of elements matching {\tt type} in
  the mapinfo named {\tt name}. {\tt type} may be one the legal element types as
  described in the {\tt mapinfo add} command.
\end{blockindent}

\mapinfocmd{name}{get}{type index}
\begin{blockindent}
  Return the parameters of the element at {\tt index} with type {\tt type}
  in the mapinfo named {\tt name}. The returned value is a list. The exact
  number of parameters in the list and their meaning depend on {\tt type}
  and is accurately described in \ident{mapinfo add}. {\tt type} may be one
  the legal element types as described in the {\tt mapinfo add} command.
  Indices are zero based and elements are listed by type.
\end{blockindent}

\mapinfocmd{name}{replace}{type index args}
\begin{blockindent}
  Replace all parameters for the element at {\tt index} with type {\tt type}
  in the mapinfo named {\tt name}. The exact number and content for {\tt args}
  depend on {\tt type} and is accurately described in \ident{mapinfo add}.
  {\tt type} may be one the legal element types as described in the
  {\tt mapinfo add} command. Indices are zero based and elements are listed
  by type.
\end{blockindent}

\mapinfocmd{name}{remove}{type index}
\begin{blockindent}
  Remove the element at {\tt index} with type {\tt type} in the mapinfo
  named {\tt name}. {\tt type} may be one the legal element types as
  described in the {\tt mapinfo add} command. Indices are zero based and
  elements are listed by type.
\end{blockindent}

\mapinfocmd{name}{scale}{factor}
\begin{blockindent}
  Scale all coordinates of all the elements described in the mapinfo named
  {\tt name} by {\tt factor}. The same value is used for X and Y axes.
\end{blockindent}

\mapinfocmd{name}{translate}{xAmount yAmount}
\begin{blockindent}
  Translate all coordinates of all the elements described in the mapinfo named
  {\tt name}. The {\tt xAmount} value is used for the X axis and the
  {\tt yAmount} value is used for the Y axis.
\end{blockindent}



<<<<<<< variant A
\concept{videomapcmds}
\chapter{The videomap commands}
>>>>>>> variant B
\chapter{The videomap command}
####### Ancestor
\chapter{The \ident{videomap} command}
======= end

\command{videomap}{ids}{fileName}
\begin{blockindent}
  Return all sub-map ids that are described in the videomap file described
  by {\tt fileName}. The ids are listed in file order. This command makes
  possible to iterate through a videomap file one sub-map at a time, to know
  how much sub-maps are there and to sort them according to their ids.
\end{blockindent}

\command{videomap}{load}{fileName index mapInfoName}
\begin{blockindent}
  Load the videomap sub-map located at position {\tt index} in the file named
  {\tt fileName} into a mapinfo object named {\tt mapInfoName}. It is possible,
  if needed, to use the \ident{videomap ids} command to help translate a sub-map
  id into a sub-map file index.
\end{blockindent}



\concept{otherresources}
\chapter{Other resources provided by the widget}

\section{Bitmaps}
\label{builtinbitmaps}

Zinc creates two sets of bitmaps.

The first set contains symbols for ATC tracks, maps and
waypoints, these bitmaps are named AtcSymbol1 to AtcSymbol22.

<<<<<<< variant A
\ifpdf
  \includegraphics{atcsymb}
\else
\latexhtml{
>>>>>>> variant B
\ifpdf
  \includegraphics{atcsymb}
\else
\latexhtml{%
  \includegraphics{atcsymb.ps}}{%
####### Ancestor
\latexhtml{%
  \includegraphics{atcsymb.ps}}{%
======= end
  \htmladdimg{atcsymb.png}
  }
\fi

The second set provides stipples that can be used to implement
transparency, they are named AlphaStipple0 to AlphaStipple15,
AlphaStipple0 being the most transparent.

<<<<<<< variant A
\ifpdf
  \includegraphics{alphastip}
\else
\latexhtml{
>>>>>>> variant B
\ifpdf
  \includegraphics{alphastip}
\else
\latexhtml{%
  \includegraphics{alphastip.ps}}{%
####### Ancestor
\latexhtml{%
  \includegraphics{alphastip.ps}}{%
======= end
  \htmladdimg{alphastip.png}
  }
\fi

\ifpdf\else\latex {\tolerance 2000  %allow somewhat looser lines.
  \hbadness 10000 }                 %don't complain about underfull lines.
\fi


\section{ZincDebug.pm}

\ident{ZincDebug.pm} is a perl module useful for debugging purpose. It can be used
in a perl application using \ident{zinc} to grab items with the mouse and to get
the list of items enclosed or overlapped by a rectangle designated by the mouse.
Please refer to the \ident{ZincDebug.pm} with the classical command \tt{man ZincDebug}

\section{zinc-demo}

Starting at version 3.2.4 of \ident{zinc} small applications are included as demos. They are all
accessible through an application called \ident{zinc-demos}. These tiny demos are
usefull for newcomers and as starting points.

\listoftables
\listoffigures

\printindex

\label{interne:DernierePage}


\end{document}