IIndexEntryData.h

//========================================================================================
// 
// $File$
// 
// Owner: Michel Hutinel
// 
// $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.
// 
// 
// Comments: This interface saves the information about a Index Entry.
// 
//========================================================================================

#ifndef __IINDEXENTRYDATA__
#define __IINDEXENTRYDATA__

#include "IPMUnknown.h"
#include "IndexingID.h"

class IndexTopicEntry;
class UIDRef;

class IIndexEntryData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINDEXENTRYDATA };
 
 enum IndexEntryType { kNoEntryType, kPageRefType, kXRefType };

 virtual const IndexEntryType GetEntryType() const = 0; 

 virtual void SetEntryType(const IndexEntryType entryType) = 0;

 virtual const UID GetTopicSectionUID() const = 0; 

 virtual void SetTopicSectionUID(const UID topicSectionUID) = 0;

 virtual void GetTopicEntry(IndexTopicEntry& topicEntry, UID *sectionUID = nil, int32 *nodeId = nil) const = 0;

 virtual void GetTopicListUIDRef(UIDRef& topicListUIDRef) const = 0;

 virtual const UID GetBookContentUID() const = 0; 

 virtual void SetBookContentUID(const UID& bookContentUID) = 0;
};

#endif // __IINDEXENTRYDATA__