ISection.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 __ISECTION__
#define __ISECTION__

#define kMinPageNumber 1

#define kMaxPageNumber 999999


#ifndef __ODFRC__

#include "IPMUnknown.h"
#include "SectionID.h"

class PMString;
class SectionStyle;

class ISection : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISECTION };

 virtual void Set(PMString& sectionName,
 PMString& sectionMarker,
 UID startPageUID,
 int32 startPageNumber,
 ClassID styleProviderClassID,
 bool16 bContinueFromPrevSection = kFalse,
 int32 offsetFromPrevSection = 0) = 0;

 virtual void SetName(PMString& sectionName) = 0;

 virtual void SetMarker(PMString& markerName) = 0;

 virtual void SetStartPageUID(UID startPageUID) = 0;

 virtual void SetStartPageNumber(int32 startPageNumber) = 0;

 virtual void SetNonHiddenStartPageNumber(int32 nonHiddenStartPageNumber) = 0 ;


 virtual void SetStyleInfo(ClassID styleProviderClassID) = 0;

 virtual void SetContinueFromPrevSection(bool16 bContinueFromPrevSection, int32 offset = 0) = 0;

 virtual void SetPageNumberIncludeSectionPrefix(bool16 includeSectionPrefix) = 0;

 virtual void SetNamedLayout(const PMString& namedLayout) = 0;

 virtual void GetName(PMString* pName) = 0;

 virtual void GetMarker(PMString* pMarker) = 0;

 virtual UID GetStartPageUID() = 0;

 virtual UID GetNonHiddenStartPageUID() = 0;

 virtual int32 GetStartPageNumber() = 0;

 virtual int32 GetNonHiddenStartPageNumber() = 0;

 virtual void GetStyleInfo(ClassID* styleProviderClassID) = 0;

 virtual bool16 IsDefaultSection() = 0;

 virtual bool16 GetContinueFromPrevSection() = 0;

 virtual int32 GetOffsetFromPrevSection() = 0;

 virtual bool16 GetPageNumberIncludeSectionPrefix() = 0;

 virtual int32 GetNumPages(const bool16 bRequireNamedLayout = kFalse) = 0;

 virtual void GetNamedLayout(PMString* pNamedLayout) = 0;

 typedef enum
 {
 kInvalidPaginationOption = -1, 
 kAutomatic = 0, 
 kFromLastPage, 
 } PaginationOption;

 virtual PaginationOption GetPaginationOption() = 0;

 virtual void SetPaginationOption(PaginationOption option) = 0;

 virtual UID GetPaginationMaster() = 0;

 virtual void SetPaginationMaster(UID masterUID) = 0;

 virtual void RecalculateNonHiddenPageUID() = 0;
};

#endif // __ODFRC__
#endif // __ISECTION__