ITextModel.h

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

#include "IPMUnknown.h"
#include "PMTextUtils.h"
#include "TextID.h"
#include "WideString.h"
#include "K2SmartPtr.h"
#include "ErrorUtils.h"
#include "ITextFocusManager.h"

class ICommand;
class AttributeBossList;
class ReplaceInfo;
class VOS_SavedData;
class PasteData;
class ILanguage;
class IParcel;
class ITextStoryThread;
class ITextParcelList;
class IFrameList;

class ITextModel : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTMODEL };

 virtual UID GetFrameListUID() const = 0;

 virtual IFrameList * QueryFrameList() const = 0;

 virtual UID GetStrandFromClass(ClassID klass) const = 0;

 virtual IPMUnknown *QueryStrand(ClassID clsID, PMIID faceID) const = 0;

 virtual IPMUnknown *QueryNthStrand(int32 n, PMIID faceID) const = 0;

 virtual ErrorCode CopyRange(TextIndex start, int32 length, boost::shared_ptr<PasteData>&pasteData ) = 0;

 virtual ErrorCode CopyRange(Text::StoryRangeList* list, boost::shared_ptr<PasteData>&pasteData) = 0;

 virtual void DoForceCompositionDamage(TextIndex start, int32 len) = 0;

 virtual void DoForceContentDamage(TextIndex start, int32 len) = 0;

 //-------------------------------------------------------------------------------


 virtual int32 TotalLength() const = 0;

 virtual int32 GetPrimaryStoryThreadSpan() const = 0;

#ifdef ID_DEPRECATED
 // 11/26/07 dwaterfa: The ownership of this API, that is, who gets to
 // set it is unclear. Currently it is owned by InCopy. Our direction
 // is to remove this InCopy "special" and make them use the new change
 // counters.
 virtual bool16 HasChanged() const = 0;
#endif

 virtual uint32 GetTextChangeCount() const = 0;

 virtual uint32 GetAttrChangeCount() const = 0;

 virtual uint32 GetOtherChangeCount() const = 0;

 virtual uint32 GetChangeCount() const = 0;

 virtual void GetSurroundingParaBoundaries(int32& newstart, int32& newlen) const = 0;

 virtual bool16 FindStoryThread(UID threadDictUID, uint32 threadDictKey,
 TextIndex *pStart = nil,
 int32 *pLen = nil) const = 0;

 virtual ITextStoryThread* QueryStoryThread(TextIndex at,
 TextIndex *pStart = nil,
 int32 *pSpan = nil) const = 0;

 virtual int32 GetStoryThreadSpan(TextIndex at, TextIndex *pStart,
 int32 *pSpan = nil) const = 0;

 virtual RangeData GetStoryThreadRange(TextIndex at) const = 0;

 virtual UID GetStoryThreadStyle(TextIndex at , TextIndex * pStart = nil, TextIndex * pSpan = nil) const = 0;

 virtual ITextParcelList* QueryTextParcelList(TextIndex at) const = 0;

#ifdef DEBUG
 //-------------------------------------------------------------------------------

 virtual void LockModel( bool16 bLock ) = 0;
 virtual bool16 IsModelLocked() const = 0;
#endif

public:
 //-------------------------------------------------------------------------------


 virtual ErrorCode Insert(TextIndex start, const WideString* data, const ILanguage *language = nil ) = 0;

 virtual ErrorCode Delete( TextIndex start, int32 len) = 0;

 virtual ErrorCode Delete(const RangeData& range) = 0;

 virtual ErrorCode Cut(TextIndex start, int32 len, boost::shared_ptr<PasteData>& pasteData) = 0;

 virtual ErrorCode Cut(const RangeData& range, boost::shared_ptr<PasteData>& pasteData) = 0;

 virtual ErrorCode Replace(TextIndex start,
 int32 len,
 const WideString *data,
 const ILanguage *language = nil,
 bool16 clearNonContinuingAttrs = kTrue) = 0;

 virtual ErrorCode Paste(TextIndex start, const boost::shared_ptr<PasteData>& data) = 0;

 virtual ErrorCode ApplyStyle(TextIndex start, int32 len, UID styleref, ClassID which, bool16 destroyAll, bool16 keepOldStyleAsOverrides = kTrue) = 0;

 virtual ErrorCode ApplyOverrides(TextIndex start, int32 len, const AttributeBossList *these, ClassID which) = 0;

 virtual ErrorCode ClearOverrides(TextIndex start, int32 length, const AttributeBossList *these, ClassID which) = 0;

 virtual ErrorCode InsertStoryThread(TextIndex start,
 UID threadDictUID,
 uint32 threadDictKey,
 const WideString* data,
 const ILanguage* language=nil) = 0;

 virtual ErrorCode CreateStoryThreads(TextIndex start,
 UID threadDictUID,
 const K2Vector<uint32>& threadDictKeyList,
 const K2Vector<int32>& threadLenList) = 0;

 virtual ErrorCode JoinStoryThreads(TextIndex start, int32 len) = 0;

 virtual ErrorCode RegisterStrand(UID strand) = 0;

 virtual ErrorCode UnregisterStrand(UID strand) = 0;

 virtual ErrorCode RemoveRedundantOverrides
 (TextIndex start, int32 len) = 0;

#ifdef ID_DEPRECATED
 // 11/26/07 dwaterfa: The ownership of this API, that is, who gets to
 // set it is unclear. Currently it is owned by InCopy. Our direction
 // is to remove this InCopy "special" and make them use the new change
 // counters.
 virtual void SetChanged(bool16 changed = kTrue) = 0;
#endif

 virtual uint32 IncrementAttrChangeCount() = 0;

 virtual uint32 IncrementOtherChangeCount() = 0;

 struct SingleReplacementInfo
 {
 typedef object_type data_type;

 SingleReplacementInfo():
 fPosition(kInvalidTextIndex),
 fFoundStringLen(0),
 fReplacementStringLen(0),
 fReplacementString()
 {}

 SingleReplacementInfo(const SingleReplacementInfo& rVal):
 fPosition(rVal.fPosition),
 fFoundStringLen(rVal.fFoundStringLen),
 fReplacementStringLen(rVal.fReplacementStringLen),
 fReplacementString(rVal.fReplacementString)
 {}

 TextIndex fPosition;
 int32 fFoundStringLen;
 int32 fReplacementStringLen;
 boost::shared_ptr<WideString> fReplacementString;
 };

 typedef K2Vector<SingleReplacementInfo > ReplacementList;

 virtual ErrorCode Replace(const boost::shared_ptr<ReplacementList>& replacementList,
 const ILanguage *language,
 bool16 clearNonContinuingAttrs = kTrue) = 0;
 virtual void StartRecordingChanges_ForUndoRedo() = 0;
 virtual void EndRecordingChanges_ForUndoRedo() = 0;

};

#endif