From 83239736d5d87fa5a87d1f26a398f43bd4fb347c Mon Sep 17 00:00:00 2001 From: lecoanet Date: Tue, 25 Jun 2002 09:35:26 +0000 Subject: Ajustement des sous-commandes de find et addtag. --- doc/refman.tex | 69 +++++++++++++++++++++++++++------------------------------- 1 file changed, 32 insertions(+), 37 deletions(-) (limited to 'doc/refman.tex') diff --git a/doc/refman.tex b/doc/refman.tex index 76bae40..5a5411d 100644 --- a/doc/refman.tex +++ b/doc/refman.tex @@ -1254,17 +1254,13 @@ reference) and all list parameters are given as array references. \begin{itemize} \item{\tt\large - pathname {\bf addtag} tag above tagOrId ?inGroup? ?recursive?\\ - \$zinc->{\bf addtag}(tag, 'above', tagOrId, ?inGroup?, ?recursive? test1);} + pathname {\bf addtag} tag above tagOrId \\ + \$zinc->{\bf addtag}(tag, 'above', tagOrId);} Selects the item just above the one given by {\tt tagOrId}. If {\tt tagOrId} names more than one item, the topmost of these items in the display list will be used. If {\tt tagOrId} does - not refer to any item then nothing happen. The inGroup and - recursive optional parameters can be specified to restrict the - search with a tag matching several items. inGroup specifies a - group to start with instead of the top group and recursive - tells if the search should descend in the item tree or not. + not refer to any item then nothing happen. \item{\tt\large pathname {\bf addtag} tag all ?inGroup? ?recursive?\\ @@ -1274,39 +1270,40 @@ reference) and all list parameters are given as array references. Please use a form ``'withtag', 'all''' as documented below. \item{\tt\large - pathname {\bf addtag} tag atpriority priority ?inGroup? ?recursive?\\ - \$zinc->{\bf addtag}(tag, 'atpriority', priority, ?inGroup?, ?recursive?);} + pathname {\bf addtag} tag atpriority priority ?tagOrId?\\ + \$zinc->{\bf addtag}(tag, 'atpriority', priority, ?tagOrId?);} - Selects all the items at the given priority. The inGroup and - recursive can be specified to restrict the search. inGroup specifies - a group to start with instead of the top group and recursive tells - if the search should descend in the item tree or not. + Selects all the items at the given priority. The tagOrId optional + parameter can be specified to restrict the search. It specifies a + group to start with instead of the top group and it can be used to + control if the search should be recursive or not (see path tags for + more on this subject). \item{\tt\large - pathname {\bf addtag} tag below tagOrId ?inGroup? ?recursive?\\ - \$zinc->{\bf addtag}(tag, 'below', tagOrId, ?inGroup?, ?recursive?);} + pathname {\bf addtag} tag below tagOrId\\ + \$zinc->{\bf addtag}(tag, 'below', tagOrId);} Selects the item just below the one given by {\tt tagOrId}. If {\tt tagOrId} names more than one item, the lowest of these items in the display list will be used. If {\tt tagOrId} does - not refer to any item then nothing happen. The inGroup and - recursive optional parameters can be specified to restrict the - search with a tag matching several items. inGroup specifies a - group to start with instead of the top group and recursive - tells if the search should descend in the item tree or not. + not refer to any item then nothing happen. \item{\tt\large - pathname {\bf addtag} tag closest x y ?halo? ?startItem?\\ - \$zinc->{\bf addtag}(tag, 'closest', x, y, ?halo?, ?startItem?);} + pathname {\bf addtag} tag closest x y ?halo? ?startItem?, ?recursive?\\ + \$zinc->{\bf addtag}(tag, 'closest', x, y, ?halo?, ?startItem?, ?recursive?);} Selects the item closest to the point {\tt x - y}. Any item overlapping the point is considered as closest and the topmost is selected. If {\tt halo} is given, it defines the size of the point {\tt x - y}. {\tt halo} must be a non negative integer. If {\tt start} is specified, it must be - an item tag or id. If it names a valid item (for a tag, the lowest + an item tag or id. If it names a group and this group is not atomic, + the search starts with the first item of this group. + If it names a non group item or an atomic group (for a tag, the lowest item with the tag is considered), the search starts with the item below {\tt start} instead of the first item in the display order. If {\tt startItem} does not name a valid item, it is ignored. + If {\tt recursive} is specified it controls if the search should proceed + down the item hierarchy or not. \item{\tt\large pathname {\bf addtag} tag enclosed xo yo xc yc ?inGroup? ?recursive?\\ @@ -1338,22 +1335,20 @@ reference) and all list parameters are given as array references. See also the {\tt enclosed} variant above for a discussion on updating the geometry. \item{\tt\large - pathname {\bf addtag} tag withtag tagOrId ?inGroup? ?recursive?\\ - \$zinc->{\bf addtag}(tag, 'withtag', tagOrId, ?inGroup?, ?recursive?);} + pathname {\bf addtag} tag withtag tagOrId\\ + \$zinc->{\bf addtag}(tag, 'withtag', tagOrId);} - Selects all the items given by {\tt tagOrId}. The inGroup and - recursive can be specified to restrict the search. inGroup specifies - a group to start with instead of the top group and recursive tells - if the search should descend in the item tree or not. + Selects all the items given by {\tt tagOrId}. \item{\tt\large - pathname {\bf addtag} tag withtype type ?inGroup? ?recursive?\\ - \$zinc->{\bf addtag}(tag, 'withtype', tagOrId, ?inGroup?, ?recursive?);} + pathname {\bf addtag} tag withtype type ?tagOrId?\\ + \$zinc->{\bf addtag}(tag, 'withtype', type, ?tagOrId?);} - Selects all the items of type {\tt type}. The inGroup and - recursive can be specified to restrict the search. inGroup specifies - a group to start with instead of the top group and recursive tells - if the search should descend in the item tree or not. + Selects all the items of type {\tt type}. The tagOrId optional + parameter can be specified to restrict the search. It specifies a + group to start with instead of the top group and it can be used to + control if the search should be recursive or not (see path tags for + more on this subject). \end{itemize} \end{blockindent} @@ -1576,7 +1571,7 @@ false. \item{\tt\large pathname {\bf coords} tagOrId contourIndex\\ @coords = \$zinc->{\bf coords}(tagOrId, contourIndex);} - + Get all coordinates of contour at contourIndex. All items can answer if contourIndex is zero. Curves can handle other contours. @@ -1600,7 +1595,7 @@ false. rectangles and arcs, index must zero or one. \item{\tt\large - pathname {\bf coords} tagOrId contourIndex coordIndex coordList\\ + pathname {\bf coords} tagOrId contourIndex coordIndex coordList\\ \$zinc->{\bf coords}(tagOrId, contourIndex, coordIndex, coordList);} Set coordinate at coordIndex in contour at contourIndex. All items can do it if -- cgit v1.1