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

#ifndef __ISECTIONLIST__
#define __ISECTIONLIST__

#include "IPMUnknown.h"
#include "IPageList.h"
#include "SpreadID.h"
#include "SectionID.h"

class ISection;
class UIDList;
class PMString;

class ISectionList : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISECTIONLIST };

 enum { kAtTheEnd = -1 };

 virtual UID NewSection() = 0;

 virtual void InsertSections(const UIDList& sectionsToInsert, int32 posForInsert) = 0;

 virtual void RemoveSections(int32 firstIndex, int32 count) = 0;

 virtual void MoveSection(int32 from, int32 to) = 0;

 virtual ISection * QueryNthSection(int32 sectionIndex) = 0;

 virtual UID GetNthSectionUID(int32 sectionIndex) = 0;

 virtual int32 GetSectionCount() = 0;

 virtual int32 GetSectionIndex(ISection * section) = 0;

 virtual int32 GetSectionIndex(UID sectionUID) = 0;

 virtual void GetPageString(UID pageUID, PMString* pPageString,
 bool16 bIncludeSectionName = kTrue, 
 bool16 bUseIntegerStyle = kTrue, 
 PageNumberType pageNumberType = kDefaultPageType, 
 bool16 bAbbreviate = kTrue,
 bool16 bIncludePagesOfHiddenSpread = kTrue) = 0; 


 virtual void GenerateNewSectionName(PMString* pName) = 0;

 virtual UIDList* QueryOrderedList() = 0;

 virtual int32 GetPageNumber(UID pageUID, bool16 bIncludePagesOfHiddenSpread = kTrue) = 0;

 virtual UIDList* GetOrderedList() = 0;
};


#endif // __ISECTIONLIST__