IQuickComposer.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $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 __IQuickComposer__
#define __IQuickComposer__

#include "IPMUnknown.h"

#include "WritingModeUIID2.h"
#include "LineDescription.h"

class IdleTimer;

class IQuickComposer : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IQUICKCOMPOSER };
 
 virtual void Compose(const UIDRef& textModelRef, int32 startLineIndex, TextIndex textStartPosition, int32 numCharsAdded,
 bool16 clearLines, bool16 isGalleyDisplayStartPosition = kFalse, bool16 startNewStory = kFalse,
 RunDescription::RunType startRunTypeClue = RunDescription::regularText) = 0;

 virtual bool16 InitializeRange(const UIDRef &textModelRef, TextIndex textStartPosition, TextIndex textEndPosition) = 0;

 virtual void CreatePsuedoRange(const UIDRef &textModelRef, TextIndex startIndex, int32 length) = 0;

 virtual bool16 UnPsuedoLine(const UIDRef &textModelRef, int32 startLineIndex, IdleTimer* timeCheck) = 0;
 
 virtual TextIndex ComposeRange(const UIDRef &textModelRef, int32 startLineIndex, TextIndex textStartPosition, 
 TextIndex textEndPosition, int32 numCharsAdded, bool16 ownedItemDamage = kFalse) = 0;

 virtual bool16 ComposeLine(const UIDRef& textModelRef, int32 at, TextIndex textStartPosition, int32 numCharsAdded, 
 bool16 isGalleyDisplayStartPosition = kFalse, bool16 startNewStory = kFalse, bool16 ownedItemDamage = kFalse) = 0;
 
 virtual void ComposeOversetAle(const UIDRef& textModelRef, int32 startLineIndex, TextIndex textStartPosition, int32 numCharsAdded, int32 startLineNumber) = 0;
 
 virtual int32 ComposeAleLine(const UIDRef &textModelRef, int32 at, LineDescription &description, bool16 layoutLineIsHyphenated = kFalse) = 0;
 
 virtual void SetInstantDraw(bool16 instantDraw) = 0;
 
 virtual bool16 CompositionEnabled() = 0;
 
};


#endif // __IQuickComposer__