INamedPageItemList Class Reference

#include <INamedPageItemList.h>

Inheritance diagram for INamedPageItemList:

Public Types
enum	{ kDefaultIID = IID_INAMEDPAGEITEMLIST }

Public Member Functions
virtual void	Add (const UID &pageItem)=0
virtual void	Remove (const UID &pageItem)=0
virtual bool16	ItemIsInList (const UID &pageItem) const =0
virtual bool16	AnyItemIsInList (const UIDList &pageItems) const =0
virtual bool16	AllItemsAreInList (const UIDList &pageItems) const =0
virtual K2Vector< UID >	Get () 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

Add-in interface on a document that contains annotations added to the document There are 3 implementations of this on the document, one for movies, one for sounds, and one for form fields. This is used by behavior ui to present lists of movies or form fields when adding/editing a behavior that uses these items as parameters Examples are play movie, submit form, reset form, show/hide fields. This interface provides a convenient way of getting a UID list of all the form fields or movies that currently exist in a document.

Member Function Documentation

virtual void INamedPageItemList::Add ( const UID &  pageItem )

pure virtual

Add a page item to the list. This is done automatically by a document responder, so there is no other reason why this should be called

virtual bool16 INamedPageItemList::AllItemsAreInList ( const UIDList &  pageItems ) const

pure virtual

Test a list of items for presence in the list.

Returns

kTrue if all of the items are in the named page item list

virtual bool16 INamedPageItemList::AnyItemIsInList ( const UIDList &  pageItems ) const

pure virtual

Test a list of items for presence in the list.

Returns

kTrue if any of the items are in the named page item list

virtual K2Vector<UID> INamedPageItemList::Get ( ) const

pure virtual

Get the entire list of page item UIDs

virtual bool16 INamedPageItemList::ItemIsInList ( const UID &  pageItem ) const

pure virtual

Test an item for presence in the list.

Returns

kTrue if the item is in the named page item list

virtual void INamedPageItemList::Remove ( const UID &  pageItem )

pure virtual

Remove a page item from the list. This is done automatically by a document responder, so there is no other reason why this should be called