IPlaceBehavior.h

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

#include "IPMUnknown.h"

#include "ICursorMgr.h"
#include "IItemsToPlaceData.h"
#include "GenericID.h"
#include "PMPoint.h"
#include "ScriptData.h"

class ISpread;
class IControlView;

class IPlaceBehavior : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IPLACEBEHAVIOR};

 //----------------------------------------------------------------------------------------------
 // Source content methods
 //----------------------------------------------------------------------------------------------

 enum eAfterPlace {
 kOldBehavior, 
 kLeaveAsIs, 
 kClearPlaceGun, 
 kAbortPlaceGun
 };

 enum ePlaceType {
 kPlaceSingle, 
 kPlaceCascade, 
 kPlaceMultiple
 };


 virtual UIDList ProcessPlace(IPlaceBehavior* targetItem, const UIDRef& parent, const PMPointList& points, 
 ICursorMgr::eCursorModifierState finalModifiers,
 ICursorMgr::eCursorModifierState startingModifiers,
 const ISpread* spread, eAfterPlace *afterPlace = nil,
 IItemsToPlaceData::ePlaceFrom placeFrom = IItemsToPlaceData::kPlaceGun) = 0;

 virtual void ProcessReplacePreserveState(IPlaceBehavior* newItem, IPlaceBehavior* target) = 0;

 virtual void AppendScriptObjects( ScriptList& objectList ) = 0 ;

 //----------------------------------------------------------------------------------------------
 // Target content methods
 //----------------------------------------------------------------------------------------------

 enum eFrameKind { 
 kTextFrameKind, 
 kGraphicFrameKind, 
 kInteractiveFrameKind, 
 kContainerFrameKind,
 kTextInsertionKind,
 kUnknownFrameKind 
 };

 virtual UID ProcessReplace(const UIDRef& placedItem, const UIDRef& oldItem, bool16 useClippingFrame, IPlaceBehavior::eAfterPlace *afterPlace= nil, IItemsToPlaceData::ePlaceFrom placeFrom = IItemsToPlaceData::kPlaceGun) = 0; 

 virtual bool16 CanPlaceInto(const IPlaceBehavior& sourceItem, const ISpread* spread) const = 0; 

 virtual bool16 CanPlaceInto(eFrameKind newPageItemKind) const = 0;

 virtual bool16 CanReplace() const = 0;

 virtual bool16 CanConvertTo(eFrameKind newPageItemKind) const = 0;

 virtual ErrorCode ProcessConvertTo(eFrameKind newPageItemKind, IControlView* controlView) = 0;

 virtual bool16 IsEmpty() const = 0;

 // Target helper methods

 virtual UID ProcessReplaceMe(const UIDRef& placedItem, const UIDRef& oldItem, bool16 usePlaceGunFrame, IPlaceBehavior::eAfterPlace *afterPlace, IItemsToPlaceData::ePlaceFrom placeFrom = IItemsToPlaceData::kPlaceGun) = 0;

 virtual UID ProcessReplaceChildren(const UIDRef& placedItem, const UIDRef& oldItem, bool16 usePlaceGunFrame, IPlaceBehavior::eAfterPlace *afterPlace) = 0;
 
 virtual eFrameKind GetFrameKind() const = 0;

 virtual bool16 IsFromMaster(const IHierarchy* targetHier, const ISpread* targetSpread) const = 0; 
};

#endif //__IPlaceBehavior__