#include <IPageItemBehaviorXRef.h>

Inheritance diagram for IPageItemBehaviorXRef:

Public Types
enum	{ kDefaultIID = IID_PAGEITEMBEHAVIORXREF }

Public Member Functions
virtual void	Add (const UID &pageItemUID, const UID &behaviorUID)=0

virtual void	Remove (const UID &pageItemUID, const UID &behaviorUID)=0

virtual std::vector< UID >	Get (const UID &pageItemUID) const =0

virtual std::vector< UID >	Get (const IBehaviorList *behaviorList) const =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

A mapping of behavior UIDs and the page item UIDs they reference. When a behavior is created that references page items (Examples are play movie action, reset form action, show/hide fields) is created, it adds its referenced page items to this interface, using the Add method. When the behavior is deleted, the behavior is removed from the table using the Remove method.

The purpose of this table, is to enable notification of a behavior when any of it's referenced page items are deleted. The behavior then can be modified so that it doesn't reference the deleted page items any more.

An implementation of IDeleteCleanup (kBehaviorDeleteCleanupImpl) will check this interface whenever a page item is deleted, and for each behavior that references the page item being deleted, will return commands that cleanup the behavior, obtained from the behavior's IDeleteCleanup interface.

See Also: IDeleteCleanup

Member Function Documentation

virtual void IPageItemBehaviorXRef::Add	(	const UID &	pageItemUID,
		const UID &	behaviorUID
	)

pure virtual

Add a referenced page item to a behavior. Should be done in the command that creates or edits the behavior

Parameters

pageItemUID	a referenced page item
behaviorUID	a behavior that references the page item

virtual std::vector<UID> IPageItemBehaviorXRef::Get ( const UID & pageItemUID ) const

pure virtual

Get a list of behaviors that currently reference a specified page item.

Parameters

a	pageItemUID that may be referenced by a behavior

Returns: a list of behaviors, specified by UID that reference pageItemUID

virtual std::vector<UID> IPageItemBehaviorXRef::Get ( const IBehaviorList * behaviorList ) const

pure virtual

Get a list of pageitems that are currently referenced by the list of behaviors.

Parameters

a	behaviorList that may refer pageItems

Returns: a list of pageItems, referred by behaviors passed(if any)

virtual void IPageItemBehaviorXRef::Remove	(	const UID &	pageItemUID,
		const UID &	behaviorUID
	)

pure virtual

Remove a referenced page item from a behavior. Should be done in the command that deletes or edits the behavior

Parameters

pageItemUID	a referenced page item
behaviorUID	a behavior that references the page item

Public Types

Public Member Functions

Detailed Description

Member Function Documentation