From d152ae6f8789409bb996f4c3fa68092efee7b4f4 Mon Sep 17 00:00:00 2001 From: mertz Date: Fri, 12 Apr 2002 13:29:16 +0000 Subject: *** empty log message *** --- doc/refman.tex | 662 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 360 insertions(+), 302 deletions(-) (limited to 'doc/refman.tex') diff --git a/doc/refman.tex b/doc/refman.tex index 4d86766..7f63d09 100644 --- a/doc/refman.tex +++ b/doc/refman.tex @@ -117,8 +117,8 @@ \hyperref[page]{\ident{#1}}{\ident{#1} (}{)}{obj:#1}} } -\newcommand{\refopt}[1]{% - \latexhtml{\ifpdf\hyperlink{opt.#1}{\ident{-#1}}\ident{-#1}\fi}{% +\newcommand{\optref}[1]{% + \latexhtml{\ifpdf\hyperlink{opt.#1}{\ident{-#1}}\fi}{% \hyperref[page]{\ident{-#1}}{\ident{-#1} (}{)}{opt:#1}} } @@ -201,7 +201,7 @@ \title{Zinc, an advanced scriptable Canvas.\\The 3.2.4 Reference Manual.} \author{Patrick Lecoanet} -\date{15 March 2002} +\date{11 April 2002} \begin{document} @@ -313,11 +313,11 @@ Zinc widget. They are used for creating, modifying or deleting objects, applying transformations ... The chapter \conceptref{Item types}{items} describes all the items provided by Zinc along with their attributes. -The chapter \conceptref{Labels, fields and labelformat}{labelsandfields} describes the +The chapter \conceptref{Labels, label format, and fields}{labelsandfields} describes the use of labels, the possible attributes of fields and finally the labelformat syntax. The chapter \conceptref{Attributes types}{types} describes the legal form of all item attributes. -The chapter \conceptref{The mapinfo commands}{mapinfocmds} introduces the mapinfo, a +The chapter \conceptref{The mapinfo related commands}{mapinfocmds} introduces the mapinfo, a simple map description structure, and describes the commands used to create and manipulate mapinfos. Finally the chapter \conceptref{Other resources provided by the widget}{otherresources} @@ -386,7 +386,7 @@ of Zinc. This documentation has been enriched by Christophe Mertz. If you are stuck with a feature you don't understand. If you don't know how to do something with Zinc. If you think you have found a bug or a mismatch between -the documentation an the behavior of the widget. Please feel free to contact us. +the documentation and the behavior of the widget. Please feel free to contact us. Mail either {\tt lecoanet@cena.fr} or the Zinc mailing list. To subscribe to the mailing list, please consult the site \anurl{http://www.openatc.org/zinc}. @@ -439,7 +439,7 @@ groups created themselves in the top group. Together the items form a tree roote at the root group, hence its name. The chapter \conceptref{Groups, Display List and Transformations}{coordinates} describes the use of groups. The chapter \conceptref{Item ids, tags and indices}{tagOrId} -describes the item ids. +describes the item ids, often used as command argument. The options are used to configure how the newly created widget will behave. They can be changed later by using the \cmdref{configure} and \cmdref{cget} @@ -456,21 +456,23 @@ database to modify the global behavior of the widget. Available options are described below. +\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 color attributes. See each color attribute for the + actual source of the default color. Its default value is \verb+#c3c3c3+, a light grey. +\end{blockindent} + +%% XXX CM A ajouter!! \option{bboxcolor}{bboxColor}{BBoxColor} + \option{borderwidth}{borderWidth}{BorderWidth} \begin{blockindent} Specifies the width of the 3d border that should be displayed around the widget window. This border does overlap the active Zinc display area. The area requested from the geometry manager (or the window manager if applicable) - is the area defined by \refopt{width} and \refopt{height}, the border is not + is the area defined by \optref{width} and \optref{height}, the border is not taken into account. 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 color attributes. See each color attribute for the - actual source of the default color. Its default value is \verb+#c3c3c3+, a light grey. + coordinates (See \cident{TkGet\_Pixels}). The default value is \verb+2+. \end{blockindent} \option{cursor}{cursor}{Cursor} @@ -479,44 +481,46 @@ described below. value is set to preserve the cursor inherited at widget creation. \end{blockindent} +%% XXX CM A ajouter!! \option{drawbboxes}{drawBBoxes}{DrawBBoxes} + \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-*-*-*-*-*-*. + type font. Its default value is \verb+-adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*+. \end{blockindent} -\option{forecolor}{foreColor}{ForeColor} +\option{forecolor}{foreColor}{ForeColor} %% XXX CM Foreground ?! \begin{blockindent} The color specified by this option is used as a default color for many item color attributes. See each each color attribute for the actual source of the default - color. Its default value is black. + color. Its default value is \verb+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. + level. See also the \optref{reshape} option, it controls whether a shape is applied + to the Zinc window or not. The default is \verb+true+. \end{blockindent} \option{height}{height}{Height} \begin{blockindent} Specifies the height of the Zinc window. This value can be given in any of the - forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is 100 + forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is \verb+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. + widget does not have the input focus. The default value is \verb+\#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. + around the widget when it has the input focus. The default value is \verb+black+. \end{blockindent} \option{highlightthickness}{highlightThickness}{HighlightThickness} @@ -524,34 +528,39 @@ described below. 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. + no focus highlight is drawn around the widget. The default value is \verb+2+. \end{blockindent} -\option{insertbackground}{insertBackground}{InsertBackground} +\option{insertbackground}{insertBackground}{InsertBackground} %% XXX CM Foreground ?! \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. + selection). The default value is \verb+black+. \end{blockindent} -\option{insertofftime}{insertOffTime}{InsertOffTime} +\option{insertofftime}{insertOffTime}{InsertOffTime} %% XXX CM OffTime ?! \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. + then the cursor is on all the time. The default value is \verb+300+. \end{blockindent} -\option{insertontime}{insertOnTime}{InsertOnTime} +\option{insertontime}{insertOnTime}{InsertOnTime} %% XXX CM OnTime ?! \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. + insertion cursor should remain on in each blink cycle. The default value is \verb+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. + any of the forms acceptable to \cident{Tk\_GetPixels}. The default value is \verb+2+. +\end{blockindent} + +\option{lightangle}{lightAngle}{LightAngle} +\begin{blockindent} + Specifies the lighting angle used when displaying relief. The default value is \verb+120+. %%% XXX CM to complete! \end{blockindent} \option{mapdistancesymbol}{mapDistanceSymbol}{MapDistanceSymbol} @@ -559,13 +568,13 @@ described below. 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{Other resources provided by the widget}{otherresources}). + value is \verb+AtcSymbol19+ (see \conceptref{Other resources provided by the widget}{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-*-*-*-*-*-*. + \verb+-adobe-helvetica-bold-r-normal--*-120-*-*-*-*-*-*+. \end{blockindent} \option{overlapmanager}{overlapManager}{OverlapManager} @@ -574,7 +583,7 @@ described below. 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). To disable the algorithm this option should - be set to 0. + be set to \verb+0+. \end{blockindent} \option{pickaperture}{pickAperture}{PickAperture} @@ -582,21 +591,22 @@ described below. 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. + \verb+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 \attrtyperef{relief} for a description of possible values). + (See \attrtyperef{relief} for a description of possible values). XXX what is the meaning + of this option. The default value is \verb+flat+. \end{blockindent} -\option{render}{render}{render} +\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 drawing with the GLX extension or - in plain X (to adapt the application code for example). The default value is False. + in plain X (to adapt the application code for example). The default value is \verb+false+. \end{blockindent} \option{reshape}{reshape}{Reshape} @@ -604,21 +614,21 @@ described below. 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. + default value is \verb+true+. \end{blockindent} -\option{selectbackground}{selectBackground}{SelectBackground} +\option{selectbackground}{selectBackground}{SelectBackground} %% XXX CM Foreground ?! \begin{blockindent} Specifies the background color to use for displaying the selection in text - items. The default value is \#a0a0a0. + items. The default value is \verb+\#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 (usually minutes) and kept - coherent with the unit of the track attribute \ident{speedvector} (usually nautic - mile / minutes). The default value is 3. + coherent with the unit of the track attribute \attributeref{track}{speedvector} (usually nautic + mile / minute). The default value is \verb+3+. \end{blockindent} \option{takefocus}{takeFocus}{TakeFocus} @@ -641,21 +651,22 @@ described below. the callbacks (part of the keyboard traversal 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 \verb+XXX+. \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). + background. The default value is \verb+""+ (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 should be maintained by the track items. See also the - \refopt{trackmanagehistory} option and the \ident{visiblehistorysize} track - attribute. The default value is 6. + \optref{trackmanagehistory} option and the \attributeref{track}{visiblehistorysize} track + attribute. The default value is \verb+6+. \end{blockindent} \option{trackmanagehistory}{trackManageHistory}{TrackManageHistory} @@ -665,10 +676,10 @@ described below. 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 + \optref{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 + \attributeref{track}{visiblehistorysize} attribute. The default is to enable the history collection. \end{blockindent} @@ -676,7 +687,7 @@ described below. \begin{blockindent} Specifies the width of the Zinc window. This value can be given in any of the forms valid for coordinates (See \cident{Tk\_GetPixels}). The default is - 100 pixels. + \verb+100+ pixels. \end{blockindent} @@ -729,7 +740,7 @@ The following attributes are composed down the item tree to form the resulting attribute value in the leaf items: \begin{itemize} \item\ident{-sensitive}: the sensitivity (to keyboards or mouse event) of an - item is the result of and-ing together the \ident{-sensitive} attributes + item is the result of and-ding together the \ident{-sensitive} attributes found when descending from the root group to a specific leaf item. set at the group level, \item\ident{-visible}: the visibility of an item is the result of and-ing together @@ -741,7 +752,7 @@ resulting attribute value in the leaf items: of this item. The transparency is a percentage between 0 and 100, two transparencies are combined by multiplying both and then dividing by 100. The transparency can be used only if the environment support openGL and if - the widget was created with the \refopt{render} option set to True. + the widget was created with the \optref{render} option set to True. \end{itemize} @@ -867,11 +878,11 @@ When dealing with mouse events and other sources of window coordinates, it is often useful to map the window coordinates to an appropriate coordinate space. The command \cmdref{transform} is just what is needed to do so. It is powerful enough to be able to convert coordinates from any coordinate space to any other. A special provision -has been made to facilitate conversion from winndow space to another space. The opposite +has been made to facilitate conversion from window space to another space. The opposite is not impossible but rely on a small trick: the root group transformation must be left as identity (the default at creation time). In this way, it is possible to use the root group -space, which is then the same as the window space, as the target space of the transform -command. +space, which is then the same as the window space, as the target space of the +\cmdref{transform} command. When a rotation or a scale appear in a transformation, all items do not behave exactly in @@ -880,27 +891,27 @@ position moves according to the rotation or the scaling factor. Here is how item to the scale and rotation factors of the transformation. \begin{itemize} -\item \ident{group} They have no graphical shape by themselves; -\item \ident{track} The position, past positions, speedvector are fully transformed. The - circular marker is transformed by the X scale factor, it remain always circular. The label +\item \objectref{group} They have no graphical shape by themselves; +\item \objectref{track} The position, past positions, speedvector are fully transformed. The + circular marker is transformed by the X scale factor, it always remains circular. The label position is computed relative to the new position and speedvector direction but is otherwise - rigid and its distance to the position is unchanged. -\item \ident{waypoint} The position is fully transformed. The label position is computed - relative to the new position and new rotation but is otherwise rigid and its distance to - the position is unchanged. -\item \ident{tabular}, \item \ident{text}, \ident{icon} Only the position (relative to the + rigid and its distance (in pixels) to the position is unchanged. +\item \objectref{waypoint} The position is fully transformed. The label position is computed + relative to the new position and new rotation but is otherwise rigid and its distance + (in pixels) to the position is unchanged. +\item \objectref{tabular}, \objectref{text}, \objectref{icon} Only the position (relative to the anchor) 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 +\item \objectref{reticle} Only the center and the spacing between circles are affected. +\item \objectref{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 (relative to the anchor) is affected. +\item \objectref{rectangle}, \objectref{arc}, \objectref{curve}, and \objectref{bezier} are fully transformed. +\item \objectref{window} Only the position (relative to the anchor) is affected. \end{itemize} However, every item has a couple of attributes \ident{-composescale} and \ident{-composerotation} that can be used to control how the scale and rotation factors are inherited from the parents' transformations. These attributes default to \ident{true} -(i.e. rotation and scale from parents are meaningful. When one of these attributes are set +(i.e. rotation and scale from parents are meaningful. When one of these attributes is set to false the corresponding factor is reset from the inherited transformation. Scale factors are reset to 1.0 and rotation is reset to 0. Be careful that this applies to the inherited transformation, \emph{not} to the item transformation itself which is composed \emph{after} @@ -922,7 +933,7 @@ the shape of the clipping. All item types except \objectref{group}, \objectref{ \objectref{waypoint}, \objectref{reticle} and \objectref{map} can be used as clippers but the clipper must be a direct child of the clipped group. The clipper defines the shape of the clipping but is also drawn as a regular group item. It is typical to either mask -explicitly the clipper by turning off its \ident{visible} attribute or to fill and lower +explicitly the clipper by turning off its \ident{-visible} attribute or to fill and lower it so it can act as the background. Of course, other creative uses can be found but be warned that the clipper outline will never be easthetically drawn due to round off or quantization errors, it is better to turn off borders or outlines in this case. @@ -968,7 +979,7 @@ be the case with all commands, please report infringements). Everywhere a \ident{tagOrId} can be specified as a target for some action, it is possible to give a logical expression of tags and ids. The available boolean operators include logical and \verb+&&+, logical or \verb+||+, logical xor \verb+^+, logical not \verb+!+ -and subexpression grouping \verb+()+. Here is an example of a \ident{bbox} command +and subexpression grouping \verb+()+. Here is an example of a \cmdref{bbox} command called on a set of items defined by a logical expression. Note that tags and ids can be mixed. @@ -1136,9 +1147,10 @@ reference) and all list parameters are given as array references. \item{\bf triangles} \\ The triangles type expects a list of at least 6 floating point numbers \verb+x0 y0 x1 y1+ \verb+... 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 + composing this item. The triangles layout is defined by the attribute + \attributeref{triangles}{fan}. If \attributeref{triangles}{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 \attributeref{triangles}{fan} is false, the triangles are arranged in a strip. (XXX Afficher un diagramme avec l'ordre des sommets). \item{\bf tabular, track, waypoint} \\ @@ -1338,7 +1350,7 @@ reference) and all list parameters are given as array references. 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 + This widget command is similar to the Tk \ident{bind} command except that it operates on 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}, @@ -1384,7 +1396,7 @@ reference) and all list parameters are given as array references. {\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 +{\tt group}. If {\tt tagOrId} or {\tt group} describes 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 @@ -1660,7 +1672,8 @@ false. \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.\\ Example:\\ + various {\tt args}. The items are sorted in drawing order, topmost first. \\ + For example:\\ \code{ \# to get the item under the mouse cursor:\\ \$item = \$zinc->find('withtag', 'current');} @@ -1689,7 +1702,7 @@ false. {\tt\large \$zinc->{\bf focus}(tagOrId);} \begin{blockindent} - Set the keyboard focus to the item describe by {\tt tagOrId}. If {\tt tagOrId} describe + Set the keyboard focus to the item described by {\tt tagOrId}. If {\tt tagOrId} describes more than one item, the first item in display list order that accept the focus 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, @@ -1797,7 +1810,7 @@ false. This command returns a number which is the numerical index in the item described by {\tt tagOrId} corresponding to {\tt index}. The possible forms for {\tt index} are described in \conceptref{Text indices}{indices}. The command return a value between 0 and the - number of character in the item. If {\tt tagOrId} describe more than one item, the index + number of character in the item. If {\tt tagOrId} describes more than one item, the index is processed in the first item supporting text indexing in display list order. \end{blockindent} @@ -1854,7 +1867,7 @@ false. error will be reported. If a field index is given, the command will interpret the given attributes as field attributes, otherwise they will be interpreted as item attributes. If an attribute does not belong to the item or field, it will be silently ignored. This - is done to preserve the usefulness of \ident{itemconfigure} on tags. + is done to preserve the usefulness of \cmdref{itemconfigure} on tags. \end{blockindent} @@ -1872,7 +1885,7 @@ false. 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} + 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} @@ -1930,7 +1943,7 @@ false. 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} + 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} @@ -1952,9 +1965,9 @@ false. \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 + tagOrId} describes a named transform then this transform is used to do the operation. If + {\tt tagOrId} describes more than one item then all the items are affected by the + operation. If {\tt tagOrId} describes 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. \end{blockindent} @@ -1966,9 +1979,9 @@ false. \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 + tagOrId} describes a named transform then this transform is used to do the operation. If + {\tt tagOrId} describes more than one item then all the items are affected by the + opration. If {\tt tagOrId} describes neither a named transform nor an item, an error is raised. A separate factor is specified for X and Y. \end{blockindent} @@ -1978,11 +1991,11 @@ false. {\tt\large \$zinc->{\bf select}(option, ?tagOrId?, ?arg?);} \begin{blockindent} - Manipulates the selection as requested by {\tt option}. {\tt tagOrId} Describe the + Manipulates the selection as requested by {\tt option}. {\tt tagOrId} describes 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 + parameter, this parameter describes a textual position within the item and should be a valid index as described in \conceptref{Text indices}{indices}. The valid forms of the command are : @@ -2085,7 +2098,7 @@ false. given in {\tt coordList} from the coordinate space of the transform or item described by {\tt tagOrIdFrom} to the coordinate space of the transform or item described by {\tt tagOrIdTo}. If {\tt tagOrIdFrom} is omitted it defaults to the window coordinate - space. If either {\tt tagOrId} describe more than one item, the topmost in display list + space. If either {\tt tagOrId} describes more than one item, the topmost in display list order is used. If {\tt tagOrId} doesn't describe either a transform or an item, an error is raised. The {\tt coordList} should contains an even number of coordinates each point having two coordinates. @@ -2107,8 +2120,8 @@ false. transforms the point described by \verb+$xdev,$ydev+ in window coordinates, to \verb+$mygroup+ coordinates in \verb+$x,$y+; \item{\verb+($xdev, $ydev) = $zinc->transform($mygroup, $top, [$x, $y]);+}\\ - transforms the point described by \verb+$xdev,$ydev+ in \verb+$mygroup+ - coordinates, to window coordinates in \verb+$x,$y+, assuming that \verb+$top+ + transforms the point described by \verb+$x,$y+ in \verb+$mygroup+ + coordinates, to window coordinates in \verb+$xdev,$ydev+, assuming that \verb+$top+ is a group whose coordinate space is equivalent to window space, for example the root group after a \cmdref{treset}; \item{\verb+($x2, $y2) = $zinc->transform($group1, $group2, [$x1, $y1]);+}\\ @@ -2124,9 +2137,9 @@ false. \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 + tagOrId} describes a named transform then this transform is used to do the operation. If + {\tt tagOrId} describes more than one item then all the items are affected by the + opration. If {\tt tagOrId} describes neither a named transform nor an item, an error is raised. A separate value is specified for X and Y. \end{blockindent} @@ -2137,7 +2150,7 @@ false. \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 + identity. If {\tt tagOrId} describes neither a named transform nor an item, an error is raised. \end{blockindent} @@ -2159,7 +2172,7 @@ false. \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 + value the transform associated with the item {\tt tagOrId}. If {\tt tagOrId} describes 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. @@ -2205,13 +2218,14 @@ provides a set of options that may be used to query or change the item behavior. types cannot be used with some widget commands, or use special parameters with some commands. Those cases are noted in the description of the item. +%%% XXX CM : the two previous sentences are really not clear! \section{Group items} \object{group} 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}. +their use is best described in the previous chapter \conceptref{Groups, Display List, Clipping +and Transformations}{coordinates}. Applicable attributes for \ident{group} are: @@ -2226,15 +2240,15 @@ defaut value is {\tt false}.} \attribute{group}{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 +the group. Most items can be used here but notable exceptions are the \objectref{reticle} and +\objectref{map} items. The default value is {\tt ""} which means that no clipping will be performed.} \attribute{group}{composerotation}{boolean}{Specifies if the current rotation should be -composed with the local transform. The defaut value is {\tt true}.} +composed with the local transform. The default value is {\tt true}.} \attribute{group}{composescale}{boolean}{Specifies if the current scale should be composed -with the local transform. The defaut value is {\tt true}.} +with the local transform. The default value is {\tt true}.} \attribute{group}{priority}{integer}{The absolute position in the stacking order among siblings of the same parent group. The default value is {\tt 6}.} @@ -2264,14 +2278,14 @@ A track is composed of two main parts: identified by their ``partName'': \begin{itemize} -\item the {\bf current position} of the object. Its partName is \ident{position} +\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{track}{speedvector} for the track and the option \refopt{speedvectorlength}. +\attributeref{track}{speedvector} for the track and the option \optref{speedvectorlength}. This speed vector may be set visible or not, sensitive or other attributes can be set such -as color, width, ticks, mark at the end... Its partName is \ident{speedvector} +as color, width, ticks, mark at the end... 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} +visible or not, sensitive or not, and other graphic caracteristics can 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. @@ -2283,18 +2297,20 @@ visible or not, sensitive or not, and other graphic caracteristics can be be mod partName is \ident{connection}. \end{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 +\conceptref{Labels, label formats, and fields}{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} The following picture shows a simple \ident{track} with a label of 5 fields and 5 past -positions. +positions. This track also shows a marker, the circle around the current position. \fig{trackexample}{A track with a label composed of 5 fields} -An other very important feature of \ident{track} is that Zinc offers an + +%%% XXX CM add here an image with a openGL track (end ticks,... antialising...) +An other very important feature of \ident{track} item is that 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 @@ -2302,7 +2318,7 @@ 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 Zinc widget is resized. Due to software licence limitation, Zinc \emph{do not include} -the very last version of this anti-overlap manager. If you are intersted +the very last version of this anti-overlap manager. If you are interested in this anti-overlap manager, please contact Didier Pavet at {\tt pavet@cena.fr}. Applicable attributes for \ident{track} are : @@ -2319,12 +2335,12 @@ with the local transform. The default value is {\tt true}.} \attribute{track}{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{track}{connectioncolor}{gradientcolor}{The color of the connection link. The -default value is the current value of the widget option \ident{-foreground}.} +\attribute{track}{connectioncolor}{gradient}{The color of the connection link. The +default value is the current value of the widget option \optref{forecolor}.} \attribute{track}{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}.} +item \attributeref{track}{sensitive} attribute. The default value is {\tt true}.} \attribute{track}{connectionstyle}{linestyle}{The line style of the connection link. The default value is {\tt simple}.} @@ -2342,8 +2358,8 @@ otherwise it will be outlined. The default value is {\tt false}.} current location to prevent the anti overlapping system from moving it. The default value is {\tt false}.} -\attribute{track}{historycolor}{gradientcolor}{The color of the track history. The default -value is the current value of the widget option \ident{-foreground}.} +\attribute{track}{historycolor}{gradient}{The color of the track history. The default +value is the current value of the widget option \optref{forecolor}.} \attribute{track}{labelanchor}{anchor}{The anchor used in positionning the label. The default value is {\tt center}.} @@ -2374,7 +2390,7 @@ label anchor. The default value is computed from the values in the {\tt labeldis \attribute{track}{labelformat}{labelformat}{Geometry of the label fields. The default value is {\tt ""} which means that no label will be displayed.} -\attribute{track}{labelpreferedangle}{angle}{XXX New. To be documented. The default value +\attribute{track}{labelpreferredangle}{angle}{XXX New. To be documented. The default value is ??.} \attribute{track}{lastasfirst}{boolean}{If set to true, the last position in the history @@ -2385,18 +2401,18 @@ history color. The default value is {\tt false}.} side. The default value is {\tt ""} which means that both leader anchors are at the label center.} -\attribute{track}{leadercolor}{gradientcolor}{The color of the label leader. The default -value is the current value of the widget option \ident{-foreground}.} +\attribute{track}{leadercolor}{gradient}{The color of the label leader. The default +value is the current value of the widget option \optref{forecolor}.} -\attribute{track}{leaderfirstend}{lineend}{Describe the arrow shape at the current +\attribute{track}{leaderfirstend}{lineend}{Describes the arrow shape at the current position end of the leader. The default value is {\tt ""}.} -\attribute{track}{leaderlastend}{lineend}{Describe the arrow shape at the label end of the +\attribute{track}{leaderlastend}{lineend}{Describes the arrow shape at the label end of the leader. The default value is {\tt ""}.} \attribute{track}{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}.} +The actual sensitivity is the logical \ident{and} of this attribute and of the item +\attributeref{track}{sensitive} attribute. The default value is {\tt true}.} \attribute{track}{leadershape}{lineshape}{The shape of the label leader. The default value is {\tt straight}.} @@ -2407,8 +2423,8 @@ value is {\tt simple}.} \attribute{track}{leaderwidth}{dimension}{The width of the label leader. The default value is {\tt 1}.} -\attribute{track}{markercolor}{gradientcolor}{The color of the circular marker. The -default value is the current value of the widget option \ident{-foreground}.} +\attribute{track}{markercolor}{gradient}{The color of the circular marker. The +default value is the current value of the widget option \optref{forecolor}.} \attribute{track}{markerfillpattern}{bitmap}{The pattern to use when filling the circular marker. The default value is {\tt ""}.} @@ -2422,7 +2438,7 @@ default value is {\tt simple}.} \attribute{track}{mixedhistory}{boolean}{If true the track history will be plotted with dots every other positions. The default value is {\tt false}.} -\attribute{track}{numfields}{integer}{Gives the number of fields available for the +\attribute{track}{numfields}{unsignedint}{Gives the number of fields available for the label. This attribute is read only.} \attribute{track}{position}{position}{The current location of the track. The default value @@ -2438,8 +2454,8 @@ default value is {\tt true}.} unit / minute. The default value is {\tt "0 0"} which results in no speed vector displayed.} -\attribute{track}{speedvectorcolor}{gradientcolor}{The color of the track's speed -vector. The default value is the current value of the widget option \ident{-foreground}.} +\attribute{track}{speedvectorcolor}{gradient}{The color of the track's speed +vector. The default value is the current value of the widget option \optref{forecolor}.} \attribute{track}{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 @@ -2447,24 +2463,24 @@ false}.Not yet available without openGL} \attribute{track}{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}. } +item \attributeref{track}{sensitive} attribute. The default value is {\tt true}. } \attribute{track}{speedvectorticks}{boolean}{If set a mark is drawn at each minute position. The default is {\tt false}. Not yet available without openGL} -\attribute{track}{speedvectorwidth}{width}{New. XXX To be documented. The default value is -??.} +\attribute{track}{speedvectorwidth}{dimension}{New. XXX To be documented. The default value is +{\tt ??} XXX.} \attribute{track}{symbol}{bitmap}{The symbol displayed at the current position. The default value is {\tt AtcSymbol15}.} -\attribute{track}{symbolcolor}{gradientcolor}{The color of the symbol displayed at the +\attribute{track}{symbolcolor}{gradient}{The color of the symbol displayed at the current position. The default value is the current value of the widget option -\ident{-foreground}.} +\optref{forecolor}.} \attribute{track}{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}.} +and of the item \attributeref{track}{sensitive} attribute. The default value is {\tt true}.} \attribute{track}{tags}{taglist}{The list of tags associated with the item. The default value is {\tt ""}.} @@ -2472,7 +2488,7 @@ value is {\tt ""}.} \attribute{track}{visible}{boolean}{Specifies if the item is displayed. The default value is {\tt true}.} -\attribute{track}{visiblehistorysize}{integer}{The number of past positions that should be +\attribute{track}{visiblehistorysize}{unsignedint}{The number of past positions that should be displayed. The default value is {\tt 6}.} @@ -2487,12 +2503,12 @@ other kind of plan view with many geographical objects and associated textual in A waypoint is composed of the following parts: \begin{itemize} -\item the {\bf position} of the waypoint. Its partName is \ident{position} +\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} +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 +\conceptref{Labels, label format, and fields}{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}. @@ -2517,12 +2533,12 @@ composed with the local transform. The default value is {\tt true}. } \attribute{waypoint}{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{waypoint}{connectioncolor}{gradientcolor}{The color of the connection link. The -default value is the current value of the widget option \ident{-foreground}.} +\attribute{waypoint}{connectioncolor}{gradient}{The color of the connection link. The +default value is the current value of the widget option \optref{forecolor}.} \attribute{waypoint}{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}.} +item \attributeref{waypoint}{sensitive} attribute. The default value is {\tt true}.} \attribute{waypoint}{connectionstyle}{linestyle}{The line style of the connection link. The default value is {\tt simple}.} @@ -2547,15 +2563,15 @@ labeldy} set to the {\tt labeldistance}, {\tt labelangle} set. The default valu \attribute{waypoint}{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 for some more details. The default value is {\tt 50}.} \attribute{waypoint}{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.} +the label anchor. The default value is computed from the values in the +\attributeref{waypoint}{labeldistance} and \attributeref{waypoint}{labelangle} attributes.} \attribute{waypoint}{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.} +the label anchor. The default value is computed from the values in the +\attributeref{waypoint}{labeldistance} and \attributeref{waypoint}{labelangle} attributes.} \attribute{waypoint}{labelformat}{labelformat}{Geometry of the label fields. The default value is {\tt ""} which means that no label will be displayed.} @@ -2564,18 +2580,18 @@ value is {\tt ""} which means that no label will be displayed.} label side. The default value is {\tt ""} which means that both leader anchors are at the label center.} -\attribute{waypoint}{leadercolor}{gradientcolor}{The color of the label leader. The -default value is the current value of the widget option \ident{-foreground}.} +\attribute{waypoint}{leadercolor}{gradient}{The color of the label leader. The +default value is the current value of the widget option \optref{forecolor}.} -\attribute{waypoint}{leaderfirstend}{lineend}{Describe the arrow shape at the current +\attribute{waypoint}{leaderfirstend}{lineend}{Describes the arrow shape at the current position end of the leader. The default value is {\tt ""}.} -\attribute{waypoint}{leaderlastend}{lineend}{Describe the arrow shape at the label end of +\attribute{waypoint}{leaderlastend}{lineend}{Describes the arrow shape at the label end of the leader. The default value is {\tt ""}.} \attribute{waypoint}{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}.} +The actual sensitivity is the logical \ident{and} of this attribute and of the item +\attributeref{waypoint}{sensitive} attribute. The default value is {\tt true}.} \attribute{waypoint}{leadershape}{lineshape}{The shape of the label leader. The default value is {\tt straight}.} @@ -2586,8 +2602,8 @@ default value is {\tt simple}.} \attribute{waypoint}{leaderwidth}{dimension}{The width of the label leader. The default value is {\tt 1}.} -\attribute{waypoint}{markercolor}{gradientcolor}{The color of the circular marker. The -default value is the current value of the widget option \ident{-foreground}.} +\attribute{waypoint}{markercolor}{gradient}{The color of the circular marker. The +default value is the current value of the widget option \optref{forecolor}.} \attribute{waypoint}{markerfillpattern}{bitmap}{The pattern to use when filling the circular marker. The default value is {\tt ""}.} @@ -2597,7 +2613,7 @@ marker. The default value is {\tt 0} which turn off the display of the marker.} \attribute{waypoint}{markerstyle}{linestyle}{The line style of the marker outline. The default value is {\tt simple}.} -\attribute{waypoint}{numfields}{integer}{Gives the number of fields available for the +\attribute{waypoint}{numfields}{unsignedint}{Gives the number of fields available for the label. This attribute is read only.} \attribute{waypoint}{position}{position}{The current location of the way point. The @@ -2612,13 +2628,13 @@ The default value is {\tt true}.} \attribute{waypoint}{symbol}{bitmap}{The symbol displayed at the current position. The default value is {\tt AtcSymbol15}.} -\attribute{waypoint}{symbolcolor}{gradientcolor}{The color of the symbol displayed at the +\attribute{waypoint}{symbolcolor}{gradient}{The color of the symbol displayed at the current position. The default value is the current value of the widget option -\ident{-foreground}.} +\optref{forecolor}.} \attribute{waypoint}{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 and of the item \attributeref{waypoint}{sensitive} attribute. The default value is {\tt true}.} \attribute{waypoint}{tags}{taglist}{The list of tags associated with the item. The default value is {\tt ""}.} @@ -2634,7 +2650,7 @@ Tabular items have been initially designed for displaying block of textual infor organised in lists or spread out on a radar display. A tabular item is mainly composed of a \emph{label} which is a block of texts described -by a labelformat (see chapter \conceptref{Labels, fields and Label formats}{labelformat}. +by a labelformat (see chapter \conceptref{Labels, label formats and fields}{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}. @@ -2659,7 +2675,7 @@ The default value is {\tt sw}.} \attribute{tabular}{labelformat}{labelformat}{Geometry of the label fields. The default value is {\tt ""} which means that nothing will be displayed.} -\attribute{tabular}{numfields}{integer}{Gives the number of fields available for the +\attribute{tabular}{numfields}{unsignedint}{Gives the number of fields available for the label. This attribute is read only.} \attribute{tabular}{position}{position}{The item's position relative to the anchor (if no @@ -2684,8 +2700,8 @@ value is {\tt true}.} 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 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}). +configuring the text input (for example : \optref{insertbackground}, +\optref{insertofftime} \optref{insertontime}, \optref{insertwidth}). Applicable attributes for \ident{text} are: @@ -2695,9 +2711,9 @@ the item. The default value is {\tt left}.} \attribute{text}{anchor}{anchor}{The anchor used in positionning the item. The default value is {\tt nw}.} -\attribute{text}{color}{gradientcolor}{Specifies the color for drawing the text +\attribute{text}{color}{gradient}{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}.} +the widget option \optref{forecolor}.} \attribute{text}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -2715,13 +2731,13 @@ The default value is {\tt sw}.} characters, the overstrike and underline lines. The default value is {\tt ""}.} \attribute{text}{font}{font}{Specifies the font for the text. The default value is the -current value of the widget option \ident{-font}.} +current value of the widget option \optref{font}.} \attribute{text}{overstriked}{boolean}{If true, a thin line will be drawn horizontally across the text characters. The default value is {\tt false}.} \attribute{text}{position}{position}{The item's position relative to the anchor (if no -connected item specified). The default value is {\tt "0 0"}.} +connected item specified). The default value is {\tt "0 0"} (Tcl/Tk) or {\tt [0,0]} (in Perl/Tk).} \attribute{text}{priority}{integer}{The absolute position in the stacking order among siblings of the same parent group. The default value is {\tt 2}.} @@ -2761,8 +2777,8 @@ Applicable attributes for \ident{icon} are: \attribute{icon}{anchor}{anchor}{The anchor used in positionning the item. The default value is {\tt nw}.} -\attribute{icon}{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{icon}{color}{gradient}{Specifies the fill color used for drawing the +bitmap. The default value is the current value of the widget option \optref{forecolor}.} \attribute{icon}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -2783,10 +2799,11 @@ has precedence over the {\tt mask} option if both are specified. The default val \attribute{icon}{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.} +option is inactive if an image has been specified with the {\tt image} option. +The default value is {\tt ""}.} \attribute{icon}{position}{position}{The item's position relative to the anchor (if no -connected item specified). The default value is {\tt "0 0"}.} +connected item specified). The default value is {\tt "0 0"} (Tcl/Tk) or {\tt [0,0]} (Perl/Tk.} \attribute{icon}{priority}{integer}{The absolute position in the stacking order among siblings of the same parent group. The default value is {\tt 2}.} @@ -2808,8 +2825,8 @@ Reticle items are used for XXX. Applicable attributes for \ident{reticle} are: -\attribute{reticle}{brightlinecolor}{gradientcolor}{This is the color of the highlighted -circles. The default value is the current value of the widget option \ident{-foreground}.} +\attribute{reticle}{brightlinecolor}{gradient}{This is the color of the highlighted +circles. The default value is the current value of the widget option \optref{forecolor}.} \attribute{reticle}{brightlinestyle}{linestyle}{This is the line style of the highlighted circles. The default value is {\tt simple}.} @@ -2823,20 +2840,20 @@ composed with the local transform. The default value is {\tt true}.} \attribute{reticle}{firstradius}{number}{This is the radius of the innermost circle of the reticle. The default value is {\tt 80}.} -\attribute{reticle}{linecolor}{gradientcolor}{This is the color of the regular (not +\attribute{reticle}{linecolor}{gradient}{This is the color of the regular (not highlighted) circles. The default value is the current value of the widget option -\ident{-foreground}.} +\optref{forecolor}.} \attribute{reticle}{linestyle}{linestyle}{This is the line style of the regular (not highlighted) circles. The default value is {\tt simple}.} -\attribute{reticle}{numcircles}{integer}{Specifies how many circles should be drawn. The +\attribute{reticle}{numcircles}{unsignedint}{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{reticle}{period}{integer}{Specifies the recurrence of the bright circles over +\attribute{reticle}{period}{unsignedint}{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.} @@ -2853,8 +2870,10 @@ default value is {\tt false} as the item cannot handle events.} consecutive circles. The default value is {\tt 80}.} \attribute{reticle}{tags}{taglist}{The list of tags associated with the item. The default -value is {\tt ""}.} \attribute{reticle}{visible}{boolean}{Specifies if the item is -displayed. The default value is {\tt true}.} +value is {\tt ""}.} + +\attribute{reticle}{visible}{boolean}{Specifies if the item is displayed. The default value +is {\tt true}.} \section{Map items} @@ -2865,9 +2884,9 @@ Map items are used for XXX. Applicable attributes for \ident{map} are: -\attribute{map}{color}{gradientcolor}{Specifies the color usedd to draw or fill the +\attribute{map}{color}{gradient}{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}.} +default value is the current value of the widget option \optref{forecolor}.} \attribute{map}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -2879,10 +2898,10 @@ with the local transform. The default value is {\tt true}.} drawn as thin lines. The default is {\tt false}.} \attribute{map}{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 "}.} +map. The value should be a legal Tk bitmap. The default value is {\tt ""}.} \attribute{map}{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.} +map. The default value is the current value of the widget option \optref{maptextfont}.} \attribute{map}{mapinfo}{mapinfo}{Specifies the lines, texts, symbols and other various graphical components that should be displayed by the map item. All these graphical @@ -2896,7 +2915,7 @@ siblings of the same parent group. The default value is {\tt 1}.} \attribute{map}{sensitive}{boolean}{Specifies if the item should react to events. The default value is {\tt false} as the item cannot handle events.} -\attribute{map}{symbols}{bitmaplist}{XXX} +\attribute{map}{symbols}{bitmaplist}{XXX to be detailed. The default value is {\tt ??}.} \attribute{map}{tags}{taglist}{The list of tags associated with the item. The default value is {\tt ""}.} @@ -2913,9 +2932,11 @@ value is {\tt ""}.} 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} + the rectangle in a \cmdref{contour} command to build a complex shape in a \objectref{curve} item. The two points describing the rectangle can be read and modified with the - \ident{coords} command. + \cmdref{coords} command. + +%%%% XXX CM insert here two rectangles, one rotated and with a relief!! One used as a clipper! Applicable attributes for \ident{rectangle} are: @@ -2925,9 +2946,9 @@ be composed with the local transform. The default value is {\tt true}.} \attribute{rectangle}{composescale}{boolean}{Specifies if the current scale should be composed with the local transform. The default value is {\tt true}.} -\attribute{rectangle}{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{rectangle}{fillcolor}{gradient}{Specifies the color that will be used to +fill the rectangle if requested by the \attributeref{rectangle}{filled} attribute. The default +value is a one color gradient based on the current value of the widget option \optref{forecolor}.} \attribute{rectangle}{filled}{boolean}{Specifies if the item should be filled. The default value is {\tt false}.} @@ -2935,9 +2956,9 @@ value is {\tt false}.} \attribute{rectangle}{fillpattern}{bitmap}{Specifies the pattern to use when filling the item. The default value is {\tt ""}.} -\attribute{rectangle}{linecolor}{gradientcolor}{Specifies the color that will be used to +\attribute{rectangle}{linecolor}{gradient}{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}.} +\optref{forecolor}.} \attribute{rectangle}{linepattern}{bitmap}{Specifies the pattern to use when drawing the outline. The default value is {\tt ""}.} @@ -2945,15 +2966,15 @@ outline. The default value is {\tt ""}.} \attribute{rectangle}{linestyle}{linestyle}{Specifies the line style to use when drawing the outline. The default value is {\tt simple}.} -\attribute{rectangle}{linewidth}{dimension}{Specifies the with of the item outline (not +\attribute{rectangle}{linewidth}{dimension}{Specifies the width of the item outline (not scalable). The default value is {\tt 1}.} \attribute{rectangle}{priority}{integer}{The absolute position in the stacking order among siblings of the same parent group. The default value is {\tt 2}.} \attribute{rectangle}{relief}{relief}{Specifies the relief used to drawn the rectangle -outline. This attribute has priority over the \ident{linepattern} and -\ident{linestyle} attributes. The color of the relief is derived from +outline. This attribute has priority over the \attributeref{rectangle}{linepattern} and +\attributeref{rectangle}{linestyle} attributes. The color of the relief is derived from the color in \attributeref{rectangle}{linecolor}. The default value is {\tt flat}.} \attribute{rectangle}{sensitive}{boolean}{Specifies if the item should react to events. @@ -2963,9 +2984,9 @@ The default value is {\tt true}.} default value is {\tt ""}.} \attribute{rectangle}{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 ""}.} +tiles. This will be done only if filling is requested by the \attributeref{rectangle}{filled} +attribute. This attribute has priority over the \attributeref{rectangle}{fillcolor} attribute +and the \attributeref{rectangle}{fillpattern} attribute. The default value is {\tt ""}.} \attribute{rectangle}{visible}{boolean}{Specifies if the item is displayed. The default value is {\tt true}.} @@ -2981,8 +3002,8 @@ value is {\tt true}.} 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} + \cmdref{contour} command to build a complex shape in a \objectref{curve} item. The two points + describing the enclosing rectangle can be read and modified with the \cmdref{coords} command. The first point should be the top left vertex of the rectangle and the second should be the bottom right. @@ -3002,9 +3023,9 @@ with the local transform. The default value is {\tt true}.} start angle. The angle is expressed in degrees in the trigonometric system. The default value is {\tt 360}.} -\attribute{arc}{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{arc}{fillcolor}{gradient}{ Specifies the color that will be used to fill +the arc if requested by the \attributeref{arc}{filled} attribute. The default value is a one color +gradient based on the current value of the widget option \optref{forecolor}.} \attribute{arc}{filled}{boolean}{Specifies if the item should be filled. The default value is {\tt false}.} @@ -3012,17 +3033,17 @@ is {\tt false}.} \attribute{arc}{fillpattern}{bitmap}{Specifies the pattern to use when filling the item. The default value is {\tt ""}.} -\attribute{arc}{firstend}{lineend}{Describe the arrow shape at the start end of the +\attribute{arc}{firstend}{lineend}{Describes 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{arc}{lastend}{lineend}{Describe the arrow shape at the extent end of the +\attribute{arc}{lastend}{lineend}{Describes 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{arc}{linecolor}{gradientcolor}{Specifies the color that will be used to draw +\attribute{arc}{linecolor}{gradient}{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}.} +\optref{forecolor}.} \attribute{arc}{linepattern}{bitmap}{Specifies the pattern to use when drawing the outline. The default value is {\tt ""}.} @@ -3050,9 +3071,9 @@ expressed in degrees in the trigonometric system. The default value is {\tt 0}.} value is {\tt ""}.} \attribute{arc}{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 ""}.} +will be done only if filling is requested by the \attributeref{arc}{filled} attribute. This +attribute has priority over the \attributeref{arc}{fillcolor} attribute and the +\attributeref{arc}{fillpattern} attribute. The default value is {\tt ""}.} \attribute{arc}{visible}{boolean}{Specifies if the item is displayed. The default value is {\tt true}.} @@ -3064,7 +3085,7 @@ attribute. The default value is {\tt ""}.} 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 + shapes with the \cmdref{contour} command. This command can be used to perform boolean operations between a curve and almost any other item available in Zinc including another curve. The polygon delimited by the path can optionally be filled. In the following figure, two curves with four holes each are in front of a text. You can @@ -3074,7 +3095,7 @@ attribute. The default value is {\tt ""}.} 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. + removed with the \cmdref{coords} command. Applicable attributes for \ident{curve} are: @@ -3083,7 +3104,7 @@ attribute is only applicable if the curve is not closed and the outline relief i flat. The default value is {\tt round}.} \attribute{curve}{closed}{boolean}{Specifies if the curve outline should be drawn between -the first and last vertex or not. The default is {\tt true}.} +the first and last vertex or not. The default value is {\tt true}.} \attribute{curve}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -3091,9 +3112,9 @@ composed with the local transform. The default value is {\tt true}.} \attribute{curve}{composescale}{boolean}{Specifies if the current scale should be composed with the local transform. The default value is {\tt true}.} -\attribute{curve}{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{curve}{fillcolor}{gradient}{Specifies the color that will be used to fill +the curve if requested by the \attributeref{curve}{filled} attribute. The default value is +a one color gradient based on the current value of the widget option \optref{forecolor}.} \attribute{curve}{filled}{boolean}{Specifies if the item should be filled. The default value is {\tt false}.} @@ -3101,7 +3122,7 @@ value is {\tt false}.} \attribute{curve}{fillpattern}{bitmap}{Specifies the pattern to use when filling the item. The default value is {\tt ""}.} -\attribute{curve}{firstend}{lineend}{Describe the arrow shape at the start of the curve. +\attribute{curve}{firstend}{lineend}{Describes 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 ""}.} @@ -3109,13 +3130,13 @@ the outline is flat. The default value is {\tt ""}.} segments. This attribute is only applicable if the curve outline relief is flat. The default value is {\tt round}.} -\attribute{curve}{lastend}{lineend}{Describe the arrow shape at the end of the curve. +\attribute{curve}{lastend}{lineend}{Describes 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{curve}{linecolor}{gradientcolor}{Specifies the color that will be used to draw +\attribute{curve}{linecolor}{gradient}{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}.} +\optref{forecolor}.} \attribute{curve}{linepattern}{bitmap}{Specifies the pattern to use when drawing the outline. The default value is {\tt ""}.} @@ -3130,15 +3151,15 @@ scalable). The default value is {\tt 1}.} 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{curve}{markercolor}{gradientcolor}{Specifies the color of the markers. The -default value is the current value of the widget option \ident{-foreground}.} +\attribute{curve}{markercolor}{gradient}{Specifies the color of the markers. The +default value is the current value of the widget option \optref{forecolor}.} \attribute{curve}{priority}{integer}{The absolute position in the stacking order among siblings of the same parent group. The default value is {\tt 2}.} \attribute{curve}{relief}{relief}{Specifies the relief used to drawn the curve -outline. This attribute has priority over the \ident{linepattern} and -\ident{linestyle} attributes. The color of the relief is derived from +outline. This attribute has priority over the \attributeref{curve}{linepattern} and +\attributeref{curve}{linestyle} attributes. The color of the relief is derived from the color in \attributeref{curve}{linecolor}. The default value is {\tt flat}.} \attribute{curve}{sensitive}{boolean}{Specifies if the item should react to events. The @@ -3146,15 +3167,15 @@ default value is {\tt true}.} \attribute{curve}{smoothrelief}{boolean}{Specifies if the relief should be smoothed along the curve. This is useful to obtain smooth curved reliefs instead of facets The default -value is {\tt False}.} +value is {\tt false}.} \attribute{curve}{tags}{taglist}{The list of tags associated with the item. The default value is {\tt ""}.} \attribute{curve}{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 ""}.} +tiles. This will be done only if filling is requested by the \attributeref{curve}{filled} attribute. +This attribute has priority over the \attributeref{curve}{fillcolor} attribute and the +\attributeref{curve}{fillpattern} attribute. The default value is {\tt ""}.} \attribute{curve}{visible}{boolean}{Specifies if the item is displayed. The default value is {\tt true}.} @@ -3173,8 +3194,8 @@ is {\tt true}.} 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. + \cmdref{contour} command to build a complex shape in a \objectref{curve} item. The controls + points can be read, modified, added or removed with the \cmdref{coords} command. Applicable attributes for \ident{bezier} are: @@ -3188,9 +3209,9 @@ composed with the local transform. The default value is {\tt true}.} \attribute{bezier}{composescale}{boolean}{Specifies if the current scale should be composed with the local transform. The default value is {\tt true}.} -\attribute{bezier}{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{bezier}{fillcolor}{gradient}{Specifies the color that will be used to fill +the bezier if requested by the \attributeref{bezier}{filled} attribute. The default value is a one color +gradient based on the current value of the widget option \optref{forecolor}.} \attribute{bezier}{filled}{boolean}{Specifies if the item should be filled. The default value is {\tt false}.} @@ -3198,17 +3219,17 @@ value is {\tt false}.} \attribute{bezier}{fillpattern}{bitmap}{Specifies the pattern to use when filling the item. The default value is {\tt ""}.} -\attribute{bezier}{firstend}{lineend}{Describe the arrow shape at the start of the bezier. +\attribute{bezier}{firstend}{lineend}{Describes 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{bezier}{lastend}{lineend}{Describe the arrow shape at the end of the bezier. +\attribute{bezier}{lastend}{lineend}{Describes 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{bezier}{linecolor}{gradientcolor}{Specifies the color that will be used to draw +\attribute{bezier}{linecolor}{gradient}{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}.} +\optref{forecolor}.} \attribute{bezier}{linepattern}{bitmap}{Specifies the pattern to use when drawing the outline. The default value is {\tt ""}.} @@ -3223,8 +3244,8 @@ scalable). The default value is {\tt 1}.} siblings of the same parent group. The default value is {\tt 2}.} \attribute{bezier}{relief}{relief}{Specifies the relief used to drawn the bezier -outline. This attribute has priority over the \ident{linepattern} and -\ident{linestyle} attributes. The color of the relief is derived from +outline. This attribute has priority over the \attributeref{bezier}{linepattern} and +\attributeref{bezier}{linestyle} attributes. The color of the relief is derived from the color in \attributeref{bezier}{linecolor}. The default value is {\tt flat}.} \attribute{bezier}{sensitive}{boolean}{Specifies if the item should react to events. The @@ -3234,9 +3255,9 @@ default value is {\tt true}.} value is {\tt ""}.} \attribute{bezier}{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 ""}.} +tiles. This will be done only if filling is requested by the \attributeref{bezier}{filled} +attribute. This attribute has priority over the \attributeref{bezier}{fillcolor} attribute and the +\attributeref{bezier}{fillpattern} attribute. The default value is {\tt ""}.} \attribute{bezier}{visible}{boolean}{Specifies if the item is displayed. The default value is {\tt true}.} @@ -3254,7 +3275,7 @@ XXX A relire et reprendre Applicable attributes for \ident{triangles} are: -\attribute{triangles}{colors}{gradientarray}{Specifies the colors of each vertex of the +\attribute{triangles}{colors}{gradientlist}{Specifies the colors of each vertex of the triangles XXX.} \attribute{triangles}{composerotation}{boolean}{Specifies if the current rotation should @@ -3263,7 +3284,7 @@ be composed with the local transform. The default value is {\tt true}.} \attribute{triangles}{composescale}{boolean}{Specifies if the current scale should be composed with the local transform. The default value is {\tt true}.} -\attribute{triangles}{fan}{fantype}{XXX. The default value is {\tt XXX}.} +\attribute{triangles}{fan}{boolean}{ If true, triangles are created with a fan method. Otherwise triangles are creataed according a stripping method. The default value is {\tt true}.} \attribute{triangles}{priority}{integer}{The absolute position in the stacking order among siblings of the same parent group. The default value is {\tt 2}.} @@ -3285,20 +3306,20 @@ value is {\tt true}.} 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} + a \cmdref{contour} command to build a complex shape in a \objectref{curve} item. The position + of the window, relative to the anchor, can be set or read with the \cmdref{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 + relevant Zinc widget with the \attributeref{window}{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: +Applicable attributes for \ident{window} items are: \attribute{window}{anchor}{anchor}{The anchor used in positionning the item. The default value is {\tt nw}.} @@ -3319,7 +3340,7 @@ used for the placement. The default value is {\tt sw}.} units. The default value is {\tt 0}.} \attribute{window}{position}{position}{The item's position relative to the anchor (if no -connected item specified). The default value is {\tt "0 0"}.} +connected item specified). The default value is {\tt "0 0"} (Tcl/Tk) or {\tt [0,0]} (Perl/Tk).} \attribute{window}{priority}{integer}{Constraints of the underlying window sytem dictate the stacking order of window items. They can't be lowered under the other @@ -3327,7 +3348,7 @@ items. Additionally, to manipulate their stacking order, you must use the raise Tk commands on the associated Tk window. The value of this attribute is meaningless.} \attribute{window}{sensitive}{boolean}{This option has no effect on window items. The -default value is {\tt False}.} +default value is {\tt false}.} \attribute{window}{tags}{taglist}{The list of tags associated with the item. The default value is {\tt ""}.} @@ -3363,16 +3384,16 @@ behaviours, but Zinc is. To be able to manage many items mixing geometric parts and non-geometric parts, Zinc introduces the concepts of label, labelformat, fields and fields attributes. -\section {Labels, label formats} +\section {Labels and label formats} \concept{label} \concept{labelformat} A label is a set of many textual parts attached to the following types of items: \objectref{track}, \objectref{waypoint} and \objectref{tabular}. -The textual parts of a label are called fields. The label and the geometry of the text -fields are described by a labelformat. +The textual parts of a label are called fields. The label and the geometry (size and +position)of the text fields are described by a labelformat. -The field number is an characteristic set at item creation time (see the command +The number of fields is a characteristic set at item creation time (see the command \cmdref{add}). This characteristic cannot be modified after creation of the item. However it can be read with the command \cmdref{numparts}. @@ -3415,19 +3436,19 @@ image. The default value is {\tt left}.} depending on the label orientation. The default value is {\tt "-"} which means do not use dynamic alignment.} -\attribute{field}{backcolor}{color}{ The field background color. The default value is the -current value of the widget option \ident{-foreground}.} +\attribute{field}{backcolor}{gradient}{ The field background color. The default value is the +current value of the widget option \optref{forecolor}.} \attribute{field}{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 +edges can be omitted, this attribute describes the edges that should be displayed as part of the border. The default value is {\tt ""}.} -\attribute{field}{bordercolor}{color}{ The border color. The default value is the current -value of the widget option \ident{-fore\-ground}.} +\attribute{field}{bordercolor}{gradient}{ The border color. The default value is the current +value of the widget option \optref{forecolor}.} -\attribute{field}{color}{color}{ The text color. The default value is the current value of -the widget option \ident{-fore\-ground}.} +\attribute{field}{color}{gradient}{ The text color. The default value is the current value of +the widget option \optref{forecolor}.} \attribute{field}{filled}{boolean}{ Specifies if the field background should be filled. The default value is {\tt false}.} @@ -3437,7 +3458,7 @@ background. This attribute is overrided by the tile attribute. The default value ""}.} \attribute{field}{font}{font}{ The text font. The default value is the current value of -the widget option \ident{-font}.} +the widget option \optref{font}.} \attribute{field}{image}{image}{ An image to be displayed in the field. The image will be centered vertically in the field. The default value is {\tt ""}.} @@ -3458,7 +3479,7 @@ will be centered vertically in the field. The default value is {\tt ""}.} \attribute{field}{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 ""}.} +\attributeref{field}{fillpattern} attribute. The default value is {\tt ""}.} \attribute{field}{visible}{boolean}{ Specifies if the field is displayed. The default value is {\tt true}.} @@ -3476,7 +3497,7 @@ We describe in this chapter all the available types in Zinc. They are listed by alphabetical order. \emph{NB: Two types are very important and their existence should be known -by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelformat}.} +by any new user of Zinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.} \attrtype{alignment} @@ -3493,9 +3514,9 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma \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}, + Specifies one of the nine caracteristic points of a rectangle or a 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} @@ -3529,7 +3550,7 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma \attrtype{bitmaplist} \begin{blockindent} - This is an extension of the \ident{bitmap} attribute type. It describes a list of + This is an extension of the \attrtyperef{bitmap} attribute type. It describes a list of bitmaps that will be the value of the attribute. \end{blockindent} @@ -3581,7 +3602,7 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma {\tt normal}, {\tt bold}, {\tt roman}, {\tt italic}, {\tt underline}, {\tt overstrike}. \end{blockindent} -\attrtype{gradientcolor} +\attrtype{gradient} \begin{blockindent} This is a string describing a color gradient to be used for example to fill a surface. @@ -3632,6 +3653,12 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma will result. \end{blockindent} +\attrtype{gradientlist} +\begin{blockindent} + This is an extension of the \attrtyperef{gradient} attribute type. It describes a list of + gradients that will be the value of the attribute. +\end{blockindent} + \attrtype{image} \begin{blockindent} This should be the name of a previously registered Tk image. In pure Tk only GIF, PPM @@ -3658,54 +3685,76 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma \attrtype{labelformat} \begin{blockindent} - The new format is as follow. Parameters between [] are optional and take default values + The new format is as follow. Parameters between \verb+[]+ are optional and take default values when omitted. The spaces can appear between blocks but not inside. - \verb+[WidthxHeight] [field0Spec] [field1Spec] [fieldnSpec]+ + \verb+[WidthxHeight] [] [] ... []+ - 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). + \verb+Width+ and \verb+Height+ are strictly positive integers. They set + the size of the clipping + box surrounding the label. If not specified, there will be no clipping. + If specified alone, they specify the size of the only displayed field (0). - \verb+fieldSpec+ is: + \verb+ ::= []+ - \verb+sChar fieldWidth sChar fieldHeight [pChar fieldX pChar fieldY]+. + Each fieldiSpec specify the size and position of the field numbered i. + + \verb+ ::= + + + \verb+ ::= x|f|i|a|l+ + + \verb++ specifies the meaning of the following \verb++ or \verb++. Those are positive integers. Values for \verb+sChar+ have the following meaning : - Each field description refers to the field of same index in the field array. Available - values for \verb+sChar+ are : - \begin{itemize} - \item \verb+'x'+ : the dimension is in pixel. - \item \verb+'f'+ : the dimension is in percentage of the mean width/height of a - character (in the field font). - \item \verb+'i'+ : the dimension is in percentage of the size of the image in the field. - \item \verb+'a'+ : the dimension is automatically adjusted to match the field's content - plus the given value in pixels. - \item \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. + \item \verb+'x'+ : the corresponding dimension (either width or height) is in pixel, + according to the value of the \verb++ or \verb++ + \item \verb+'f'+ : the corresponding dimension is in percentage of the mean + width/height of a character (in the field font). The following \verb++ + or \verb++ gives the percentage. The value must be an integer between + 0 and 100. +%%% XXX CM How is computed ``the mean width/height of a character'' + \item \verb+'i'+ : the corresponding dimension is in percentage of the size of the + image in the field. The following \verb++ or \verb++ gives + the percentage. The value must be an integer between 0 and 100. If the field contains + no image, the dimension is 0. + \item \verb+'a'+ : the corresponding dimension is automatically adjusted to match + the field's content plus the given value in pixels. + \item \verb+'l'+ : the corresponding dimension is automatically adjusted to match the + global size of the label (not counting fields with \verb+'l'+ size specs). The + corresponding integer parameter is not used with this size specification and it + is not possible to reference the field in another \verb++ (see below). \end{itemize} - Available values for \verb+pChar+ are : + \verb+ ::= +. + + \verb- ::= +|<|>|^|$- +%$ this comment if for emacs coloring only! + + \verb++ and \verb++ are either integer or index refering an + other field of the labelformat. + + Values for \verb+pChar+ have the following meaning : + \begin{itemize} - \item \verb-'+'- : the position is in pixel (possibly negative). - \item \verb+'<'+ : the position is the index of the field at the left/top of which the - current field should be attached. - \item \verb+'>'+ : the position is the index of the field at the right/bottom of which - the current field should be attached. - \item \verb+'^'+ : the position is the index of the field used to align the left/top - border (left on left or top on top). - \item \verb+'$'+ : the %$ position is the index - of the field used to align the right/bottom border (right on right or bottom on bottom). + \item \verb-'+'- : the position, either on the X or Y axis, is in pixel, possibly + negative. XXX what does it mean if negative? The value is given by the corresponding \verb++ or \verb++. + \item \verb+'<'+ : The field will be at the left (or top) of the field refered + by the corresponding index \verb++ (or \verb++) + \item \verb+'>'+ : The field will be at the right (or bottom) of the field refered + by the corresponding index \verb++ (or \verb++) + \item \verb+'^'+ : The field will be left (or top) aligned with the field refered + by the corresponding index \verb++ (or \verb++). + \item \verb+'$'+ : The field will be right (or bottom) aligned with the field refered + by the corresponding index \verb++ (or \verb++). +%$ this comment if for emacs coloring only! \end{itemize} - The positional parameters can be omitted if there is only one field. + \verb++ 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 + Describes where to attach the label leader on the label. These are not to be confused with the regular rectangular anchors. The format is: \verb+lChar leftLeaderAnchor [lChar rightLeaderAnchor]+ @@ -3724,7 +3773,7 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma \attrtype{lineend} \begin{blockindent} - Describe the shape of the arrow at the beginning or end of a path. This is a list of + Describes 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 @@ -3747,7 +3796,7 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma \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, arcs, + \conceptref{The mapinfo related commands}{mapinfocmds}) that will define the lines, arcs, symbols, and texts displayed in a map item. \end{blockindent} @@ -3779,6 +3828,11 @@ by any new user of Zinc: \attrtyperef{gradientcolor} and \attrtyperef{labelforma This should be a list of strings describing the tags that are set for an item. \end{blockindent} +\attrtype{unsignedint} +\begin{blockindent} + Describes an unsigned integer value. +\end{blockindent} + \attrtype{window} \begin{blockindent} A string describing an X window id. This id can be returned by the {\tt winfo id @@ -3967,6 +4021,10 @@ Starting at version 3.2.4 of Zinc small applications are included as demos. They are all accessible through an application called \ident{zinc-demos}. These tiny demos are useful for newcomers and as starting points for developing real applications. +\section{ZincText.pm} + +This perl module offers some text input fonctionalities... To be detailed! + %\listoftables \listoffigures -- cgit v1.1