Inheritance diagram for IAnnotationUtils:

Public Types
enum	{ kDefaultIID = IID_IANNOTATIONUTILS }

Public Member Functions
virtual UIDList	GetListOfImportPDFAnnotUIDOnPageOrPageItems (const UIDList &uidList, bool bIsSortByTimeStamp=false, bool includeTextRanges=true)=0

virtual UIDList	GetListOfShare4ReviewAnnotUIDOnPageOrPageItems (const UIDList &uidList, bool bIsSortByTimeStamp=false, bool includeTextRanges=true)=0

virtual UIDList	GetListOfAnnotUIDOnTextRange (ITextModel *model, TextIndex start, TextIndex end, bool bIsSortByTimeStamp=false)=0

virtual UIDList	GetListOfAnnotUIDMappedToDoc (const UIDRef &doc)=0

virtual ErrorCode	DeleteAnnotation (const UIDRef &annotUIDRef)=0

virtual ErrorCode	DeleteAnnotationList (const UIDList &annotList)=0

virtual ErrorCode	ChangeAnnotationStatus (const UIDRef &annotation, const AnnotationStatus &newStatus)=0

virtual void	ReadAnnotationData (const UIDRef &annotUIDRef, AnnotationItem &annotData)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Member Function Documentation

virtual ErrorCode IAnnotationUtils::ChangeAnnotationStatus	(	const UIDRef &	annotation,
		const AnnotationStatus &	newStatus
	)

pure virtual

Change the  annotation status.

Parameters

annotation	- annotation to be changed.
newStatus	- new Status for the annotation.

Returns: ErrorCode - result of the operation.

virtual ErrorCode IAnnotationUtils::DeleteAnnotation ( const UIDRef & annotUIDRef )

pure virtual

Deletes annotation. This method deletes the specified annotation object and disassociate the annotation with corresponding annotation destination.

We delete the associated destination as well because there can only be one annotation referencing a destination.

Parameters

annotUIDRef - UIDRef of annotation to be deleted.

Returns: ErrorCode - result of the operation.

virtual ErrorCode IAnnotationUtils::DeleteAnnotationList ( const UIDList & annotList )

pure virtual

Deletes annotation list.

Parameters

annotList - annotation list to be deleted.

virtual UIDList IAnnotationUtils::GetListOfAnnotUIDMappedToDoc ( const UIDRef & doc )

pure virtual

Given a document return UID list of all annotations that are orphan and hence have been mapped to this document

Parameters

doc	- The UIDRef of the document

virtual UIDList IAnnotationUtils::GetListOfAnnotUIDOnTextRange	(	ITextModel *	model,
		TextIndex	start,
		TextIndex	end,
		bool	bIsSortByTimeStamp = `false`
	)

pure virtual

Given a text range return UID list of all annotation linked to this text range

Parameters

*model	- The text model to look at
start	- The start of the range
end	- The end of the range
bIsSortByTimeStamp	- true means sort the annotation list by time stamp

Returns: UIDList - uidList of all annotations linked to given text range

virtual UIDList IAnnotationUtils::GetListOfImportPDFAnnotUIDOnPageOrPageItems	(	const UIDList &	uidList,
		bool	bIsSortByTimeStamp = `false`,
		bool	includeTextRanges = `true`
	)

pure virtual

Given a uidList of page/pageitems return UID list of all import PDF annotation linked to these page/pageitems.

Parameters

uidList - list of page/pageitems

Returns: UIDList - uidList of all annotations linked to page/pageitems list

Parameters

bIsSortByTimeStamp - true means sort the annotation list by time stamp

Returns: includeTextRanges - false means do not get all the text ranges on the pageitem if it is a text frame

virtual UIDList IAnnotationUtils::GetListOfShare4ReviewAnnotUIDOnPageOrPageItems	(	const UIDList &	uidList,
		bool	bIsSortByTimeStamp = `false`,
		bool	includeTextRanges = `true`
	)

pure virtual

Given a uidList of page/pageitems return UID list of all share for review annotation linked to these page/pageitems.

Parameters

uidList - list of page/pageitems

Returns: UIDList - uidList of all annotations linked to page/pageitems list

Parameters

bIsSortByTimeStamp - true means sort the annotation list by time stamp

Returns: includeTextRanges - false means do not get all the text ranges on the pageitem if it is a text frame

virtual void IAnnotationUtils::ReadAnnotationData	(	const UIDRef &	annotUIDRef,
		AnnotationItem &	annotData
	)

pure virtual

Given the annotation UID it fills the structure AnnotationItem with complete data of annotation.

Parameters

annotation	- annotation to be read.
annotData	- structure AnnotationItem which will be filled by annotation Data

Public Types

Public Member Functions

Member Function Documentation