IMasterSpreadCmdData Class Reference

#include <IMasterSpreadCmdData.h>

Inheritance diagram for IMasterSpreadCmdData:

Public Types
enum	{ kDefaultIID = IID_IMASTERSPREADCMDDATA }

Public Member Functions
virtual void	Set (const UIDRef &doc, int32 pagesPerSpreadCount, int32 position)=0
virtual const UIDRef &	GetDocument () const =0
virtual const int32	GetPagesPerSpreadCount () const =0
virtual const int32	GetPosition () const =0
virtual const PMString &	GetMasterSpreadBasename () const =0
virtual void	SetMasterSpreadBasename (const PMString &newName)=0
virtual const PMString &	GetMasterSpreadPrefix () const =0
virtual void	SetMasterSpreadPrefix (const PMString &newPrefix)=0
virtual void	SetBasedOnMasterUID (UID parent)=0
virtual UID	GetBasedOnMasterUID ()=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

Command data interface associated with commands for manipulating master spreads.

See Also

kNewMasterSpreadCmdBoss

kRenameMasterSpreadCmdBoss

Member Function Documentation

virtual UID IMasterSpreadCmdData::GetBasedOnMasterUID ( )

pure virtual

Get the master to be applied to this master

Returns

UID of master spread to be applied to this master (may be kInvalidUID for 'none')

virtual const UIDRef& IMasterSpreadCmdData::GetDocument ( ) const

pure virtual

Returns

UIDRef of document this command is targeted at

virtual const PMString& IMasterSpreadCmdData::GetMasterSpreadBasename ( ) const

pure virtual

Returns

base name of the master spread

virtual const PMString& IMasterSpreadCmdData::GetMasterSpreadPrefix ( ) const

pure virtual

Returns

the prefix of the master spread (e.g. 'A', 'B', etc.)

virtual const int32 IMasterSpreadCmdData::GetPagesPerSpreadCount ( ) const

pure virtual

Returns

number of pages specified for this master spread

virtual const int32 IMasterSpreadCmdData::GetPosition ( ) const

pure virtual

Returns

position in the master spread specified

virtual void IMasterSpreadCmdData::Set ( const UIDRef &  doc, int32  pagesPerSpreadCount, int32  position  )

pure virtual

Initialization

Parameters

doc	IN document target for this command
pagesPerSpreadCount	IN number of pages for this master spread
position	IN position in the master spread list for this master spread

virtual void IMasterSpreadCmdData::SetBasedOnMasterUID ( UID  parent )

pure virtual

Set the master which will be applied to this master

Parameters

parent

IN UID of master spread to be applied to this master (may be kInvalidUID for 'none')

virtual void IMasterSpreadCmdData::SetMasterSpreadBasename ( const PMString &  newName )

pure virtual

set the base name of the master spread

Parameters

newName

IN base name for the master spread

virtual void IMasterSpreadCmdData::SetMasterSpreadPrefix ( const PMString &  newPrefix )

pure virtual

Set the prefix of the master spread (e.g. 'A', 'B', etc.)

Parameters

newPrefix

IN prefix for the master (maximum 4 characters)