IMasterSpreadList Class Reference

#include <IMasterSpreadList.h>

Inheritance diagram for IMasterSpreadList:

Public Types
enum	{ kDefaultIID = IID_IMASTERSPREADLIST }
enum	{ kAtTheEnd = -1 }

Public Member Functions
virtual void	InsertMasterSpreads (const UIDList &spreadToInsert, int32 posForInsert)=0
virtual void	RemoveMasterSpread (int32 index)=0
virtual IGeometry *	QueryNthMasterSpread (int32 spreadIndex)=0
virtual UID	GetNthMasterSpreadUID (int32 spreadIndex)=0
virtual int32	GetMasterSpreadCount ()=0
virtual int32	GetMasterSpreadIndex (IGeometry *spread)=0
virtual int32	GetMasterSpreadIndex (UID spreadUID)=0
virtual IIterator *	NewPageIterator ()=0
virtual void	GenerateNewMasterName (PMString *pPrefix, PMString *pName, bool16 duplicate=kFalse)=0
virtual UID	FindMasterByName (PMString prefix, PMString basename)=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

IMasterSpreadList is an interface off the document containing a list of the IMasterSpreads in the document. Note that this is modeled after the ISpreadList.

See Also

ISpreadList

kDocBoss

Member Function Documentation

virtual UID IMasterSpreadList::FindMasterByName ( PMString  prefix, PMString  basename  )

pure virtual

FindMasterByName - return UID of master with the given name

Parameters

IN	prefix - master of interest prefix
IN	basename - master of interest name

Returns

UID

virtual void IMasterSpreadList::GenerateNewMasterName ( PMString *  pPrefix, PMString *  pName, bool16  duplicate = kFalse  )

pure virtual

GenerateNewMasterName - Generates a unique master name, of the form "A-Master", "B-Master", .... if the suggested name is used, a number will be appended

Parameters

IN/OUT	pPrefix - on input, caller's suggestion for a prefix, on return a generated prefix or the same as input, if input is not empty
IN/OUT	pName - on input, caller's suggestion for a name; on output, generated name (will be the same as input if input name is legal and not already used), if no input name, try to use "Master", if input already used a number will be appended;
IN	duplicate - kTrue == if suggested prefix/name combo already used, get new prefix.

virtual int32 IMasterSpreadList::GetMasterSpreadCount ( )

pure virtual

GetMasterSpreadCount - Return the number of master spreads in this list (i.e. in this document)

Returns

int32 - the number of master spreads in this list (i.e. in this document)

virtual int32 IMasterSpreadList::GetMasterSpreadIndex ( IGeometry *  spread )

pure virtual

GetMasterSpreadIndex - Return the index of the specified master spread

Parameters

spread

Returns

int32 - the index of the specified master spread

virtual int32 IMasterSpreadList::GetMasterSpreadIndex ( UID  spreadUID )

pure virtual

GetMasterSpreadIndex - Return the index the master spread with the given UID

Parameters

spreadUID

Returns

int32 - the index the master spread with the given UID

virtual UID IMasterSpreadList::GetNthMasterSpreadUID ( int32  spreadIndex )

pure virtual

GetNthMasterSpreadUID - Return the UID of the master spread at 'spreadIndex' in this list

Parameters

spreadIndex

Returns

UID

virtual void IMasterSpreadList::InsertMasterSpreads ( const UIDList &  spreadToInsert, int32  posForInsert  )

pure virtual

InsertMasterSpreads - Insert new master spread(s) into this document following 'posForInsert'. This is most likely to be called from the 'NewMasterSpreadCmd'.

Parameters

spreadToInsert
posForInsert

virtual IIterator* IMasterSpreadList::NewPageIterator ( )

pure virtual

NewPageIterator - create a page iterator & return the generic IIterator to the caller NOTE : The caller is responsible for deleteing the returned iterator

Returns

IIterator*

virtual IGeometry* IMasterSpreadList::QueryNthMasterSpread ( int32  spreadIndex )

pure virtual

QueryNthMasterSpread - Return the 'spreadIndex' master spread. n.b. this will add a ref count to the object

Parameters

spreadIndex

Returns

IGeometry* - add refed master spread's IGeometry

virtual void IMasterSpreadList::RemoveMasterSpread ( int32  index )

pure virtual

RemoveMasterSpread - Remove a master spread at index 'index'

Parameters

index