IAnnotationUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Sumit Pandey 
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change $
// ___________________
// 
// ADOBE CONFIDENTIAL
// 
// Copyright 2020 Adobe
// All Rights Reserved.
// 
// NOTICE: All information contained herein is, and remains
// the property of Adobe and its suppliers,
// if any. The intellectual and technical concepts contained
// herein are proprietary to Adobe and its
// suppliers and are protected by all applicable intellectual property
// laws, including trade secret and copyright laws.
// Dissemination of this information or reproduction of this material
// is strictly forbidden unless prior written permission is obtained
// from Adobe .
// 
//========================================================================================


#ifndef __IAnnotationUtils__
#define __IAnnotationUtils__

#include "PDFID.h"

#include "UIDList.h"

#include "AnnotationItem.h"
#include "itextRangeNode.h"
#include "ITextRangeList.h"

#include "IDocument.h"
#include <list>
class ITextModel;

class IAnnotationUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IANNOTATIONUTILS };

 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;
};

#endif // __IAnnotationUtils__