IPDFFormXObjectData.h

//========================================================================================
// 
// $File$
// 
// Owner: DBerggren
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPDFFormXObjectData__
#define __IPDFFormXObjectData__

#include "IPMUnknown.h"
#include "K2Vector.h"
#include "K2Vector.tpp"
#include "KeyValuePair.h"
#include "PDFID.h"

#define FormID uint32

class IPDFFormXObjectData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPDFFORMXOBJECTDATA } ;

 typedef KeyValuePair< FormID, K2Vector< UID > > Forms;
 typedef KeyValuePair< int32, K2Vector< FormID > > Pages;

 typedef K2Vector< Forms > FormList;
 typedef K2Vector< Pages > PageList;

 virtual void CopyData(IPDFFormXObjectData const* otherData) = 0;

 virtual void SetRepeatInfo(int32 numberDefinitionPages, int32 totalNumberPages, bool16 bSuppressOnLastPage) = 0;

 virtual int32 GetNumberDefinitionPages() const = 0;

 virtual int32 GetTotalNumberPages() const = 0;

 virtual bool16 GetSuppressFormOnLastPage() const = 0;

 virtual void AddToFormList(FormID formID, K2Vector<UID> uidList) = 0;

 virtual void AddToPageList(int32 pageNum, K2Vector<FormID> formIDList) = 0;

 virtual void RemoveFromFormList(FormID formID) = 0;

 virtual void RemoveFromPageList(int32 pageNum) = 0;

 virtual void ClearFormList() = 0;

 virtual void ClearPageList() = 0;

 virtual K2Vector<UID> GetPageItemUIDsForFormID(FormID id) const = 0;

 virtual K2Vector<FormID> GetFormIDsForPageNum(int32 pageNum) const = 0;

 virtual FormList GetFormList() const = 0;

 virtual PageList GetPageList() const = 0;
};

#endif // __IPDFFormXObjectData__