ITextModelCmds.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 __ITEXTMODELCMDS__
#define __ITEXTMODELCMDS__

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

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

class ITextModelCmds : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ITEXTMODELCMDS };

 virtual ICommand* PasteCmd(TextIndex position, const boost::shared_ptr<PasteData>& data, bool16 ignoreAttributes = kFalse) = 0;

 virtual ICommand* PasteCmd(const RangeData& r, const boost::shared_ptr<PasteData>& data, bool16 ignoreAttributes = kFalse) = 0;


 virtual ICommand* InsertCmd(TextIndex position, const boost::shared_ptr<WideString>& data, const ILanguage *language = nil ) = 0;

 virtual ICommand* InsertCmd(const RangeData& r, const boost::shared_ptr<WideString>& data, const ILanguage *language = nil ) = 0;
 virtual ICommand* DeleteCmd(TextIndex start, int32 length, bool16 ignoreLock=kFalse) = 0;

 virtual ICommand* DeleteCmd( const RangeData& range, bool16 ignoreLock=kFalse) = 0;

 virtual ICommand* ReplaceCmd(TextIndex start,
 int32 length,
 const boost::shared_ptr<WideString> &insert,
 const ILanguage *language = nil,
 bool16 clearNonContinuingAttrs = kTrue) = 0;

 virtual ICommand* TypeTextCmd(TextIndex startPosition, TextIndex endPosition, const boost::shared_ptr<WideString>& insert, const ILanguage *language = nil ) = 0;

 virtual ICommand* TypeTextCmd(const RangeData& range, const boost::shared_ptr<WideString>& insert, const ILanguage *language = nil ) = 0;

 virtual ICommand* ApplyCmd(TextIndex start, int32 length, const boost::shared_ptr<AttributeBossList>& list, ClassID whichStrand) = 0;

 virtual ICommand* ApplyCmd( const RangeData& range, const boost::shared_ptr<AttributeBossList>& list, ClassID whichStrand) = 0;

 virtual ICommand* ApplyStyleCmd(TextIndex start, int32 length, UID stylerefid, ClassID whichStrand, bool16 replaceOverrides = kTrue, bool16 autoNextStyle = kFalse, bool16 keepOldStyleAsOverrides = kTrue) = 0;

 virtual ICommand* UnapplyStyleCmd(TextIndex start, int32 length, ClassID whichStrand) = 0;

 virtual ICommand* ClearOverridesCmd(TextIndex start, int32 length, const boost::shared_ptr<AttributeBossList>& these, ClassID whichStrand) = 0;

 virtual ICommand* UserApplyCmd(TextIndex start, int32 length, const boost::shared_ptr<AttributeBossList>& list, ClassID whichStrand) = 0;

 virtual ICommand* RegisterStrandCmd(UID strand) = 0;

 virtual ICommand* UnregisterStrandCmd(UID strand) = 0;

 virtual ICommand* ReplaceCmd(const boost::shared_ptr<ITextModel::ReplacementList>& replacementList,
 const ILanguage *language = nil,
 bool16 clearNonContinuingAttrs = kTrue) = 0;

 virtual TextEditAction* GetApplyTextStyle_Action (TextIndex start,
 int32 len,
 UID style,
 const boost::shared_ptr<AttributeBossList>&overrides,
 ClassID which,
 bool16 destroyOverrides,
 bool16 autoNextStyle, bool16 keepOldStyleAsOverrides = kTrue) = 0;

 virtual TextEditAction* GetReplaceText_Action (TextIndex start,
 int32 oldLen,
 const boost::shared_ptr<WideString>& insertData,
 ILanguage *pLanguage,
 bool16 clearNonContinuingAttrs = kTrue) = 0;

 virtual TextEditAction* GetUserApplyAttr_Action(TextIndex start,
 int32 len,
 UID style,
 const boost::shared_ptr<AttributeBossList>& over,
 ClassID which,
 bool16 destroyLocalOverrides,
 bool16 autoNextStyle,
 bool16 keepOldStyleAsOverrides = kTrue,
 IFontLockingData::FontLockLevel fontLocking = IFontLockingData::kAllowFontLockingWithOverride) = 0;

};
#endif