ITextScrapData.h

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

#include "IPMUnknown.h"
#include "TextID.h"
#include "ITextModel.h"
#include "K2SmartPtr.h"


//========================================================================================
// CLASS ITextScrapData
//========================================================================================

class ITextScrapData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTSCRAPDATA };

 enum { kScrapType = 'PMTX' };
 
 virtual void Initialize(const UID& story, bool16 ignoreAttributes) = 0;

 virtual void Clear() = 0;

 virtual void Set(IDataBase *sourceDB, const boost::shared_ptr<PasteData>& vasd, bool16 ignoreAttributes) = 0;
 virtual void Set(IDataBase *sourceDB, ITextModel *vasd, bool16 ignoreAttributes) = 0;

 virtual void Append(IDataBase *db, const boost::shared_ptr<PasteData>& vasd, bool16 ignoreAttributes) = 0;
 
 virtual UIDRef GetStoryRef() const = 0;
 virtual void SetStoryRef(const UIDRef& storyRef) = 0;

 virtual RangeData GetRange() const = 0;
 virtual void SetRange(const RangeData& r) = 0;

 virtual bool16 GetIgnoreAttributes() const = 0;
 virtual uint32 GetLength() const = 0;
 virtual bool16 IsEmpty() const = 0;

 virtual boost::shared_ptr<PasteData> GetDataFor(const UIDRef& intoStory) const = 0;
 virtual bool16 NeedsExternalizing() const = 0;
};

#endif