IIndexingDataSuite.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.
// 
//========================================================================================

#ifndef __IINDEXINGDATASUITE__
#define __IINDEXINGDATASUITE__

// ----- Interface files
#include "IPMUnknown.h"
#include "IIndexPageEntryData.h"
#include "IIndexXRefEntryData.h"

// ----- Include files
#include "IndexTopicEntry.h"
#include "K2Vector.h"
#include "K2Pair.h"

// ----- ID files
#include "TextID.h"

class WideString;
class RangeData;


// Associates a IndexTopicEntry with the position in the text
typedef K2Pair<IndexTopicEntry, TextIndex> TopicEntryInfoPair;
typedef K2Vector<TopicEntryInfoPair> TopicEntryInfoArray;

class IIndexingDataSuite : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINDEXINGDATASUITE };

 // ----- Abilities

 virtual bool16 CanCreateIndex() = 0;

 virtual bool16 CanGenerateIndex() = 0;

 virtual bool16 CanUpdateIndex() = 0;

 virtual void GetSelectedIndexStory(UIDRef& selectedIndexStory) = 0;

 virtual void GetSelectedText(WideString& selectedText) = 0;

 virtual void GetIndexMarkOfSelection(UID& indexMarkUID) = 0;

 // ----- Action

 virtual ErrorCode CreatePageReference
 (
 const IndexTopicEntry &entry,
 IIndexPageEntryData::PageRangeType pageRangeType,
 UID nextStyleUID,
 int32 numOfParOrPage,
 UID styleUID,
 bool16 updateSelection = kTrue,
 bool16 sortPRefs = kTrue
 ) = 0;

 virtual ErrorCode CreatePageReference1
 (
 const IndexTopicEntry &entry,
 IIndexPageEntryData::PageRangeType pageRangeType,
 UID nextStyleUID,
 int32 numOfParOrPage,
 UID styleUID,
 UIDRef textModelUIDRef,
 int32 start,
 int32 end,
 bool16 updateSelection = kTrue,
 bool16 sortPRefs = kTrue
 ) = 0;


 virtual ErrorCode CreatePageReferences
 (
 IIndexPageEntryData::PageRangeType pageRangeType,
 UID nextStyleUID,
 int32 numOfParOrPage,
 UID styleUID,
 bool16 updateSelection = kTrue,
 bool16 sortPRefs = kTrue,
 bool16 reversedNames = kFalse
 ) = 0;

 virtual ErrorCode CreatePageReferences1
 (
 TopicEntryInfoArray const& entries,
 IIndexPageEntryData::PageRangeType pageRangeType,
 UID nextStyleUID,
 int32 numOfParOrPage,
 UID styleUID,
 UIDRef textModelUIDRef,
 bool16 updateSelection = kTrue,
 bool16 sortPRefs = kTrue
 ) = 0;


 virtual ErrorCode CreateTopicEntriesForTopicList
 (
 UIDRef topicList,
 bool16 bReversedNames
 ) = 0;
};

#endif // __IINDEXINGDATASUITE__