aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorlecoanet2002-02-15 10:16:06 +0000
committerlecoanet2002-02-15 10:16:06 +0000
commite54ebcb2600097665e7e4dd67c70fdb031447c44 (patch)
treeaab7cc71c225040943217297f75e0e14c44062ab /doc
parentacae90214892628ced469c4fed5bf2e1d2bd8aef (diff)
downloadtkzinc-e54ebcb2600097665e7e4dd67c70fdb031447c44.zip
tkzinc-e54ebcb2600097665e7e4dd67c70fdb031447c44.tar.gz
tkzinc-e54ebcb2600097665e7e4dd67c70fdb031447c44.tar.bz2
tkzinc-e54ebcb2600097665e7e4dd67c70fdb031447c44.tar.xz
Correction de la doc des gradients.
Ajout des nouveaux attributs de track.
Diffstat (limited to 'doc')
-rw-r--r--doc/refman.tex113
1 files changed, 58 insertions, 55 deletions
diff --git a/doc/refman.tex b/doc/refman.tex
index 8355590..3a515cd 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -475,7 +475,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag above tagOrId ?inGroup? ?recursive?\\
\$zinc->{\bf addtag}(tag, 'above', tagOrId, ?inGroup?, ?recursive?);
- \smallskip}}
+ \smallskip}}
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
@@ -488,7 +488,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag all ?inGroup? ?recursive?\\
\$zinc->{\bf addtag}(tag, 'all', tagOrId, ?inGroup?, ?recursive?);
- \smallskip}}
+ \smallskip}}
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
@@ -497,7 +497,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag atpriority priority ?inGroup? ?recursive?\\
\$zinc->{\bf addtag}(tag, 'atpriority', priority, ?inGroup?, ?recursive?);
- \smallskip}}
+ \smallskip}}
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
@@ -506,7 +506,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag below tagOrId ?inGroup? ?recursive?\\
\$zinc->{\bf addtag}(tag, 'below', tagOrId, ?inGroup?, ?recursive?);
- \smallskip}}
+ \smallskip}}
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
@@ -519,7 +519,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag closest x y ?halo? ?startItem?\\
\$zinc->{\bf addtag}(tag, 'closest', x, y, ?halo?, ?startItem?);
- \smallskip}}
+ \smallskip}}
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
@@ -532,7 +532,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag enclosed xo yo xc yc\\
\$zinc->{\bf addtag}(tag, 'enclosed', xo, yo, xc, yc);
- \smallskip}}
+ \smallskip}}
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
@@ -546,7 +546,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag overlapping xo yo xc yc\\
\$zinc->{\bf addtag}(tag, 'overlapping', xo, yo, xc, yc);
- \smallskip}}
+ \smallskip}}
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
@@ -556,7 +556,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag withtag tagOrId ?inGroup? ?recursive?\\
\$zinc->{\bf addtag}(tag, 'withtag', tagOrId, ?inGroup?, ?recursive?);
- \smallskip}}
+ \smallskip}}
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
@@ -565,7 +565,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf addtag} tag withtype type ?inGroup? ?recursive?\\
\$zinc->{\bf addtag}(tag, 'withtype', tagOrId, ?inGroup?, ?recursive?);
- \smallskip}}
+ \smallskip}}
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
@@ -808,14 +808,14 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf coords} tagOrId contourIndex\\
@coords = \$zinc->{\bf coords}(tagOrId, contourIndex);
- \smallskip}}
+ \smallskip}}
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);
- \smallskip}}
+ \smallskip}}
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,
@@ -826,7 +826,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf coords} tagOrId contourIndex coordIndex\\
@(\$x, \$y) = \$zinc->{\bf coords}(tagOrId, contourIndex, coordIndex);
- \smallskip}}
+ \smallskip}}
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.
@@ -835,7 +835,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf coords} tagOrId contourIndex coordIndex coordList\\
\$zinc->{\bf coords}(tagOrId, contourIndex, coordIndex, coordList);
- \smallskip}}
+ \smallskip}}
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.
@@ -844,21 +844,21 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf coords} tagOrId remove contourIndex coordIndex\\
\$zinc->{\bf coords}(tagOrId, 'remove', contourIndex, coordIndex);
- \smallskip}}
+ \smallskip}}
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);
- \smallskip}}
+ \smallskip}}
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\\
+ {\tt\large pathname {\bf coords} tagOrId add contourIndex coordIndex coordList\\
\$zinc->{\bf coords}(tagOrId, 'add', contourIndex, coordIndex, coordList);
- \smallskip}}
+ \smallskip}}
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}
@@ -869,25 +869,25 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf coords} tagOrId\\
@coords = \$zinc->{\bf coords}(tagOrId);
- \smallskip}}
+ \smallskip}}
Get all coordinates of contour 0. See first form.
\item{\bigskip
{\tt\large pathname {\bf coords} tagOrId coordList\\
\$zinc->{\bf coords}(tagOrId, coordList);
- \smallskip}}
+ \smallskip}}
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);
- \smallskip}}
+ \smallskip}}
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);
- \smallskip}}
+ \smallskip}}
Add coordinates at the end of contour 0. See sixth form.
\end{description}
\end{blockindent}
@@ -1301,7 +1301,7 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf select} adjust tagOrId index\\
\$zinc->{\bf select}('adjust', tagOrdId, index);
- \smallskip}} \\
+ \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
@@ -1311,13 +1311,13 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf select} clear\\
\$zinc->{\bf select}('clear');
- \smallskip}} \\
+ \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}} \\
+ \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
@@ -1326,13 +1326,13 @@ reference) and all list parameters are given as array references.
\item{\bigskip
{\tt\large pathname {\bf select} item\\
\$item = \$zinc->{\bf select}('item');
- \smallskip}} \\
+ \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}} \\
+ \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
@@ -1551,11 +1551,8 @@ reference) and all list parameters are given as array references.
\attrtype{dimension}
\begin{blockindent}
- This is a string that represent a screen distance which will be converted
- into a distance in pixels. The string consists in a floating point signed
- number optionally followed by a character specifying the unit. The character
- can be {\tt c} for centimeters, {\tt i} for inches, {\tt m} for millimeters,
- {\tt p} for printer's points (1/72 inch) or nothing for pixels.
+ This is a string that represent distance. The string consists in a floating
+ point signed number.
\end{blockindent}
\attrtype{edgelist}
@@ -1589,32 +1586,35 @@ reference) and all list parameters are given as array references.
'|' characters.
The general pattern is:
- {\tt\large gradient\_step1|...|gradient\_stepn/angle\%steps} for an axial gradient
- and: {\tt\large gradient\_step1|...|gradient\_stepn(x y\%steps} for a radial
- gradient.
+ {\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 steps section describes how many steps should be used for each
- gradient segment. This section is optional and the default number of steps is 6.
- The last gradient segment has only one step which is exactly the specified color.
- Thus a gradient with two segments and the default number of steps will have a total
- of seven shades while a gradient with three segments will have a total of thirteen
- shades.
+ The /angle section tells that the gradient is an axial gradient and give the
+ angle of the gradient.
- The /angle section describe the optional angle in degrees for an axial gradient,
- its default value is zero. For the moment only angles of 0, 90, 180 and 270
- can be specified, the others values are unimplemented.
+ The (x y section tells that the gradient is a radial gradient and give the
+ center of the gradient.
- The (x y section describes the center for a radial
- gradient and at the same it specifies that the gradient should be radial. The default
- gradient is axial.
+ 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 color\_position mid\_span\_position}
+ {\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 (excepted for
- the last segment which describes the end color). The first gradient segment
- has its position set to zero and the last segment has its position set to 100.
+ 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.
@@ -1623,10 +1623,8 @@ reference) and all list parameters are given as array references.
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 the color position
- is automatically set to 0 for the first segment and to 100 for the last. All intermediate
- segments have their color psotion set to zero. It is of no use with these rules to
- use more than two segments.
+ A gradient segment can be specified as a single color. In this case a flat uniform fill
+ will result.
\end{blockindent}
\attrtype{image}
@@ -1980,11 +1978,16 @@ Applicable attributes for \ident{track}:
\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}{color}{The color of the trck's speed vector. The
+\attribute{speedvectorcolor}{color}{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 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{symbol}{bitmap}{The symbol displayed at the current position. The
default value is {\tt AtcSymbol15}.}
\attribute{symbolcolor}{color}{The color of the symbol displayed at the current