#include <IOverrideMasterPageItemData.h>

Inheritance diagram for IOverrideMasterPageItemData:

Public Types
enum	{ kDefaultIID = IID_IOVERRIDEMASTERPAGEITEMDATA }

Public Member Functions
virtual void	SetOverrideMasterPageItemData (const UIDList &mpPageItemUIDs, const UIDList &pageUIDs, const PMMatrixCollection &itemShifts)=0

virtual int32	GetOverrideCount ()=0

virtual bool16	GetNthOverride (int32 whichItem, UIDRef overriddenMasterPagePageItem, UIDRef pageOverriddenOn, UIDRef newPageItemUID, PMMatrix itemShift)=0

virtual bool16	SetNthOverride (int32 whichItem, UIDRef overriddenMasterPagePageItem, UIDRef pageOverriddenOn, UIDRef *newPageItemUID, PMMatrix itemShift)=0

virtual const UIDList &	GetMPItems ()=0

virtual const UIDList &	GetPagesHit ()=0

virtual const PMMatrixCollection &	GetItemShifts ()=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

This class is used to pass data to the OverrideMasterPageItemCmdBoss and retrieve data after the command has finished.

Member Function Documentation

virtual const PMMatrixCollection& IOverrideMasterPageItemData::GetItemShifts ( )

pure virtual

Get the list of item shifts - horizontal shifts to align the master page item to the correct location

Returns: list of page item shifts

virtual const UIDList& IOverrideMasterPageItemData::GetMPItems ( )

pure virtual

Get the list of master page items being overridden

Returns: UIDList with master page items being overridden

virtual bool16 IOverrideMasterPageItemData::GetNthOverride	(	int32	whichItem,
		UIDRef *	overriddenMasterPagePageItem,
		UIDRef *	pageOverriddenOn,
		UIDRef *	newPageItemUID,
		PMMatrix *	itemShift
	)

pure virtual

return the triplet that identifies the 'whichItem' override. (original item, page it is overridden on, new page item id) if the override was to delete the item or if the command hasn't finished yet, the newPageItemUID will be kInvalidUID.

Parameters

whichItem	IN index of item
overriddenMasterPagePageItem	OUT UIDRef of the master page item which was overridden
pageOverriddenOn	OUT UIDRef of the page the new override belongs to
newPageItemUID	OUT UIDRef of the new page item (the override)
itemShift	OUT horizontal distance the overridden item was shifted to appear in the correct location (e.g. a item overridden from a single page master in a facing pages spread will have a shift of +/- (1/2 page width) )

virtual int32 IOverrideMasterPageItemData::GetOverrideCount ( )

pure virtual

Returns: how many page items were overridden

virtual const UIDList& IOverrideMasterPageItemData::GetPagesHit ( )

pure virtual

Get the list of pages where the overridden page items will be

Returns: list of pages

virtual bool16 IOverrideMasterPageItemData::SetNthOverride	(	int32	whichItem,
		UIDRef *	overriddenMasterPagePageItem,
		UIDRef *	pageOverriddenOn,
		UIDRef *	newPageItemUID,
		PMMatrix	itemShift
	)

pure virtual

Set the n'th override to the specified triplet. Used internally by the command to set return data.

Parameters

whichItem	IN index of item to set values for
overriddenMasterPagePageItem	IN master page page item being overridden
pageOverriddenOn	IN page owning the overridden page item
newPageItemUID	IN overridden page item UID
itemShift	IN horizontal shift of master page item to page item

virtual void IOverrideMasterPageItemData::SetOverrideMasterPageItemData	(	const UIDList &	mpPageItemUIDs,
		const UIDList &	pageUIDs,
		const PMMatrixCollection &	itemShifts
	)

pure virtual

Initialization routine

Parameters

mpPageItemUIDs	IN page item UIDs from the master pages
pageUIDs	IN pages on which to override the master page items - must be same length as mpPageItemUIDs
itemShifts	IN horizontal shift for the master page items to correctly align on the page - must be same length as mpPageItemUIDs

Public Types

Public Member Functions

Detailed Description

Member Function Documentation