IApplyMasterCmdData Class Reference

#include <IApplyMasterCmdData.h>

Inheritance diagram for IApplyMasterCmdData:

Public Types
enum	{ kDefaultIID = IID_IAPPLYMASTERCMDDATA }
enum	PageResizeChoice { kResizeToMasterPageSize, kKeepCurrentPageSize, kAskUserForPageResizeChoice }
enum	FlowChoice { kReflowText, kDontReflowText }

Public Member Functions
virtual void	SetApplyMasterCmdData (UIDRef masterSpreadUIDRef, PageResizeChoice resizeChoice)=0
virtual UIDRef	GetMasterSpreadUIDRef () const =0
virtual PageResizeChoice	GetPageResizeChoice () const =0
virtual FlowChoice	GetTextFlowChoice () const =0
virtual void	SetTextFlowChoice (FlowChoice flowChoice)=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 kApplyMasterSpreadCmdBoss to apply a master to a page, pages (or master pages). A master spread is applied to any page in a document, and stored via the IMasterPage interface.

Member Enumeration Documentation

enum IApplyMasterCmdData::FlowChoice

Values for how to reflow text through primary text flow frames when applying master pages.

Enumerator
kDontReflowText	Reflow text from primary text frame on old master to new master. This is the default value for the command if not specified. Don't reflow text. Used during transition states such as duplicating spreads due to order of master page override duplication.

Member Function Documentation

virtual UIDRef IApplyMasterCmdData::GetMasterSpreadUIDRef ( ) const

pure virtual

Return the UID of the master spread to be applied.

Parameters

none

Returns

UIDRef return the master spread UIDRef

virtual PageResizeChoice IApplyMasterCmdData::GetPageResizeChoice ( ) const

pure virtual

Return the PageResizeChoice passed to SetApplyMasterCmdData.

Parameters

none

Returns

PageResizeChoice

virtual FlowChoice IApplyMasterCmdData::GetTextFlowChoice ( ) const

pure virtual

Return the FlowChoice passed to command. Defaults to kReflowText if not specified.

Parameters

none

Returns

FlowChoice whether text should be reflowed through primary text frames when a master is applied to a page

virtual void IApplyMasterCmdData::SetApplyMasterCmdData ( UIDRef  masterSpreadUIDRef, PageResizeChoice  resizeChoice  )

pure virtual

Set the UIDRef of the master spread to use for applying to the page (or master pages) in the item list of the kApplyMasterSpreadCmdBoss. If a page has an applied master, that master will draw before the contents of the page draw on top. Note that a master page may also have another master applied to it. Use kInvalidUID to apply the "None" master to a page.

Parameters

masterSpreadUIDRef	the new master spread to apply the pages in the commands item list
resizeChoice	one of kResizeToMasterPageSize, kKeepCurrentPageSize, or kConsultUser

See Also

IMasterPage.h

virtual void IApplyMasterCmdData::SetTextFlowChoice ( FlowChoice  flowChoice )

pure virtual

Return the FlowChoice passed to command. Defaults to

Parameters

FlowChoice

whether text should be reflowed through primary text frames when a master is applied to a page

Returns

void