ICompositionUtils.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 __ICompositionUtils__
#define __ICompositionUtils__

#include "IPMUnknown.h"
#include "ICalculatedTextResult.h"
#include "Utils.h"
#include "CTextEnum.h"
#include "OTFeature.h"
#include "TCID.h"


class ITextModel;
class IWaxIterator;


class ICompositionUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICOMPOSITIONUTILS };

 virtual ICalculatedTextResult* NewCalculatedText(const ITextModel *model, TextIndex position, UTF32TextChar c, const IDrawingStyle *style = nil) = 0;

 virtual ICalculatedTextResult* NewCalculatedText(const UIDRef& forFrame, UTF32TextChar c, const IDrawingStyle *style, TextIndex position) = 0;

 virtual ErrorCode GetCalculatedTextString(const ITextModel *model, TextIndex position, UTF32TextChar c, const IDrawingStyle *style, WideString *calcText) = 0;

 virtual ErrorCode GetCalculatedTextString(const UIDRef& forFrame, UTF32TextChar c, const IDrawingStyle *style, WideString *calcText, TextIndex position) = 0;

 virtual ICalculatedTextResult::CalculatedStringContent ScanStringContents(const PMString &s) const = 0;

 virtual bool16 RemapCharactersIfNecessary(const IDrawingStyle *style, const PMString &original, WideString &calcString) const = 0;

 virtual ICalculatedTextResult* InitializeCalcResult(const PMString& str, const IDrawingStyle* baseDrawStyle) = 0;

 virtual PMReal CalcLeadingModelYPosAdjustment(PMReal lineHeight,
 Text::LeadingModel prevLeadingModel, PMReal prevLeading, PMReal prevLeadingModelOffset,
 Text::LeadingModel leadingModel, PMReal leading, PMReal leadingModelOffset) = 0;

 virtual void PregenerateWaxRuns(const IWaxIterator *waxIter, TextIndex startPos, TextIndex endPos) = 0;


 virtual OpenTypeFeatureList GetCalculatedOTFeaturesList(const IDrawingStyle *draw, bool japanese = false, bool vertical = false, bool isTCY = false) = 0;


};


#endif // __ICompositionUtils__