ISectionCmdData.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 __ISECTIONCMDDATA__
#define __ISECTIONCMDDATA__

#include "IPMUnknown.h"
#include "ISection.h"

class PMString;

class ISectionCmdData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ISECTIONCMDDATA };

 virtual void Set(const UIDRef& sectionList,
 UID startPageUID = kInvalidUID,
 int32 startPageNumber = 1,
 const PMString *name = nil, 
 const PMString *marker = nil, 
 ClassID styleProviderClassID = kInvalidClass,
 bool16 bContinueFromPrevSection = kTrue,
 int32 offsetFromPrevSection = 0) = 0;

 virtual const UIDRef& GetSectionList() = 0;

 virtual UID GetStartPageUID() = 0;

 virtual int32 GetStartPageNumber() = 0;

 virtual const PMString& GetName() = 0;

 virtual const PMString& GetMarker() = 0;

 virtual void GetStyleInfo(ClassID* styleProviderClassID) = 0;

 virtual bool16 GetContinueFromPrevSection() = 0;

 virtual int32 GetOffsetFromPrevSection() = 0;

 virtual const bool16& GetPageNumberIncludeSectionPrefix() = 0;

 virtual void SetPageNumberIncludeSectionPrefix(const bool16& includeSectionPrefix) = 0;

 virtual const PMString& GetNamedLayout() = 0;

 virtual void SetNamedLayout(const PMString* pNamedLayout) = 0;

 virtual ISection::PaginationOption GetPaginationOption() = 0;

 virtual void SetPaginationOption(ISection::PaginationOption option) = 0;

 virtual UID GetPaginationMaster() = 0;

 virtual void SetPaginationMaster(UID masterUID) = 0;

 virtual const bool16& GetNotifyFlag() = 0;

 virtual void SetNotifyFlag(const bool16& notify = kTrue) = 0;

 virtual void CopyFrom(ISection* section) = 0;

 virtual void SetStartPageUID(const UID startPageUID) = 0;

};


#endif // __ISECTIONCMDDATA__