IDocSetupCmdData.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $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.
// 
// 
// Data interface for document setup commands.
// includes : page size
// number of pages
// number of pages per spread
// 
//========================================================================================

#ifndef __IDocSetupCmdData__
#define __IDocSetupCmdData__

#include "IPMUnknown.h"
#include "SpreadID.h"
#include "UIDRef.h"
#include "PMRect.h"
#include "PMReal.h"
#include "IPageSetupPrefs.h"
#include "K2Pair.h"

class IDataBase;

class IDocSetupCmdData : public IPMUnknown
{
public:
 virtual void SetDocSetupCmdData( const UIDRef& doc, /* which document to affect */
 const PMPageSize& newPageSize, /* dimensions of the new page size */
 int16 newNPages, /* how many pages should exist */
 int16 newNPagesPerSpread, /* how many pages should be in each spread */
 bool16 bWide, /* is page tall or wide? */
 int32 pageBinding, /* do pages read from right to left? */
 bool16 bRestartPageNum = kFalse) = 0; /* restart page number or not */
 /* Note: new bleed and slug parms NOT in Set rtn. See below */

 virtual void SetDocument(const UIDRef& doc) = 0;

 virtual void SetDocumentPageSize(const PMPageSize& newPageSize) = 0;

 virtual void SetNPages(const int16 newNPages) = 0;

 virtual void SetNPagesPerSpread(const int16 newNPagesPerSpread) = 0;

 virtual void SetPageOrientationIsWide(const bool16 bWide) = 0;

 virtual void SetPageBinding(const int32 pageBinding) = 0;

 virtual void SetRestartPageNum(const bool16 bRestartPageNum) = 0;

 virtual void SetBleedBox(const PMRect& offsets) = 0;

 virtual void SetUseUniformBleed(bool16 bUniform) = 0;

 virtual void SetSlugBox(const PMRect& offsets) = 0;

 virtual void SetUseUniformSlug(bool16 bUniform) = 0;

 virtual void SetStartPageNumber(int32 startPageNumber) = 0;

 virtual void SetIntent(DocumentIntent intent) = 0;

 virtual const UIDRef& GetDocument() const = 0;

 virtual const PMPageSize& GetDocumentPageSize() const = 0;

 virtual const int16 GetNPages() const = 0;

 virtual const int16 GetNPagesPerSpread() const = 0;

 virtual const bool16 GetPageOrientationIsWide() const = 0;

 virtual const int32 GetPageBinding() const = 0;

 virtual const bool16 GetRestartPageNum() const = 0;

 virtual const PMRect& GetBleedBox() const = 0;

 virtual const bool16 GetUseUniformBleed() const = 0;
 
 virtual const PMRect& GetSlugBox() const = 0;

 virtual const bool16 GetUseUniformSlug() const = 0;
 
 virtual const int32 GetStartPageNumber() const = 0;

 virtual const DocumentIntent GetIntent() const = 0;

 virtual void SetSpreadScale(const K2Pair<PMReal, PMReal>& scale) = 0;

 virtual PMReal GetSpreadWidthScale() const = 0;

 virtual PMReal GetSpreadHeightScale() const = 0;

};




#endif // __IDocSetupCmdData__