ITOCCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: Yeming Liu
// 
// $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 creating and generating TOC.
// 
//========================================================================================

#ifndef __ITOCCMDDATA__
#define __ITOCCMDDATA__

#include "IPMUnknown.h"

#include "ITOCStyleInfo.h"

#include "TOCID.h"

class TOCEntryInfo;

class ITOCCmdData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITOCCMDDATA };

 typedef enum {kAfterEntry, kBeforeEntry, kNotIncluded} PageNumPosition;

 virtual const bool16 GetIncludeHidderLayerFlag() const = 0;

 virtual const bool16 GetReplaceExistingTOCFlag() const = 0;

 virtual const bool16 GetIncludeBookPubs() const = 0;

 virtual const bool16 GetRunInFlag() const = 0; 

 virtual void SetIncludeHidderLayerFlag(const bool16 includeHidderLayer = kFalse) = 0;

 virtual void SetReplaceExistingTOCFlag(const bool16 replaceExistingTOC = kFalse) = 0;

 virtual void SetIncludeBookPubs(const bool16 includeBookPubs = kFalse) = 0;

 virtual void SetRunInFlag(const bool16 runIn = kFalse) = 0;

 virtual const PMString& GetBookName() const = 0;

 virtual void SetBookName(const PMString& bookName) = 0;

 virtual const bool16 GetIncludeOversetFlag() const = 0;

 virtual void SetIncludeOversetFlag(bool16 includeOverset) = 0;

 virtual void SetFormatEntryMap(const FormatEntriesInfo& formatStyleMap) = 0;

 virtual const FormatEntriesInfo& GetFormatEntryMap() const = 0; 

 virtual const bool16 GetIncludeBookmarks() const = 0;

 virtual void SetIncludeBookmarks(const bool16 bIncludeBookmarks = kFalse) = 0;

 virtual const UIDRef& GetTargetItem() const = 0;

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

 virtual const PMString GetTOCTitle() const = 0;

 virtual void SetTOCTitle(const PMString& tocTitle) = 0;

 virtual const UID GetTOCTitleFormatStyle() const = 0;

 virtual void SetTOCTitleFormatStyle(const UID formatStyle) = 0;

 virtual const UIDRef& GetTextModelUIDRef() const = 0;

 virtual void SetTextModelUIDRef(const UIDRef& textModelUIDRef = UIDRef(nil, kInvalidUID)) = 0;

 virtual void SetTOCEntryInfoList(const K2Vector<TOCEntryInfo>& tocEntryInfoList) = 0;

 virtual const K2Vector<TOCEntryInfo>& GetTOCEntryInfoList() const = 0;

 virtual const ITOCStyleInfo::TOCStoryDirection GetStoryDirection() const = 0;

 virtual void SetStoryDirection(const ITOCStyleInfo::TOCStoryDirection storyDirection = ITOCStyleInfo::kHorizontal) = 0;

 virtual const ITOCStyleInfo::TOCNumberedParagraphsEntriesType GetNumberedParagraphsEntriesType() const = 0;

 virtual void SetNumberedParagraphsEntriesType(const ITOCStyleInfo::TOCNumberedParagraphsEntriesType numberedParagraphsEntriesType = ITOCStyleInfo::kIncludeFullParagraph) = 0;

 virtual const PMString& GetTOCStyleName() const = 0;

 virtual void SetTOCStyleName(const PMString& styleName) = 0;

 virtual const bool16 GetCreateTextAnchor() const = 0;

 virtual void SetCreateTextAnchor(bool16 createAnchor) = 0;

 virtual const bool16 GetRemoveForcedLineBreak() const = 0;

 virtual void SetRemoveForcedLineBreak(bool16 removeForcedLineBreak) = 0;
};

#endif // __ITOCCMDDATA__