IPageItemAdornmentList.h

//========================================================================================
// 
// $File$
// 
// Owner: jargast
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IPageItemAdornmentList__
#define __IPageItemAdornmentList__

#include "IPMUnknown.h"
#include "IAdornmentShape.h"
#include "IAdornmentHandleShape.h"
#include "GenericID.h"

class IAdornmentIterator: public IPMUnknown
{
public:
 enum IteratorType
 {
 kNormalIterator,
 kHandleIterator
 };

public:
 virtual void AddAdornment( IPMUnknown* pAdorn ) = 0;

 virtual IPMUnknown* GetNextAdornment() = 0;

 virtual int32 GetNumberOfAdornments() = 0;

 virtual bool32 HasAdornment(ClassID classID) = 0;
};


class IPageItemAdornmentList : public IPMUnknown
{

public:
 enum { kDefaultIID = IID_IPAGEITEMADORNMENTLIST };

 //
 // First there are the shape adornments
 //

 virtual void AddAdornment(ClassID, bool16 = kTrue) = 0;

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

 //Points somewhere on the list before the first node with these
 //AdornmentDrawOrder bits.
 //virtual void ResetIterator( IAdornmentShape::AdornmentDrawOrder ) = 0;

 // Returns the next adornment matching the flags specified in the
 // above call to ResetIterator, nil if it runs out of matches
 // deprecated, use QueryIterator.
 //virtual IAdornmentShape* QueryNextAdornment() = 0;

 virtual int32 GetNumberOfAdornments() = 0; // pass flags

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

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

 //
 // Next we have the handle adornments
 //

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

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

 //Points somewhere on the list before the first node with these
 //AdornmentDrawOrder bits.
 //virtual void ResetHandleIterator( IAdornmentHandleShape::AdornmentDrawOrder ) = 0;

 // Returns the next adornment matching the flags specified in the
 // above call to ResetIterator, nil if it runs out of matches
 //virtual IAdornmentHandleShape* QueryNextHandleAdornment() = 0;

 virtual int32 GetNumberOfHandleAdornments() = 0; // pass flags

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

 virtual IAdornmentIterator* CreateIterator( IAdornmentHandleShape::AdornmentDrawOrder order ) = 0;
};

#endif