IShuffleCmdData Class Reference

#include <IShuffleCmdData.h>

Inheritance diagram for IShuffleCmdData:

Public Member Functions
virtual void	Set (const UIDRef &startSpread, const UIDRef &endSpread, int32 pagesPerSpread=-1)=0
virtual const UIDRef &	GetStartSpread () const =0
virtual const UIDRef &	GetEndSpread () const =0
virtual const int32	GetPagesPerSpread () const =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 kShufflePagesCmdBoss for shuffling pages in a document when pages are inserted, delete, duplicated, etc. Also can happen during section changes or page binding changes Typically this interface is used indirectly, use ILayoutUtils->MakeShuffleCmd(document) instead.

Member Function Documentation

virtual const UIDRef& IShuffleCmdData::GetEndSpread ( ) const

pure virtual

Return the last spread to shuffle

Parameters

none

Returns

a UIDRef to the last spread to shuffle.

virtual const int32 IShuffleCmdData::GetPagesPerSpread ( ) const

pure virtual

Return the value for pages per spread.

Parameters

none

Returns

the int32 value for pages per spread

virtual const UIDRef& IShuffleCmdData::GetStartSpread ( ) const

pure virtual

Return the first spread to start shuffling

Parameters

none

Returns

a UIDRef to the first spread to shuffle.

virtual void IShuffleCmdData::Set ( const UIDRef &  startSpread, const UIDRef &  endSpread, int32  pagesPerSpread = -1  )

pure virtual

Set the starting and ending spread for a page shuffle command (kShufflePagesCmdBoss). All spreads between and including these two spreads will be shuffled so that they layout out in a traditional manner. Document and page binding, page numbers, "keep together" spreads can all affect how many pages end up in a particular spread.

Parameters

startSpread	the first spread to staring shuffling, often the first spread of the document, but for performance reasons make be some other spread if it is known.
endSpread	the last spread to end shuffling, typically the last spread of the document.
pagesPerSpread	value. Typically use -1 to that the publication setting for pages per spread will be used.

See Also

IPageSetupPrefs, GetPagesPerSpreadPref