IAttributePrePost.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael_Martz
// 
// $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.
// 
// 
// Note: This interface is optional on graphic and text attributes. If it is present, 
// the apply attribute commands will call PreXxxxApply() before the attribute is 
// applied and PostXxxxApply() afterwards.
// For graphic attributes the IClassIDListData* is used to notify the graphic
// state of the attributes that were changed within the Pre and Post member 
// functions. It is a list of ClassIDs. If the implementation needs to process a
// command to alter the page item, it should turn off that command's DoNotify()
// and instead append its classID list to the passed in IClassIDListData*, using
// TransferAttributesModified().
// 
//========================================================================================

#ifndef _IAttributePrePost_
#define _IAttributePrePost_
//========================================================================================
//________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________
 #include "IPMUnknown.h"
 #include "GraphicStylesID.h"
 #include "UIDList.h"
 #include "K2Vector.h"
//========================================================================================
//________________________________________________________________________________________
// CLASS FORWARDS
//________________________________________________________________________________________
 class IClassIDListData;
 class IDataBase;
 class IFocusCache;
 class ITextModel;
//________________________________________________________________________________________
// CLASS DECLARATIONS
//________________________________________________________________________________________

class IAttributePrePost : public IPMUnknown
 {
 //____________________________________________________________________________________
 // Data Types
 //____________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_IATTRIBUTE_PREPOST_ACTION };
 
 enum ActionType
 {
 kAction_Nothing = 0,
 kAction_NothingLocalMetaData,
 kAction_AddOverride,
 kAction_RemoveOverride,
 kAction_ChangeOverride
 };
 //____________________________________________________________________________________
 // Member Functions
 //____________________________________________________________________________________
 public:
 virtual void PreGraphicApply (K2Vector<IPMUnknown*>* newAttributeList, 
 K2Vector<ActionType>* actionList, 
 UIDList* pageItemList, 
 IClassIDListData* modifiedAttrClassList, 
 K2Vector<IPMUnknown*>* origAttributeList) = 0;
 
 virtual UIDList*PostGraphicApply (K2Vector<IPMUnknown*>* newAttributeList, 
 K2Vector<ActionType>* actionList, 
 UIDList* pageItemList, 
 IClassIDListData* modifiedAttrClassList, 
 K2Vector<IPMUnknown*>* origAttributeList) = 0;

 virtual void PreTextApply (ITextModel *model, TextIndex start, int32 len, IFocusCache *listOfAll) const = 0;
 virtual void PostTextApply (ITextModel *model, TextIndex start, int32 len, IFocusCache *listOfAll) const = 0;
 };
 
 DECLARE_BASE_TYPE(IAttributePrePost::ActionType);
 
#endif // _IAttributePrePost_