INewSpreadCmdData Class Reference

#include <INewSpreadCmdData.h>

Inheritance diagram for INewSpreadCmdData:

Public Types
enum	{ kDefaultIID = IID_INEWSPREADCMDDATA }
enum	SpreadIsIslandChoice { kPagesMayShuffleThroughNewSpread, kPreventPagesFromShufflingThroughNewSpread }

Public Member Functions
void	SetNewSpreadCmdData (const UIDRef &doc, int32 numberOfSpreadsToAdd, int32 spreadIndexForInsertion, SpreadIsIslandChoice bIslandSpread, int32 pagesPerNewSpread, const K2Vector< PMRect > *pageBoundingBoxes, const K2Vector< PMMatrix > *pageTransforms, const K2Vector< PMMatrix > *spreadTransforms)
void	SetNewSpreadCmdData (const UIDRef &doc, int32 numberOfSpreadsToAdd, int32 spreadIndexForInsertion, SpreadIsIslandChoice bIslandSpread, int32 pagesPerNewSpread, const PMPageSize &pageSize, const PMMatrix *spreadTransform=nil)
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
virtual void	SetNewSpreadCmdData_ (const UIDRef &doc, int32 numberOfSpreadsToAdd, int32 spreadIndexForInsertion, SpreadIsIslandChoice bIslandSpread, int32 pagesPerNewSpread, const K2Vector< PMRect > *pageBoundingBoxes, const K2Vector< PMMatrix > *pageTransforms, const K2Vector< PMMatrix > *spreadTransforms, const PMPageSize &pageSize)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Data interface for the kNewSpreadCmdBoss to insert spreads into a document.

Member Enumeration Documentation

enum INewSpreadCmdData::SpreadIsIslandChoice

Set up the command data for the kNewSpreadCmdBoss command.

Parameters

UIDRef&	doc set the document to create/insert the spreads in
int32	count how many spreads to create
int32	the position where to insert the spreads. 0 means start of document before any other spreads. Use ISpreadList::kAtTheEnd for end of document. Otherwise it's the index position the spread(s) will be after the command.
PMRect&	pageSize the page size for the newly inserted spreads, typically PMRect(0,0,0,0) to use document value
int32	pagesPerSpread typically use -1 to that the publication setting for pages per spread will be used.
bool16	bIslandSpread set to kTrue if the newly created spreads should be "island" spreads (shuffling won't affect them)

See Also

IPageSetupPrefs, GetPagesPerSpreadPref, IApplyMasterCmdData

Member Function Documentation

virtual const UIDRef& INewSpreadCmdData::GetNewSpreadDocument ( ) const

pure virtual

Return the document to insert the spread(s).

Parameters

none

Returns

const UIDRef& a reference to the document

virtual const int32 INewSpreadCmdData::GetNewSpreadInsertCount ( ) const

pure virtual

Return the number of spreads to create

Parameters

none

Returns

const int32 the number of spreads to create

virtual const int32 INewSpreadCmdData::GetNewSpreadInsertPosition ( ) const

pure virtual

Return the data member for the index position of the inserted spreads. 0 means start of document before any other spreads. Use ISpreadList::kAtTheEnd for end of document.

Parameters

none

Returns

const int32 the position value

See Also

ISpreadList.h

virtual const SpreadIsIslandChoice INewSpreadCmdData::GetNewSpreadIsIslandSpread ( ) const

pure virtual

Return the data member for if the newly created spreads should be "island" spreads. This is the same as "Keep Spread Together" or "Allow Pages to Shuffle" (actually the opposite meaning for "Allow Pages to Shuffle")

Parameters

none

Returns

const bool16 kTrue if new spreads should be islands (shuffling won't affect them), or kTrue for standard spreads.

virtual const K2Vector<PMRect>* INewSpreadCmdData::GetNewSpreadPageBoundingBoxes ( ) const

pure virtual

Return the data member for page size.

Parameters

none

Returns

const PMRect& the page size

virtual const int32 INewSpreadCmdData::GetPagesPerNewSpread ( ) const

pure virtual

Return the data member for how many pages each inserted spread should have

Parameters

none

Returns

const int32 the number of pages