IIndexPageEntryData.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 informations about an Index Page Entry.
// 
//========================================================================================

#ifndef __IINDEXPAGEENTRYDATA__
#define __IINDEXPAGEENTRYDATA__

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

class WideString;

class IIndexPageEntryData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IINDEXPAGEENTRYDATA };
 
 enum PageRangeType { kNoPageRange = 0, // SuppressPageNumber
 kCurrentPage = 1,
 kToNextStyleChange = 2,
 kToNextUseOfStyle = 3, // nextStyleUID must be filled
 kToEndOfStory = 4,
 kToEndOfDocument = 5,
 kToEndOfSection = 6,
 kForNextNParagraphs = 7, // nParOrPage must be filled
 kForNextNPages = 8 };

 enum MarkerPlace { kPage = 1,
 kPasteboard = 2,
 kMasterPage = 4,
 kOverset = 8,
 kHiddenLayer = 16,
 kUnplacedFrame = 32,
 kFootnote = 64,
 kNote = 128,
 kHiddenText = 256,
 kHiddenState = 512,
 kDummyValue = 0xFFFFFFFF};
 
 
 // Get/Set methods

 virtual void GetPageRangeType(PageRangeType& type, UID& nextStyleUID, int32& nParOrPage) const = 0; 

 virtual void SetPageRangeType(const PageRangeType type, const UID nextStyleUID, const int32 nParOrPage) = 0;

 virtual UID GetStyleUID() const = 0;

 virtual void SetStyleUID(const UID styleUID) = 0;

 virtual void GetPageRange(int32& startPage, int32& endPage) const = 0;

 virtual void SetPageRange(const int32 startPage, const int32 endPage) = 0;

 virtual void GetMarkerPlace(MarkerPlace& place) const = 0;

 virtual void SetMarkerPlace(const MarkerPlace place) = 0;

 virtual uint32 GetMarkerUniqueID() const = 0;
};

#endif // __IINDEXPAGEENTRYDATA__