IIndexXRefEntryCmdData.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.
// 
// 
// Purpose: Interface data for creating, editing an XRef Page Entry
// 
//========================================================================================

#ifndef __IIndexXRefEntryCmdData__
#define __IIndexXRefEntryCmdData__

#include "IPMUnknown.h"
#include "IndexingID.h"
#include "UIDRef.h"
#include "IIndexXRefEntryData.h"

class IndexTopicEntry;

class IIndexXRefEntryCmdData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINDEXXREFENTRYCMDDATA };

 virtual IIndexXRefEntryData::XRefType GetXRefType(WideString* customString = NULL) const = 0; 

 virtual void SetXRefType(const IIndexXRefEntryData::XRefType xRefType, const WideString* customString = NULL) = 0;

 virtual const IndexTopicEntry& GetRefedTopicEntry() const = 0;

 virtual void SetRefedTopicEntry(const IndexTopicEntry& refedTopicEntry) = 0;

 virtual const UID GetRefedTopicSectionUID() const = 0;

 virtual void SetRefedTopicSectionUID(const UID refedTopicSectionUID) = 0;

 virtual int32 GetRefedTopicNodeId() const = 0;

 virtual void SetRefedTopicNodeId(int32 refedTopicNodeId) = 0;
};

#endif // __IIndexXRefEntryCmdData__