IIndexOptions.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 an Index instance (generated index).
// 
//========================================================================================

#ifndef __IINDEXOPTIONS__
#define __IINDEXOPTIONS__

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

class PMString;
class WideString;

class IIndexOptions : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINDEXOPTIONS };
 
 virtual const WideString& GetTitle() const = 0;

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

 virtual const PMString& GetTitleParagraphStyle() const = 0;

 virtual void SetTitleParagraphStyle(const PMString& style) = 0;

 virtual const bool16 GetReplaceExistingIndexFlag() const = 0;

 virtual void SetReplaceExistingIndexFlag(bool16 replaceExistingIndex = kFalse) = 0; 

 virtual const PMString& GetBookName() const = 0;

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

 typedef enum {
 kDocumentScope = 0,
 kBookScope = 1
 } Scope;

 virtual const IIndexOptions::Scope GetScope() const = 0;

 virtual void SetScope(const IIndexOptions::Scope scope = kDocumentScope) = 0;

 virtual const bool16 GetShowEntriesOnHiddenLayerFlag() const = 0;

 virtual void SetShowEntriesOnHiddenLayerFlag(bool16 showEntriesOnHiddenLayer = kFalse) = 0;

 typedef enum {
 kNested,
 kRunIn
 } IndexFormat;

 virtual const IIndexOptions::IndexFormat GetIndexFormat() const = 0;

 virtual void SetIndexFormat(const IIndexOptions::IndexFormat format = kNested) = 0;

 virtual const bool16 GetShowSectionHeadersFlag() const = 0;

 virtual void SetShowSectionHeadersFlag(bool16 showSectionHeaders = kTrue) = 0;

 virtual const bool16 GetShowEmptySectionsFlag() const = 0;

 virtual void SetShowEmptySectionsFlag(bool16 showEmptySections = kFalse) = 0;

 virtual const WideString& GetFollowingTopicSeparator() const = 0;

 virtual void SetFollowingTopicSeparator(const WideString& separator) = 0;

 virtual const WideString& GetBetweenPageNumberSeparator() const = 0;

 virtual void SetBetweenPageNumberSeparator(const WideString& separator) = 0;

 virtual const WideString& GetBetweenEntriesSeparator() const = 0;

 virtual void SetBetweenEntriesSeparator(const WideString& separator) = 0;

 virtual const WideString& GetBeforeXRefSeparator() const = 0;

 virtual void SetBeforeXRefSeparator(const WideString& separator) = 0;

 virtual const WideString& GetPageRangeSeparator() const = 0;

 virtual void SetPageRangeSeparator(const WideString& separator) = 0;

 virtual const WideString& GetEntryEndSeparator() const = 0;

 virtual void SetEntryEndSeparator(const WideString& separator) = 0;

 virtual void GetTopicLevelParagraphStyle(const int32 level, PMString& style) const = 0;

 virtual void SetTopicLevelParagraphStyle(const int32 level, const PMString& style) = 0;

 virtual const PMString& GetSectionHeaderParagraphStyle() const = 0;

 virtual void SetSectionHeaderParagraphStyle(const PMString& style) = 0;

 virtual const PMString& GetPageNumberCharacterStyle() const = 0;

 virtual void SetPageNumberCharacterStyle(const PMString& style) = 0;

 virtual const PMString& GetCrossRefCharacterStyle() const = 0;

 virtual void SetCrossRefCharacterStyle(const PMString& style) = 0;

 virtual const PMString& GetReferencedCharacterStyle() const = 0;

 virtual void SetReferencedCharacterStyle(const PMString& style) = 0;

 typedef enum {
 kHorizontal,
 kVertical
 } FrameType;

 virtual const IIndexOptions::FrameType GetFrameType() const = 0;

 virtual void SetFrameType(const IIndexOptions::FrameType frameType = kHorizontal) = 0;

 virtual void CopyDataFrom(const IIndexOptions* source, bool16 bDirty = kTrue) = 0;
};

#endif // __IINDEXOPTIONS__