IControlledPageItems Class Reference

#include <IControlledPageItems.h>

Inheritance diagram for IControlledPageItems:

Public Member Functions
virtual int32	ControlledCount ()=0
virtual void	AddPageItem (UID controlledPageItemUID, UID controlledPageItemsPageUID=kInvalidUID)=0
virtual void	RemovePageItem (UID piUID, UID pageUID=kInvalidUID)=0
virtual void	ReplacePageItem (UID piUID, UID pageUID, UID newPIUID, UID newPageUID)=0
virtual void	RemoveAll ()=0
virtual UID	GetControlledPageItem (int32 index, UID *pageUID=nil)=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 is a persistent interface, added into drawable page items and guides that keeps track of what page items elsewhere in the document are overridden from this page item. Used primarily to maintain connections between master page items and their overrides.

See Also

IControllingPageItem

Member Function Documentation

virtual void IControlledPageItems::AddPageItem ( UID  controlledPageItemUID, UID  controlledPageItemsPageUID = kInvalidUID  )

pure virtual

add a UID to this items list of controlled items

Parameters

controlledPageItemUID	IN item controlled by this item
controlledPageItemsPageUID	IN page which contains the controlled item

virtual int32 IControlledPageItems::ControlledCount ( )

pure virtual

Returns

count of page items overridden from this one

virtual UID IControlledPageItems::GetControlledPageItem ( int32  index, UID *  pageUID = nil  )

pure virtual

Index through all of this page items controlled items

Parameters

index	IN index of controlled page item
pageUID	OUT page which contains the 'index' controlled page item

Returns

UID of 'index' controlled page item

virtual void IControlledPageItems::RemoveAll ( )

pure virtual

clear this page items list of controlled page items

virtual void IControlledPageItems::RemovePageItem ( UID  piUID, UID  pageUID = kInvalidUID  )

pure virtual

remove a controlled item's UID from this items list.

Parameters

piUID	IN UID of page item to remove
pageUID	IN UID of page that the page item being removed was on

virtual void IControlledPageItems::ReplacePageItem ( UID  piUID, UID  pageUID, UID  newPIUID, UID  newPageUID  )

pure virtual

replace one controlled page item with another

Parameters

piUID	IN page item currently in this items list of controlled items
pageUID	IN page containing the page item being replaced
newPIUID	IN page item to replace the existing controlled item with
newPageUID	IN page containing the replacement page item