IControlledPageItems.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $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.
// 
// 
// An interface for a pageitem which keeps a list of dependent page items (i.e.
// ones that refer back to this item for something). 
// 
//========================================================================================

#ifndef __IControlledPageItems__
#define __IControlledPageItems__

#include "IPMUnknown.h"
#include "MasterPageID.h"

class IControlledPageItems : public IPMUnknown
{
public: 
 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;
};

#endif