IDynamicUpdate.h

//========================================================================================
// 
// $File$
// 
// Owner: robin briggs
// 
// $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.
// 
// 
// Supplies interface for dynamic actions.
// 
//========================================================================================

#ifndef __IDynamicUpdate__
#define __IDynamicUpdate__

#include "IPMUnknown.h"
#include "CommandID.h"

//----------------------------------------------------------------------------------------
// IDynamicUpdate: Aggregated with page item modifying commands to broadcast that the page
// item(s) are being modified dynamically. Usually used within the context of a tracker
//----------------------------------------------------------------------------------------

class IDynamicUpdate : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IDYNAMICUPDATE };

 virtual void BeginDynamicUpdate() = 0;
 // Dynamic updating has begun.
 
 virtual void EndDynamicUpdate(bool16 inval = kTrue) = 0;
 // Dynamic updating is completed.
 
 virtual void AbortDynamicUpdate() = 0;
 // Abort dynamic updating.

 enum DynamicState { kNotStarted, kBeginDynamic, kEndDynamic, kAbortDynamic, kEndDynamicWithoutInval };
 virtual DynamicState GetDynamicState() const = 0;
};

#endif // __IDynamicUpdate__