IXMLReferenceListData.h

//========================================================================================
// 
// $File$
// 
// Owner: Will Lin
// 
// $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 __IXMLREFERENCELISTDATA__
#define __IXMLREFERENCELISTDATA__

#include "IPMUnknown.h"
#include "XMLID.h"
#include "XMLReference.h"

class IXMLReferenceListData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IXMLREFERENCELISTDATA };

 enum _Placement {
 kBeginningIndex = 0,
 kEndIndex = -2,
 kInvalidIndex = -1
 };

 public:

 virtual void Insert(const XMLReference &xmlRef, int32 pos = kEndIndex) = 0;

 virtual void Remove(const XMLReference &xmlRef) = 0;

 virtual void Clear(void) = 0;

 virtual XMLReference Get(int32 index) const = 0;

 virtual void Set(int32 index, const XMLReference& newXMLRef) = 0;

 virtual int32 GetIndex(const XMLReference& xmlRef) const = 0;

 virtual int32 Size(void) const = 0;
};

#endif // __IXMLREFERENCELISTDATA__