IIndexCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: Yves Carbonneaux
// 
// $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: This is generic interface for setting/getting command data during creating and generating Index.
// 
//========================================================================================

#ifndef __IIndexCmdData__
#define __IIndexCmdData__

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


class WideString;

class IIndexCmdData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINDEXCMDDATA };

 virtual const UIDRef& GetTargetItemRef() const = 0;

 virtual void SetTargetItemRef(const UIDRef& sourceItem) = 0;

 virtual void SetTextFrameRef(const UIDRef& textFrameItem) = 0;

 virtual UIDRef GetTextFrameRef() const = 0;
 
 virtual const bool16 GetReplaceExistingIndexFlag() const = 0;

 virtual void SetReplaceExistingIndexFlag(bool16 replaceExistingIndex) = 0; 

 virtual const bool16 GetVerticalFlag() const = 0;

 virtual void SetVerticalFlag(bool16 bVertical) = 0;

 virtual void SetTopicListRef(const UIDRef& topicListRef) = 0;

 virtual const UIDRef GetTopicListRef() const = 0;
 
 virtual void SetTextModelRef(const UIDRef& textModelRef) = 0;

 virtual const UIDRef GetTextModelRef() const = 0;

 virtual const WideString& GetTitle() const = 0;

 virtual void SetTitle(const WideString& indexTitle) = 0;

 // --- Get/Set include overset flag

 virtual const bool16& GetIncludeOversetFlag() const = 0;

 virtual void SetIncludeOversetFlag(const bool16& includeOverset) = 0;
};

#endif // __IIndexCmdData__