IDocumentFieldOrder.h

//========================================================================================
// 
// $File$
// 
// Owner: Tim Wright
// 
// $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 __IDocumentFieldOrder_h__
#define __IDocumentFieldOrder_h__

#include "IPMUnknown.h"
#include "FormFieldID.h"
#include "K2Vector.h"

class IDocumentFieldOrder : public IPMUnknown
{
public:
 struct ItemInstance
 {
 UID fSpread;
 UID fPage;
 UID fPageItem;
 ItemInstance(UID inSpread, UID inPage, UID inPageItem)
 :
 fSpread(inSpread), fPage(inPage), fPageItem(inPageItem)
 {}
 };

 typedef K2Vector<ItemInstance> FieldOrder;
 typedef K2Vector<ItemInstance> CalculationOrder;

 enum { kDefaultIID = IID_IDOCUMENTFIELDORDER };

 virtual void FieldWasAddedToHierarchy(const UID& inPageItem, const UID& inSpread = kInvalidUID) = 0;


 virtual void FieldWillBeRemovedFromHierarchy(const UID& inPageItem, const UID& inSpread = kInvalidUID) = 0;

 virtual CalculationOrder GetCalculationOrder() = 0;

 virtual void SetCalculationOrder(const CalculationOrder& inPageItemList) = 0;
};

DECLARE_BASE_TYPE(IDocumentFieldOrder::ItemInstance);

#endif // __IDocumentFieldOrder_h__