INewSpreadCmdData.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.
// 
// 
// Command data interface for new spreads.
// 
//========================================================================================

#ifndef __INewSpreadCmdData__
#define __INewSpreadCmdData__

#include "IPMUnknown.h"
#include "SpreadID.h"
#include "UIDRef.h"
#include "PMRect.h"
#include "PMPageSize.h"

class IDataBase;

class INewSpreadCmdData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_INEWSPREADCMDDATA };

 enum SpreadIsIslandChoice { kPagesMayShuffleThroughNewSpread, kPreventPagesFromShufflingThroughNewSpread};

 inline void SetNewSpreadCmdData(
 const UIDRef& doc,
 int32 numberOfSpreadsToAdd,
 int32 spreadIndexForInsertion /* the value ISpreadList::kAtTheEnd == -1 is allowed*/, 
 SpreadIsIslandChoice bIslandSpread /*= kPagesMayShuffleThroughNewSpread*/,
 int32 pagesPerNewSpread /* -1 means use default (i.e., 2 for a facing page document, 1 otherwise)*/,
 const K2Vector<PMRect>* pageBoundingBoxes /* nil for default size, otherwise a K2Vector with pagesPerNewSpread PMRects*/,
 const K2Vector<PMMatrix>* pageTransforms /*nil for default placement, otherwise a K2Vector with pagesPerNewSpread PMMatrices*/,
 const K2Vector<PMMatrix>* spreadTransforms /* nil for default placement, otherwise a K2Vector with numberOfSpreadsToAdd PMMatrices */)
 {
 SetNewSpreadCmdData_(
 doc, numberOfSpreadsToAdd, spreadIndexForInsertion,bIslandSpread /*= kPagesMayShuffleThroughNewSpread*/,
 pagesPerNewSpread, pageBoundingBoxes, pageTransforms, spreadTransforms, pageBoundingBoxes && pageTransforms ? kPMPageSizeDefine : kPMPageSizeDefault /*use pageBoundingBoxes and pageTransforms*/);
 }



 inline void SetNewSpreadCmdData( const UIDRef& doc,
 int32 numberOfSpreadsToAdd,
 int32 spreadIndexForInsertion /* the value ISpreadList::kAtTheEnd == -1 is allowed*/,
 SpreadIsIslandChoice bIslandSpread,
 int32 pagesPerNewSpread,
 const PMPageSize& pageSize /* = kPMPageSizeNeighbor*/ /* kPMPageSizeNeighbor means use the page size of location where spread is inserting. kPMPageSizeDefault means use document default page size. */,
 const PMMatrix* spreadTransform = nil )
 {
 if ( spreadTransform )
 {
 K2Vector<PMMatrix> spreadTransforms;
 spreadTransforms.push_back(*spreadTransform);
 SetNewSpreadCmdData_(doc, numberOfSpreadsToAdd, spreadIndexForInsertion, bIslandSpread, pagesPerNewSpread, nil, nil, &spreadTransforms, pageSize);
 }
 else
 SetNewSpreadCmdData_(doc, numberOfSpreadsToAdd, spreadIndexForInsertion, bIslandSpread, pagesPerNewSpread, nil, nil, nil, pageSize);
 }
 

 virtual const UIDRef& GetNewSpreadDocument() const = 0;

 virtual const int32 GetNewSpreadInsertCount() const = 0;

 virtual const int32 GetNewSpreadInsertPosition() const = 0;

 virtual const int32 GetPagesPerNewSpread() const = 0;

 virtual const K2Vector<PMRect>* GetNewSpreadPageBoundingBoxes() const = 0;
 virtual const K2Vector<PMMatrix>* GetNewSpreadPageTransforms() const = 0;
 virtual PMPageSize GetNewSpreadPageSize() const = 0;
 virtual const K2Vector<PMMatrix>* GetNewSpreadTransforms() const = 0;

 virtual const SpreadIsIslandChoice GetNewSpreadIsIslandSpread() const = 0;

 // TEMPORARY api
 virtual void SetNewSpreadCmdData_(
 const UIDRef& doc,
 int32 numberOfSpreadsToAdd,
 int32 spreadIndexForInsertion /* the value ISpreadList::kAtTheEnd == -1 is allowed*/, 
 SpreadIsIslandChoice bIslandSpread /*= kPagesMayShuffleThroughNewSpread*/,
 int32 pagesPerNewSpread /* -1 means use default (i.e., 2 for a facing page document, 1 otherwise)*/,
 const K2Vector<PMRect>* pageBoundingBoxes /* nil for default size, otherwise a K2Vector with pagesPerNewSpread PMRects*/,
 const K2Vector<PMMatrix>* pageTransforms /*nil for default placement, otherwise a K2Vector with pagesPerNewSpread PMMatrices*/,
 const K2Vector<PMMatrix>* spreadTransforms /* nil for default placement, otherwise a K2Vector with numberOfSpreadsToAdd PMMatrices */,
 const PMPageSize& pageSize) = 0;

};




#endif // __INewSpreadCmdData__