IStrand.h

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

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

class IStrandPastePiece;
class ICommand;
class ITextModelMemento;


class IStrand : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISTRAND };

 typedef K2Vector<InterfacePtr<ITextModelMemento> > MementoList;

 virtual void Insert(const WideString* data, TextIndex pos) = 0;
 virtual void Delete(TextIndex startpos, int32 numchars) = 0;
 virtual IStrandPastePiece* Cut(TextIndex startpos, int32 numchars) = 0;

 // Used to perform a set of replacements on the strand. 
 // The replacementList argument contains a list of ranges\
 // associated with replacement strings.
 // This is an optmized form for doing multiple replacements.
 // The list of ranges is passed by the text model
 // in descending order.
 virtual void Replace(const boost::shared_ptr<ITextModel::ReplacementList >& replList,
 bool16 clearNonContinuingAttrs) = 0;

 virtual void ForceCompositionDamage(TextIndex position, int32 numChars) = 0;
 virtual void ForceContentDamage(TextIndex position, int32 numChars) = 0;

 virtual int32 GetRunLength(TextIndex position, TextIndex *runBegin = nil) = 0;

 virtual IStrandPastePiece* CopyRange(TextIndex startpos, int32 numchars) = 0;
 virtual int32 Paste(TextIndex startpos, IStrandPastePiece *str) = 0;

 virtual void IncreaseSpan(TextIndex at, int32 len) = 0;

 virtual void CollectMementosForDelete(TextIndex at, int32 len,
 MementoList& list) = 0;

 virtual void CollectMementosForCut(TextIndex at, int32 len,
 MementoList& list) = 0;

 virtual void CollectMementosForCopyRange(TextIndex at, int32 len,
 MementoList& list) const = 0;

 virtual void CollectMementosForReplace(TextIndex at, int32 len,
 MementoList& list) = 0;

 virtual UID GetFirstPage() = 0;
 virtual UID SetFirstPage(UID firstPage) = 0;
 virtual UID CreatePage() = 0;
 
 virtual ClassID GetObjectClass() const = 0;

 virtual ICommand* QueryRemoveFromDocumentCmd(UID textModelUID) = 0;
 
 virtual UID GetOwningStoryUID() const = 0;
 virtual void StrandAttachedToStory(UID textModelUID, int32 length) = 0;
 virtual void StrandDetachedFromStory(UID textModelUID) = 0;


 virtual void InsertStoryThread(UID dictUID, uint32 dictKey,
 const WideString* data, TextIndex pos) = 0;

 virtual bool16 CreateStoryThreads(UID dictUID,
 const K2Vector<uint32>& dictKeyList,
 const K2Vector<int32>& lenList,
 TextIndex pos) = 0;

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

};

#endif // __ISTRAND__