Function tip_DisplaceAnnotations


Prototype: tip_DisplaceAnnotations(Document);
Arguments:

Document: A Document Object (CDM_Document)
offset: A character offset after which all offsets are modified (long)
displacement: The number of characters that offsets will be moved (long)


Prototype: tip_DisplaceAnnotations(Annotation);
Arguments:

Document: A Document Object (CDM_Document)
offset: A character offset after which all offsets are modified (long)
displacement: The number of characters that offsets will be moved (long)

C++ API Sections
Tcl API Sections
Description
Return Value
Notes
See Also
Index

Description:

tip_DisplaceAnnotations(Document):
This function displases or "moves" the Annotations of the specified Document by "displacement" characters. This function will iterate over all Annotations contained in the Document. For each Annotation, all spans contained in the span set will be examined: for each offset in the span (either start or end), if it is equal or greater than the value provided by the "offset" parameter, then the value of the "displacement" parameter will be added.

tip_DisplaceAnnotations(Annotation):

Return Value:

tip_DisplaceAnnotations(Document):
The return value from this function will be a standart Tcl completion code (of type int). As this function ignores any possible errors, the return value will always be TCL_OK.

tip_DisplaceAnnotations(Annotation):

Notes:

tip_DisplaceAnnotations(Document):
This function is equivelant to CDM_DisplaceAnnotations (C++ API).

tip_DisplaceAnnotations(Annotation):

See Also:

tip_DisplaceAnnotations(Document):
tip_DisplaceAnnotation, CDM_DisplaceAnnotations

tip_DisplaceAnnotations(Annotation):


Generated by: petasis@aias on Wed Aug 16 10:31:45 PM EEST 2006.