IMasterSpread Class Reference

#include <IMasterSpread.h>

Inheritance diagram for IMasterSpread:

Public Types
enum	{ kDefaultIID = IID_IMASTERSPREAD }

Public Member Functions
virtual void	GetName (PMString *pName) const =0
virtual void	SetBasename (const PMString &newBasename)=0
virtual void	GetBasename (PMString *pBasename) const =0
virtual void	SetPrefix (const PMString &newPrefix)=0
virtual void	GetPrefix (PMString *pPrefix) const =0
virtual UID	GetCurrentLayoutSpreadUID () const =0
virtual void	SetCurrentLayoutSpreadUID (const UID &newSpread)=0
virtual const PMMatrix &	GetCurrentSpreadOffset () const =0
virtual void	SetCurrentSpreadOffset (const PMMatrix &offset, UID currentPage)=0
virtual UID	GetTopLevelPageUID () 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

IMasterSpread persists the name of a master and contains the incremental information (beyond what is already contained in a spread) that defines a master spread. This interface exists on spreads which happen to be master spreads (kMasterPagesBoss), and does not exist on spreads which are not masters (regular kSpreadBoss). The document has an IMasterSpreadList which is a list of the document's IMasterSpreads.

See Also

kDocBoss

kMasterPagesBoss

kSpreadBoss

ISpread

Member Function Documentation

virtual void IMasterSpread::GetBasename ( PMString *  pBasename ) const

pure virtual

GetBasename - Get the base name of this master spread

Parameters

OUT

pBasename

virtual UID IMasterSpread::GetCurrentLayoutSpreadUID ( ) const

pure virtual

GetCurrentLayoutSpreadUID - Get the spread that is being drawn (i.e. the UID of the layout spread to which the master spread is applied). WARNING: This is ONLY valid while in the middle of drawing

Returns

UID&

virtual const PMMatrix& IMasterSpread::GetCurrentSpreadOffset ( ) const

pure virtual

GetCurrentSpreadOffset - Get the offset that has been applied to the view in order to draw the page. WARNING: This is ONLY valid while in the middle of drawing

Returns

PMPoint&

virtual void IMasterSpread::GetName ( PMString *  pName ) const

pure virtual

GetName - Get the name of the master spread the name is the combination of the prefix and the base name (separated by a '-') e.g. for the first/default master the base name will be 'Master', the prefix will be 'A', and the name returned by GetName will be 'A-Master'

Parameters

OUT	pName - name of this master

virtual void IMasterSpread::GetPrefix ( PMString *  pPrefix ) const

pure virtual

GetPrefix - Get the prefix associated with this master spread

Parameters

OUT

pPrefix

virtual UID IMasterSpread::GetTopLevelPageUID ( ) const

pure virtual

GetDrawingPageUID - Get the page that is currently being drawn. WARNING: This is ONLY valid while in the middle of drawing

virtual void IMasterSpread::SetBasename ( const PMString &  newBasename )

pure virtual

SetBasename - Set the base name of this master spread

Parameters

IN	newBasename

virtual void IMasterSpread::SetCurrentLayoutSpreadUID ( const UID &  newSpread )

pure virtual

SetCurrentLayoutSpreadUID - Set the spread that is being drawn (i.e. the UID of the layout spread to which the master spread is applied). Do NOT call this – it is called by the drawing code.

Parameters

newSpread

virtual void IMasterSpread::SetCurrentSpreadOffset ( const PMMatrix &  offset, UID  currentPage  )

pure virtual

SetCurrentSpreadOffset - Set the offset that has been applied to the view in order to draw the page and the current page that is drawing. Do NOT call this – it is called by the drawing code.

Parameters

currentPage
offset

virtual void IMasterSpread::SetPrefix ( const PMString &  newPrefix )

pure virtual

SetPrefix - Set the prefix associated with this master spread

Parameters

IN

newPrefix