diff options
Diffstat (limited to 'doc/refman.tex')
| -rw-r--r-- | doc/refman.tex | 94 |
1 files changed, 45 insertions, 49 deletions
diff --git a/doc/refman.tex b/doc/refman.tex index f1f886a..852bb57 100644 --- a/doc/refman.tex +++ b/doc/refman.tex @@ -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, label format, and fields}{labelsandfields} describes the +The chapter \conceptref{Labels, fields and labelformat}{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 related commands}{mapinfocmds} introduces the mapinfo, a +The chapter \conceptref{The mapinfo 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} @@ -441,7 +441,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, often used as command argument. +describes the item ids and item tags, used as argument in most commands. 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} @@ -465,8 +465,6 @@ described below. 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 @@ -483,8 +481,6 @@ 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 @@ -562,7 +558,7 @@ described below. \option{lightangle}{lightAngle}{LightAngle} \begin{blockindent} - Specifies the lighting angle used when displaying relief. The default value is \verb+120+. %%% XXX CM to complete! + Specifies the lighting angle used when displaying relief. The default value is \verb+120+. %%% XXX CM to be completed! \end{blockindent} \option{mapdistancesymbol}{mapDistanceSymbol}{MapDistanceSymbol} @@ -653,7 +649,7 @@ 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+. + The default value is empty. \end{blockindent} @@ -742,7 +738,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-ding together the \ident{-sensitive} attributes + item is the result of and-ing 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 @@ -989,9 +985,9 @@ can be mixed. ($xo, $yo, $xc, $yc) = $zinc->bbox("(red && black)||(pink && !$thisitem)"); \end{verbatim} -Some methods only operate on a single item at a time; if \ident{tagOrId} is specified -in a way that names multiple items, then the normal behavior is for the methods is to -use the first (lowest) of these items in the display list that is suitable for +Many methods only operate on a single item at a time; if \ident{tagOrId} is specified +in a way that names multiple items, then the normal behavior for these methods is to +use the first of these items in the display list (most visible) that is suitable for the method. Exceptions are noted in the method descriptions below. Tags can be associated with items by giving a tag list to the \ident{-tags} attribute or @@ -2306,7 +2302,7 @@ 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, label formats, and fields}{labelformat}. Each text can have its graphic +\conceptref{Labels, labelformats, 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}. @@ -2438,7 +2434,7 @@ 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 ""}.} -\attribute{track}{markersize}{number}{The (scale sensitive) size of the circular marker. +\attribute{track}{markersize}{dimension}{The (scale sensitive) size of the circular marker. The default value is {\tt 0} which turn off the display of the marker.} \attribute{track}{markerstyle}{linestyle}{The line style of the marker outline. The @@ -2450,7 +2446,7 @@ dots every other positions. The default value is {\tt false}.} \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 +\attribute{track}{position}{point}{The current location of the track. The default value is {\tt "0 0"}.} \attribute{track}{priority}{integer}{The absolute position in the stacking order among @@ -2459,7 +2455,7 @@ siblings of the same parent group. The default value is {\tt 5}.} \attribute{track}{sensitive}{boolean}{Specifies if the item should react to events. The default value is {\tt true}.} -\attribute{track}{speedvector}{position}{The speed vector $\Delta x$ and $\Delta y$ in +\attribute{track}{speedvector}{point}{The speed vector $\Delta x$ and $\Delta y$ in unit / minute. The default value is {\tt "0 0"} which results in no speed vector displayed.} @@ -2478,7 +2474,7 @@ item \attributeref{track}{sensitive} attribute. The default value is {\tt true}. position. The default is {\tt false}. Not yet available without openGL} \attribute{track}{speedvectorwidth}{dimension}{New. XXX To be documented. The default value is -{\tt ??} XXX.} +{\tt 1}.} \attribute{track}{symbol}{bitmap}{The symbol displayed at the current position. The default value is {\tt AtcSymbol15}.} @@ -2517,7 +2513,7 @@ A waypoint is composed of the following parts: visible or not, sensitive or not, and other graphic caracteristics can be be modified. Its partName is \ident{leader}. \item a {\bf label} which is a block of texts described by a labelformat (see chapter -\conceptref{Labels, label format, and fields}{labelformat}. Each text can have its graphic +\conceptref{Labels, labelformat, 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}. @@ -2617,7 +2613,7 @@ 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 ""}.} -\attribute{waypoint}{markersize}{number}{The (scale sensitive) size of the circular +\attribute{waypoint}{markersize}{dimension}{The (scale sensitive) size of the circular 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}.} @@ -2625,7 +2621,7 @@ default value is {\tt simple}.} \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 +\attribute{waypoint}{position}{point}{The current location of the way point. The default value is {\tt "0 0"}.} \attribute{waypoint}{priority}{integer}{The absolute position in the stacking order among @@ -2659,7 +2655,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, label formats and fields}{labelformat}. +by a labelformat (see chapter \conceptref{Labels, labelformats 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}. @@ -2687,7 +2683,7 @@ value is {\tt ""} which means that nothing will be displayed.} \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 +\attribute{tabular}{position}{point}{The item's position relative to the anchor (if no connected item specified). The default value is {\tt "0 0"}.} \attribute{tabular}{priority}{integer}{The absolute position in the stacking order among @@ -2745,8 +2741,8 @@ 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"} (Tcl/Tk) or {\tt [0,0]} (in Perl/Tk).} +\attribute{text}{position}{point}{The item's position relative to the anchor (if no +connected item specified). The default value is {\tt "0 0"} (Tcl/Tk) or {\tt [0,0]} (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}.} @@ -2811,7 +2807,7 @@ item. The bitmap is filled with the color specified with the {\tt color} 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 +\attribute{icon}{position}{point}{The item's position relative to the anchor (if no 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 @@ -2846,7 +2842,7 @@ composed with the local transform. The default value is {\tt true}.} \attribute{reticle}{composescale}{boolean}{Specifies if the current scale should be 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 +\attribute{reticle}{firstradius}{dimension}{This is the radius of the innermost circle of the reticle. The default value is {\tt 80}.} \attribute{reticle}{linecolor}{gradient}{This is the color of the regular (not @@ -2866,7 +2862,7 @@ optimized for the current scale.} the regulars. The default value is {\tt 5} which means that a bright circle is drawn then 4 regulars, etc.} -\attribute{reticle}{position}{position}{Location of the center of the reticle. The default +\attribute{reticle}{position}{point}{Location of the center of the reticle. The default value is {\tt "0 0"}.} \attribute{reticle}{priority}{integer}{The absolute position in the stacking order among @@ -2875,7 +2871,7 @@ siblings of the same parent group. The default value is {\tt 2}.} \attribute{reticle}{sensitive}{boolean}{Specifies if the item should react to events. The default value is {\tt false} as the item cannot handle events.} -\attribute{reticle}{stepsize}{number}{The (scale sensitive) size of the step between two +\attribute{reticle}{stepsize}{dimension}{The (scale sensitive) size of the step between two consecutive circles. The default value is {\tt 80}.} \attribute{reticle}{tags}{taglist}{The list of tags associated with the item. The default @@ -3293,7 +3289,8 @@ 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}{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}{fan}{boolean}{ If true, triangles are created with a fan like layout. +Otherwise triangles are arranged like a strip. 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}.} @@ -3315,18 +3312,19 @@ 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 \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} + 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 \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. + 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} items are: @@ -3348,7 +3346,7 @@ used for the placement. The default value is {\tt sw}.} \attribute{window}{height}{dimension}{Specifies the height of the item window in screen units. The default value is {\tt 0}.} -\attribute{window}{position}{position}{The item's position relative to the anchor (if no +\attribute{window}{position}{point}{The item's position relative to the anchor (if no 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 @@ -3393,7 +3391,7 @@ 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 and label formats} +\section {Labels and labelformats} \concept{label} \concept{labelformat} A label is a set of many textual parts attached to the following types of items: @@ -3725,9 +3723,9 @@ by any new user of Zinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.} \verb+[WidthxHeight] [<field0Spec>] [<field1Spec>] ... [<fieldnSpec>]+ \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). + 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+<fieldiSpec> ::= <fieldiSize>[<fieldiPos>]+ @@ -3737,7 +3735,9 @@ by any new user of Zinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.} \verb+<sChar> ::= x|f|i|a|l+ - \verb+<sChar>+ specifies the meaning of the following \verb+<fieldWidth>+ or \verb+<fieldHeight>+. Those are positive integers. Values for \verb+<sChar>+ have the following meaning : + \verb+<sChar>+ specifies the meaning of the following \verb+<fieldWidth>+ or + \verb+<fieldHeight>+. Those are positive integers. Values for \verb+<sChar>+ + have the following meaning : \begin{itemize} \item \verb+'x'+ : the corresponding dimension (either width or height) is in pixel, @@ -3771,7 +3771,8 @@ by any new user of Zinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.} \begin{itemize} \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+<fieldX>+ or \verb+<fieldY>+. + negative. XXX what does it mean if negative? The value is given by the corresponding + \verb+<fieldX>+ or \verb+<fieldY>+. \item \verb+'<'+ : The field will be at the left (or top) of the field refered by the corresponding index \verb+<fieldX>+ (or \verb+<fieldY>+) \item \verb+'>'+ : The field will be at the right (or bottom) of the field refered @@ -3834,12 +3835,7 @@ by any new user of Zinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.} symbols, and texts displayed in a map item. \end{blockindent} -\attrtype{number} -\begin{blockindent} - This is floating point value. It can be optionally expressed in exponent notation. -\end{blockindent} - -\attrtype{position} +\attrtype{point} \begin{blockindent} This is a list of two floating point values that describes a point position or some two dimensional delta (used for example to describe the speed vector of a track item). |