IPageList.h

//========================================================================================
// 
// $File$
// 
// Owner: Tommy Donovan
// 
// $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.
// 
// 
// IPageList is a list of pages contained within a given document. 
// It is used to get page number strings.
// 
//========================================================================================

#ifndef __IPAGELIST__
#define __IPAGELIST__

#define kMinNumPages 1

#define kMaxNumPages 9999

#define kMinNumPagesPerSpread 1

#define kMaxNumPagesPerSpread 10

#ifndef __ODFRC__ // when used for core resource compilation, provide just the parameter range constants

#include "IPMUnknown.h"
#include "SpreadID.h"
#include "ILayoutUtils.h"
#include "ITextDataValidation.h"

class UIDList;
class PMString;
class IMargins;
class IColumns;

enum PageNumberType { kDefaultPageType = 0, kActualType, kOrdinalType, kActualWithNamedLayoutType };

const int kInvalidateMasterCache = kMaxInt32;

class IPageNameToUIDCache;

class IPageList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPAGELIST };

 virtual int32 GetPageCount() const= 0;

 virtual UID GetNthPageUID(int32 pageIndex) const = 0;

 virtual int32 GetPageIndex(UID pageUID, bool16 includePagesOfHiddenSpread = kTrue) const = 0;

 virtual PageType GetPageType (UID pageUID) const = 0;
 
 virtual IMargins* QueryPageMargins (UID pageUID) const = 0;
 
 virtual IColumns* Query__PageColumns (UID pageUID) const = 0;
 
 virtual void GetPageString(UID pageUID, PMString* pPageString,
 bool16 bIncludeSectionName = kTrue,
 bool16 bUseIntegerStyle = kTrue,
 PageNumberType pageNumberType = kDefaultPageType,
 bool16 bAbbreviate = kTrue,
 bool16 bIncludePagesOfHiddenSpread = kTrue) const = 0;

 virtual void GetPageRangeString(UIDList& pageUIDList, PMString* pPageString,
 bool16 bIncludeSectionName = kFalse,
 bool16 bUseIntegerStyle = kTrue,
 PageNumberType pageNumberType = kDefaultPageType,
 bool16 bSortPageUIDList = kFalse,
 bool16 bAbbreviate = kTrue,
 bool16 bIncludePagesOfHiddenSpread = kTrue) const = 0; 
 
 virtual UID PageStringToUID(PMString& pageString, PageNumberType pageNumberType = kDefaultPageType, ITextDataValidation::RangeError* nError = nil, IPageNameToUIDCache* pCache = nil) const = 0;

 virtual ITextDataValidation::RangeError PageRangeStringToUIDList(PMString& pageString, UIDList* pageUIDList, PageNumberType pageNumberType = kDefaultPageType) const = 0;

 virtual int32 GetSectionIndex(UID pageUID, bool16 bRequireNamedLayout = kFalse) const= 0;

 virtual void GetSectionString(UID pageUID, PMString* pSectionMarkerString) const = 0;

 virtual void InvalidateCache(int32 startingFromSpreadIndex = 0) = 0; 

 virtual void InvalidateMarginsCache(int32 startingFromSpreadIndex = 0) = 0; 

 virtual void InvalidateMarginsCache(const UIDList *invalidSpreadUIDs) = 0; 

 virtual void InvalidateColumnsCache(int32 startingFromSpreadIndex = 0) = 0; 

 virtual void InvalidateColumnsCache(const UIDList *invalidSpreadUIDs) = 0; 

 virtual IPageNameToUIDCache* CreatePageNameToUIDCache() const= 0;

 virtual void DestroyPageNameToUIDCache(IPageNameToUIDCache* pCache) const= 0;

 virtual UID GetLastPageUID(UIDList& pageUIDList, bool16 bSortPageUIDList = kFalse ) const = 0;
};
#endif // __ODFRC__


#endif // __IPAGELIST__