#include <IPageItemAdornmentList.h>

Inheritance diagram for IPageItemAdornmentList:

Public Types
enum	{ kDefaultIID = IID_IPAGEITEMADORNMENTLIST }

Public Member Functions
virtual void	AddAdornment (ClassID, bool16=kTrue)=0

virtual void	RemoveAdornment (ClassID, bool16=kTrue)=0

virtual int32	GetNumberOfAdornments ()=0

virtual bool	HasAdornment (ClassID, IAdornmentShape::AdornmentDrawOrder order=IAdornmentShape::kAllAdornmentFlags)=0

virtual bool	HasHandleAdornment (ClassID classID, IAdornmentHandleShape::AdornmentDrawOrder order=IAdornmentHandleShape::kAllAdornmentFlags)=0

virtual void	AddHandleAdornment (ClassID, bool16=kTrue)=0

virtual void	RemoveHandleAdornment (ClassID, bool16=kTrue)=0

virtual int32	GetNumberOfHandleAdornments ()=0

virtual IAdornmentIterator *	CreateIterator (IAdornmentShape::AdornmentDrawOrder order, bool32 addUniqueOnly=kFalse)=0

virtual IAdornmentIterator *	CreateIterator (IAdornmentHandleShape::AdornmentDrawOrder order)=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 list of all of the adornments currently applied to a given page item. This class deals with both shape adornments and handle adornments

Member Function Documentation

virtual void IPageItemAdornmentList::AddAdornment	(	ClassID	,
		bool16	= `kTrue`
	)

pure virtual

Adds the adornment. The adornment specifies its paint order bits

Parameters

ClassID	- The ClassID of the adorment being added
bool16	- kTrue will mark the document as dirty (forcing a save dialog) if the list changes

virtual void IPageItemAdornmentList::AddHandleAdornment	(	ClassID	,
		bool16	= `kTrue`
	)

pure virtual

Adds the adornment. The adornment specifies its paint order bits

Parameters

ClassID	- The ClassID of the adorment being added
bool16	- kTrue will mark the document as dirty (forcing a save dialog) if the list changes

virtual IAdornmentIterator* IPageItemAdornmentList::CreateIterator	(	IAdornmentShape::AdornmentDrawOrder	order,
		bool32	addUniqueOnly = `kFalse`
	)

pure virtual

create a new shape iterator which can be used to quick iterate through the adornments

Parameters

order	- The draw order to use when searching for adornments to add to the list
addUniqueOnly	- If true and order=all, will only add unique adornments in the case where an adornment handles multiple draw orders. Eg if an adornment handles beforeshape and aftershape, it'll be added twice to the iterator unless this parameter is true.

Returns: - An iterator that contains all shape adornments with the given draw order

virtual IAdornmentIterator* IPageItemAdornmentList::CreateIterator ( IAdornmentHandleShape::AdornmentDrawOrder order )

pure virtual

create a new handle iterator which can be used to quick iterate through the adornments

Parameters

order - The draw order to use when searching for adornments to add to the list

Returns: - An iterator that contains all handle adornments with the given draw order

virtual int32 IPageItemAdornmentList::GetNumberOfAdornments ( )

pure virtual

Returns the total number of adornments in the data structure

Returns: - The number of adornments

virtual int32 IPageItemAdornmentList::GetNumberOfHandleAdornments ( )

pure virtual

Returns the total number of adornments in the data structure

Returns: - The number of adornments

virtual bool IPageItemAdornmentList::HasAdornment	(	ClassID	,
		IAdornmentShape::AdornmentDrawOrder	order = `IAdornmentShape::kAllAdornmentFlags`
	)

pure virtual

Indicates whether this page item already contains a given adornment

Parameters

ClassID	- The adornment to check for on the page item
order	- This method will only search through adornements with a given draw order.

Returns: - true if the adornment is allready on the page item

virtual bool IPageItemAdornmentList::HasHandleAdornment	(	ClassID	classID,
		IAdornmentHandleShape::AdornmentDrawOrder	order = `IAdornmentHandleShape::kAllAdornmentFlags`
	)

pure virtual

Indicates whether this page item already contains a given handle adornment

Parameters

ClassID - The handle adornment to check for on the page item

Returns: True if the given class occurs in the list; false otherwise.

virtual void IPageItemAdornmentList::RemoveAdornment	(	ClassID	,
		bool16	= `kTrue`
	)

pure virtual

Removes the adornment with the ClassID

Parameters

ClassID	- The ClassID of the adorment being added
bool16	- kTrue will mark the document as dirty (forcing a save dialog) if the list changes

virtual void IPageItemAdornmentList::RemoveHandleAdornment	(	ClassID	,
		bool16	= `kTrue`
	)

pure virtual

Removes the adornment with the ClassID

Parameters

ClassID	- The ClassID of the adorment being added
bool16	- kTrue will mark the document as dirty (forcing a save dialog) if the list changes

Public Types

Public Member Functions

Detailed Description

Member Function Documentation