diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/refman.tex | 126 |
1 files changed, 73 insertions, 53 deletions
diff --git a/doc/refman.tex b/doc/refman.tex index 7947079..6bcbbb0 100644 --- a/doc/refman.tex +++ b/doc/refman.tex @@ -36,7 +36,7 @@ citecolor=webbrightgreen, pdftitle={Zinc, an advanced scriptable Canvas.}, pdfauthor={Patrick Lecoanet, Christophe Mertz, Centre d'Étude de la Navigation Aérienne}, - pdfsubject={The pre-3.3 (3.2.96) Reference Manual.}, + pdfsubject={The pre-3.3 (3.2.97) Reference Manual.}, pdfkeywords={tk tcl perl x11 canvas opengl script gui TkZinc}, pagebackref, pdfpagemode=None, @@ -779,25 +779,23 @@ actual source of the default color. Its default value is \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 - \optref{trackmanagehistory} option and the \attributeref{track}{visiblehistorysize} track - attribute. The default value is {\tt 6}. + This option accepts only positive integers. It specifies the number of positions + collected in the history list by the track items. When this many positions have + been collected, the oldest is dropped to make room for a new one on a first-in + first-out basis. See also the \optref{trackvisibehistorysize} option and the + \attributeref{track}{historyvisible} track attribute. The default value is {\tt 6}. \end{blockindent} -\option{trackmanagehistory}{trackManageHistory}{TrackManageHistory} +\option{trackvisiblehistorysize}{trackVisibleHistorySize}{TrackVisibleHistorySize} \begin{blockindent} - This option accepts any form valid for a boolean. It specifies if the track items - should maintain a list of their past positions to be displayed as trailing - speckles. If this option is turned off and then back on, the history list is erased - and the collection is resumed at the next available position. The number of - position collected in the history list is specified by the option - \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 - \attributeref{track}{visiblehistorysize} attribute. The default is to enable the history - collection. + This option accepts only positive integers. It specifies the number of + past positions to display for tracks. It is a widget wide control. Users + of previous releases used the {\tt -visiblehistorysize} track attribute + for the same effect. The number of past positions displayed can not exceed + the accumulated positions controlled by the option \optref{trackmanagedhistorysize}. + The track \attributeref{track}{historyvisible} attribute controls whether + a track should display its history. The default value is {\tt 6}. \end{blockindent} @@ -1670,8 +1668,11 @@ reference) and all list parameters are given as array references. item with the tag is considered), the search starts with the item below {\tt start} instead of the first item in the display order. If {\tt startItem} does not name a valid item, it is ignored. - If {\tt recursive} is specified it controls if the search should proceed - down the item hierarchy or not. + If {\tt recursive} is false or not specified, the search is limited to + the starting group. If set to true or ``override'', the search proceed + from the starting group down the hierarchy rooted at this group. + ``override'' forces the search to explore atomic groups and report + the most specific item instead of the group itself. \item{\tt\large pathname {\bf addtag} tag enclosed xo yo xc yc ?inGroup? ?recursive?\\ @@ -1680,10 +1681,13 @@ reference) and all list parameters are given as array references. Selects all the items completely enclosed in the rectangle whose origin is at {\tt xo - yo} and corner at {\tt xc - yc}. {\tt xc} must be no greater than {\tt xo} and {\tt yo} must be no greater - than {\tt yc}. All coordinates must be integers. inGroup specifies - a group to start with instead of the root group and recursive tells - if the search should descend in the item tree or not. recursive is true - by default. + than {\tt yc}. All coordinates must be integers. {\tt inGroup} specifies + a group to start with instead of the root group. + If {\tt recursive} is false or not specified, the search is limited to + the starting group. If set to true or ``override'', the search proceed + from the starting group down the hierarchy rooted at this group. + ``override'' forces the search to explore atomic groups and report + the most specific item instead of the group itself. It may be necessary to update the TkZinc internal geometry with a call to {\tt update} if the current state is not stable (i.e before calling @@ -1697,10 +1701,13 @@ reference) and all list parameters are given as array references. Selects all the items that overlaps or are enclosed in the rectangle whose origin is at {\tt xo - yo} and corner at {\tt xc - yc}. {\tt xc} must be no greater than {\tt xo} and {\tt yo} must be no greater than - {\tt yc}. All coordinates must be integers. inGroup specifies - a group to start with instead of the root group and recursive tells - if the search should descend in the item tree or not. recursive is true - by default. + {\tt yc}. All coordinates must be integers. {\tt inGroup} specifies + a group to start with instead of the root group. + If {\tt recursive} is false or not specified, the search is limited to + the starting group. If set to true or ``override'', the search proceed + from the starting group down the hierarchy rooted at this group. + ``override'' forces the search to explore atomic groups and report + the most specific item instead of the group itself. See also the {\tt enclosed} variant above for a discussion on updating the geometry. @@ -1739,15 +1746,20 @@ reference) and all list parameters are given as array references. \end{blockindent} -\zinccmd{bbox}{tagOrId ?tagOrId ...?} +\zinccmd{bbox}{tagOrId ?fieldIndex?} -{\tt\large (\$xo, \$yo, \$xc, \$yc) = \$zinc->{\bf bbox}(tagOrId, ?tagOrId, ...?);} +{\tt\large (\$xo, \$yo, \$xc, \$yc) = \$zinc->{\bf bbox}(tagOrId, ?fieldIndex?);} \begin{blockindent} Returns a list of 4 numbers describing the \emph{window coordinates} of the origin and corner of a rectangle bounding all the items named by the {\tt tagOrId} - arguments. If no items are named by the {\tt tagOrId} or if the matching items - have an empty bounding box, an empty string is returned. + argument. If no items are named by {\tt tagOrId} or if the matching items + have an empty bounding box, an empty string is returned. The bounding box of + a label field can be queried by specifying an optional {\tt fieldIndex}. + If {\tt fieldIndex} is ``label'' the bounding box of the label itself is returned. + These two forms of the command apply only to one item, if a tag is used the + first matching item is used, if the item does not support fields an empty + string is returned. \end{blockindent} @@ -2440,31 +2452,34 @@ false. \end{blockindent} -\zinccmd{rotate}{tagOrId angle ?centerX centerY?} +\zinccmd{rotate}{tagOrId angle ?degree? ?centerX centerY?} {\tt\large \$zinc->{\bf rotate}(tagOrId, angle);}\\ {\tt\large \$zinc->{\bf rotate}(tagOrId, angle, centerX, centerY);} \begin{blockindent} Add a rotation to the items or the transform described by {\tt tagOrId}. If {\tt - tagOrId} 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 radian. The optional parameters describe the center of - rotation, which defaults to the origin. + 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 radian if {\tt degree} is omitted or false, if it is + specified as true, the angle is in degrees. The last two optional parameters describe + the center of rotation, which defaults to the origin. \end{blockindent} -\zinccmd{scale}{tagOrIdOrTName xFactor yFactor} +\zinccmd{scale}{tagOrIdOrTName xFactor yFactor ?centerX centerY?} {\tt\large \$zinc->{\bf scale}(tagOrIdOrTName, xFactor, yFactor);} +{\tt\large \$zinc->{\bf scale}(tagOrIdOrTName, xFactor, yFactor, centerX, centerY);} \begin{blockindent} Add a scale factor to the items or the transform described by {\tt tagOrId}. If {\tt - 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. A separate factor is specified for X and Y. + 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. A separate factor is specified for X and Y. The optional parameters + describe the center of scaling, which defaults to the origin. \end{blockindent} @@ -3033,8 +3048,9 @@ value is {\tt ""}.} \attribute{track}{visible}{boolean}{Specifies if the item is displayed. The default value is {\tt true}.} -\attribute{track}{visiblehistorysize}{unsignedint}{The number of past positions that should be -displayed. The default value is {\tt 6}.} +\attribute{track}{historyvisible}{boolean}{Specifies whether the item should display +its history according to the options \optref{trackvisiblehistorysize} and +\optref{trackmanagedhistorysize}. The default value is {\tt true}.} \section{WayPoint items} @@ -3262,11 +3278,18 @@ case, they must get the focus for keyboards events with the command \cmdref{focu TkZinc options (see chapter \conceptref{Widget options}{options} can be used for configuring the text input (for example : \optref{insertbackground}, \optref{insertofftime} \optref{insertontime}, \optref{insertwidth}). -A Perl module, called Tk::Zinc::Text (see the section \conceptref{Tk::Zinc::Text}{zinctext}) is provided for easing text input in text items + +A Tcl module, zincText is available, it provides simple bindings for interactive +text input. For enabling interactive text editing on an item, the item should +be sensitive and should have the tag ``text''. + +A Perl module, called Tk::Zinc::Text (see the section +\conceptref{Tk::Zinc::Text}{zinctext}) is provided for easing text input in text items (it can also be used for text input in labelled items such as \objectref{track}, \objectref{waypoint} or \objectref{tabular}). + Applicable attributes for \ident{text} are: \attribute{text}{alignment}{alignment}{Specifies the horizontal alignment of the lines in @@ -3284,10 +3307,10 @@ the widget option \optref{forecolor}.} the parent group should be composed with the alpha of this item. The default value is {\tt true}.} \attribute{text}{composerotation}{boolean}{Specifies if the current rotation should be -composed with the local transform. The default value is {\tt true}.} +composed with the local transform. The default value is {\tt false}.} \attribute{text}{composescale}{boolean}{Specifies if the current scale should be composed -with the local transform. The default value is {\tt true}.} +with the local transform. The default value is {\tt false}.} \attribute{text}{connecteditem}{item}{Specifies the item relative to which this item is placed. Connected item should be in the same group. The default value is {\tt ""}.} @@ -3356,17 +3379,14 @@ defines the alpha transparency of the image when \optref{render} is set to true. The default value is the current value of the widget option \optref{forecolor}.} \attribute{icon}{composealpha}{boolean}{Specifies if the alpha value inherited from -the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +the parent group should be composed with the alpha of this item. The default value is +{\tt true}.} \attribute{icon}{composerotation}{boolean}{Specifies if the current rotation should be -composed with the local transform. The default value is {\tt false}. If this attribute -is set to {\tt true} without openGL rendering, it will be automatically set back to -{\tt false}.} +composed with the local transform. The default value is {\tt false}. \attribute{icon}{composescale}{boolean}{Specifies if the current scale should be composed -with the local transform. The default value is {\tt false}. If this attribute -is set to {\tt true} without openGL rendering, it will be automatically set back to -{\tt false}.} +with the local transform. The default value is {\tt false}. \attribute{icon}{connecteditem}{item}{Specifies the item relative to which this item is placed. Connected item should be in the same group. The default value is {\tt ""}.} |