IMasterOverrideList Class Reference

#include <IMasterOverrideList.h>

Inheritance diagram for IMasterOverrideList:

Public Types
enum	{ kDefaultIID = IID_IMASTEROVERRIDELIST }

Public Member Functions
virtual int32	OverrideCount ()=0
virtual void	AddOverride (UID masterUID, UID pageUID)=0
virtual void	AddOverride (IMasterOverrideList *masterOverrides)=0
virtual void	RemoveOverride (UID masterUID)=0
virtual void	RemoveAllOverrides ()=0
virtual int32	GetNthOverrideIndex (UID mpUID, int32 nthOverride) const =0
virtual int32	GetOverrideIndexCount (UID mpUID) const =0
virtual bool16	HasOverrides (UID mpUID) const =0
virtual void	GetOverridePair (int32 index, UID *mpUID, UID *pgUID)=0
virtual UID	GetOverride (int32 idx)=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

An interface for a page (kPageBoss) which contains a list the master spread items overridden on that page.

See Also

kPageBoss

kMasterPagesBoss

Member Function Documentation

virtual void IMasterOverrideList::AddOverride ( UID  masterUID, UID  pageUID  )

pure virtual

add an override

Parameters

masterUID	IN the UID of the master page pageitem being overridden,
pageUID	IN the UID of the replacing pageitem (on this page). if pageUID is kInvalidUID, the local override was a local deletion of the masterUID.

virtual void IMasterOverrideList::AddOverride ( IMasterOverrideList *  masterOverrides )

pure virtual

add a list of overrides

Parameters

masterOverrides

IN the UID of the master page pageitems and page UIDs being overridden,

virtual int32 IMasterOverrideList::GetNthOverrideIndex ( UID  mpUID, int32  nthOverride  ) const

pure virtual

GetNthOverrideIndex and GetOverride are separate because kInvalidUID is a valid value of GetOverride - i.e. a master page item could be locally deleted, in which case the local UID is kInvalidUID, but the index is not -1 (so we can decide to not draw the item) There could be two routines (IsOverridden(UID) & GetOverride(UID)), but that would require an extra PersistUIDList lookup when drawing a local override.

GetOverrideIndex returns the index of the local override. the value of this index is only useful in calls to GetOverride, or to compare against -1, which means it wasn't found (i.e. the item isn't overridden)

Parameters

mpUID	IN Master page UID.
nthOverride	IN One master page can be overriden more than once (was GetOverrideIndex).

Returns

the index of the nth override.

See Also

GetOverrideIndexCount

virtual UID IMasterOverrideList::GetOverride ( int32  idx )

pure virtual

return the UID of the overriding local page item at the given index. this index is returned from GetOverrideIndex.

Parameters

idx	IN index of overridden page item in this list

Returns

UID of the overridden page item on this page

virtual int32 IMasterOverrideList::GetOverrideIndexCount ( UID  mpUID ) const

pure virtual

GetOverrideIndexCount returns the number of overrides for a master page item.

Parameters

mpUID

IN Master page UID.

Returns

the index of the nth override.

See Also

GetNthOverrideIndex

virtual void IMasterOverrideList::GetOverridePair ( int32  index, UID *  mpUID, UID *  pgUID  )

pure virtual

index through all overrides in a given list

Parameters

index	IN index of override
mpUID	OUT master page page item UID, overridden on this page
pgUID	OUT page item UID on this page (kInvalidUID, if deleted)

virtual bool16 IMasterOverrideList::HasOverrides ( UID  mpUID ) const

pure virtual

HasOverrides returns whether a master page item has any overrides.

Parameters

mpUID

IN Master page UID.

Returns

kTrue if a master page item has any overrides.

virtual int32 IMasterOverrideList::OverrideCount ( )

pure virtual

Returns

count of how many master page items are overridden on this page

virtual void IMasterOverrideList::RemoveAllOverrides ( )

pure virtual

remove all overrides on this page

virtual void IMasterOverrideList::RemoveOverride ( UID  masterUID )

pure virtual

remove a single previous override.

Parameters

masterUID

IN master item to remove from this list