ITOCStyleInfo.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.
// 
// 
// Comments: This interface saves the information about TOC style.
// 
//========================================================================================

#ifndef __ITOCSTYLEINFO__
#define __ITOCSTYLEINFO__

#include "IPMUnknown.h"
#include "K2Vector.h"
#include "KeyValuePair.h"
#include "TOCID.h"

class TOCFormatEntryInfo;
class PMString;

typedef K2Vector<KeyValuePair<PMString, TOCFormatEntryInfo> > FormatEntriesInfo;

class ITOCStyleInfo : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITOCSTYLEINFO };
 
 typedef enum {
 kHorizontal, // horizontal
 kVertical // vertical
 } TOCStoryDirection;

 typedef enum {
 kIncludeFullParagraph,
 kIncludeNumbersOnly,
 kExcludeNumbers
 } TOCNumberedParagraphsEntriesType;

 virtual const PMString& GetName() const = 0; 

 virtual void SetName(const PMString& s, bool16 translatable = kFalse) = 0;

 virtual const FormatEntriesInfo& GetTOCEntryMap() const = 0; 

 virtual void SetTOCEntryMap(const FormatEntriesInfo& tocEntryMap) = 0;

 virtual const bool16 GetIncludeHidderLayerFlag() const = 0;

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

 virtual const bool16 GetIncludeBookPubs() const = 0;

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

 virtual const bool16 GetRunInFlag() const = 0;

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

 virtual const UID GetTOCTitleFormatStyle() const = 0;

 virtual void SetTOCTitleFormatStyle(const UID formatStyle) = 0;

 virtual const PMString& GetTOCTitle() const = 0;

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

 virtual const PMString& GetBookName() const = 0;

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

 virtual const bool16 GetIncludeBookmarks() const = 0;

 virtual void SetIncludeBookmarks(const bool16 bIncludeBookmarks = kFalse) = 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 bool16 GetCreateTextAnchor() const = 0;

 virtual void SetCreateTextAnchor(bool16 insertTextAnchor) = 0;

 virtual const bool16 GetRemoveForcedLineBreak() const = 0;

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

#endif // __ITOCSTYLEINFO__