IIndexTopicList.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 class keeps track of an Index Topic list on Session/Doc workspace.
// 
//========================================================================================

#ifndef __IINDEXTOPICLIST__
#define __IINDEXTOPICLIST__

#include "IndexingID.h"
#include "IIndexPageEntryData.h"
#include "KeyValuePair.h"

class PMString;
class WideString;
class IndexSectionHeader;
class IIndexHeaderSetOptions;
class IndexTopicEntry;
class UIDRef;

//----------------------------------------------------------------
// IDXPageRangeData Class declaration
//----------------------------------------------------------------
class IDXPageRangeData
{
 public:
 typedef object_type data_type;
 IDXPageRangeData():
 fStartPageIndex(-1),
 fEndPageIndex(-1),
 fStartPageString(kNullString),
 fEndPageString(kNullString),
 fStartPageUseTCY(kTrue),
 fEndPageUseTCY(kTrue),
 fMarkerPlace(IIndexPageEntryData::kDummyValue),
 fPageRangeType(IIndexPageEntryData::kNoPageRange),
 fStyleUID(kInvalidUID),
 fBookContentUID(kInvalidUID),
 fPageEntryUIDRef(kInvalidUIDRef)
 {}

 bool16 operator==(const IDXPageRangeData& other) const
 { 
 return ( (fStartPageIndex == other.fStartPageIndex) && 
 (fEndPageIndex == other.fEndPageIndex) && 
 (fStartPageString == other.fStartPageString) && 
 (fEndPageString == other.fEndPageString) && 
 (fStartPageUseTCY == other.fStartPageUseTCY) && 
 (fEndPageUseTCY == other.fEndPageUseTCY) && 
 (fMarkerPlace == other.fMarkerPlace) && 
 (fPageRangeType == other.fPageRangeType) &&
 (fStyleUID == other.fStyleUID) && 
 (fBookContentUID == other.fBookContentUID) );
 }

 int32 fStartPageIndex;
 int32 fEndPageIndex;
 PMString fStartPageString;
 PMString fEndPageString;
 bool16 fStartPageUseTCY;
 bool16 fEndPageUseTCY;
 IIndexPageEntryData::MarkerPlace fMarkerPlace;
 IIndexPageEntryData::PageRangeType fPageRangeType;
 UID fStyleUID;
 UID fBookContentUID;
 UIDRef fPageEntryUIDRef;
};

class IDXPageRangeKey
{
 public:
 typedef object_type data_type;
 IDXPageRangeKey():
 fSectionUID(kInvalidUID),
 fNthNode(-1),
 fNthEntry(-1)
 {}
 IDXPageRangeKey(const UID& sectionUID, const int32& nthNode, const int32& nthEntry):
 fSectionUID(sectionUID),
 fNthNode(nthNode),
 fNthEntry(nthEntry)
 {}
 bool16 operator==(const IDXPageRangeKey& other) const
 { 
 return ( (fSectionUID == other.fSectionUID) && 
 (fNthNode == other.fNthNode) && 
 (fNthEntry == other.fNthEntry) ); 
 }

 UID fSectionUID;
 int32 fNthNode;
 int32 fNthEntry;
};

typedef K2Vector<KeyValuePair<IDXPageRangeKey, IDXPageRangeData> > IDXPageRangeDataMap;

class IIndexTopicList : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINDEXTOPICLIST };

 virtual bool16 IsModifiedWithoutAvailableHSHandler() const = 0;

 virtual void SetModifiedWithoutAvailableHSHandler(bool16 modified) = 0;

 virtual const int32 GetNumTopicSections() const = 0;

 virtual const int32 GetNumTopics() const = 0;

 virtual void AddTopicSection(UID indexUID) = 0;

 virtual void RemoveTopicSection(UID indexUID) = 0;

 virtual void ClearTopicSectionList() = 0;

 virtual const UID GetNthTopicSectionUID(int32 id) const = 0;

 virtual const int32 GetTopicSectionId(UID sectionUID) const = 0;

 virtual const IndexSectionHeader& GetNthTopicSectionHeader(int32 id) const = 0;

 virtual void AddIndexInstance(const UID indexUID) = 0;

 virtual void RemoveIndexInstance(const UID indexUID) = 0;

 virtual const int32 GetNumOfIndexInstances() const = 0;

 virtual const UID GetNthIndexInstance(int32 id) const = 0;

 virtual const UID FindIndexInstanceByName(const PMString& name) const = 0;

 virtual const int32 GetParentNodeId(int32 sectionId, int32 childNodeId) const = 0;

 virtual const int32 GetNumChildrenOfNode(int32 sectionId, int32 parentNodeId, bool16 excludeUnused = kFalse) const = 0;

 virtual const int32 GetNthChildNodeId(int32 sectionId, int32 parentNodeId, int32 nth, bool16 excludeUnused = kFalse) const = 0;

 virtual const int32 GetChildRank(int32 sectionId, int32 parentNodeId, int32 childNodeId, bool16 excludeUnused = kFalse) const = 0;

 virtual void GetDisplayString(int32 sectionId, int32 nodeId, WideString& string) const = 0;

 virtual const int32 GetNumPageEntriesOfNode(int32 sectionId, int32 nodeId) const = 0;

 virtual const int32 GetPageEntryRankInNode(int32 sectionId, int32 nodeId, UIDRef entryUIDRef) const = 0;

 virtual void GetNthPageEntryUIDRef(int32 sectionId, int32 nodeId, int32 nth, UIDRef& entryUIDRef) const = 0;

 virtual const int32 GetNumXRefEntriesOfNode(int32 sectionId, int32 nodeId) const = 0;

 virtual const UID GetNthXRefEntryUID(int32 sectionId, int32 nodeId, int32 nth) const = 0;

 virtual const UID GetXRefLinksUID(int32 sectionId, int32 nodeId) const = 0;

 virtual void GetRefedTopicNodeId(const UID xRefLinksUID, UID& sectionUID, int32& nodeId) const = 0;

 virtual void GetTopicEntry(int32 sectionId, int32 nodeId, IndexTopicEntry& topicEntry) const = 0;

 virtual bool16 TopicEntryIsUsed(int32 sectionId, int32 nodeId, bool16 includeChildren = kTrue) const = 0;

 virtual bool16 FindTopicEntryByDisplay(IndexTopicEntry& topicEntry,
 int32 startSectionId = 0,
 int32 startNodeId = 0,
 int32* foundSectionId = NULL,
 int32* foundNodeId = NULL,
 bool16 caseSensitive = kTrue,
 bool16 wholeWord = kTrue,
 bool16 searchDir = kTrue) const = 0;

 virtual bool16 FindStringByDisplay(const WideString& str,
 int32 startSectionId = 0,
 int32 startNodeId = 0,
 int32 startXRefId = 0,
 int32* foundSectionId = NULL,
 int32* foundNodeId = NULL,
 int32* foundXRefId = NULL,
 bool16 caseSensitive = kTrue,
 bool16 wholeWord = kTrue,
 bool16 searchDir = kTrue,
 int32* currentSearchNum = NULL) const = 0;

 virtual bool16 FindPageEntrySectionUIDandNodeId(const UIDRef& pageEntryUIDRef, UID& sectionUID, int32& nodeId) const = 0;

 virtual bool16 FindTopicEntry(const IndexTopicEntry& topicEntry, UID* sectionUID, int32* nodeId) const = 0;


 //-------------- For Internal Use Only -------------------------

 virtual void GetIndexPageRangeDataMap(IDXPageRangeDataMap& dataMap) const = 0;

 virtual void UpdateIndexPageRangeDataMap(const IDXPageRangeKey& pageRangeKey, const IDXPageRangeData& pageRangeData) = 0;

 virtual void SetIndexPageRangeData(const IDXPageRangeKey& pageRangeKey, const IDXPageRangeData& pageRangeData) = 0;

 virtual void ClearIndexPageRangeData() = 0;

 virtual int32 FindNumberOfStringMatchesByDisplay(const WideString& str,
 int32 startSectionId = 0,
 int32 startNodeId = 0,
 int32 startXRefId = 0,
 int32* foundSectionId = NULL,
 int32* foundNodeId = NULL,
 int32* foundXRefId = NULL,
 bool16 caseSensitive = kTrue,
 bool16 wholeWord = kTrue,
 bool16 searchDir = kTrue) const = 0;
};

#endif // __IINDEXTOPICLIST__