IGlyphUtilsME.h

//========================================================================================
// 
// $File$
// 
// Owner: ???
// 
// $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.
// 
// 
// Usage rights licenced to Adobe Inc. 1993 - 2007.
// 
//========================================================================================

#ifndef __IGlyphUtilsME__
#define __IGlyphUtilsME__

#include "IPMUnknown.h"
#include "IPMStream.h"
#include "Utils.h"

#include "K2Vector.h"
#include "CTextEnum.h"
#include "TextID.h"
#include "ITextAttrGlyphForm.h"
#include "UnicodeClass.h"

class IPMFont;
class ISelectionManager;
class IFontInstance;
class GlyphAccessData;
class WideString;
class AttributeBossList;
class GlyphEntry;
class GlyphSet;
class RangeData;

class IGlyphUtilsME : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IGLYPHUTILSME };

 virtual void InsertTheCharacter(ISelectionManager *selMgr, IPMFont *font, LanguageID id, const GlyphEntry * baseGlyphEntry,
 const GlyphEntry * alternateGlyphEntry, bool16 selectChar = kFalse, bool16 setFont = kFalse) = 0;

 virtual int32 GetSelectionGlyphSet(IPMFont *font, IFontInstance* fontInstance, LanguageID id, const WideString& chars,
 Text::GlyphID glyph, GlyphSet *glyphSet, GlyphSet::GlyphSortOrder sortOrder = GlyphSet::kNoOrder) = 0;

 virtual int32 GetGlyphListGlyphSet(IPMFont *font, IFontInstance* fontInstance, LanguageID id, Text::GlyphID* glyphs,
 int32 numGlyphs, GlyphSet * glyphSet, GlyphSet::GlyphSortOrder sortOrder = GlyphSet::kNoOrder) = 0;

 virtual bool16 GetGlyphHasAlternate(IPMFont *font, LanguageID id, Text::GlyphID glyph, const char * tag = nil) = 0;

 virtual unsigned GetGlyphAlternateCount (IPMFont *font, LanguageID id, Text::GlyphID glyph, const char * tag = nil) = 0;

 virtual int32 GetEntireFont(IPMFont *font, LanguageID id, GlyphSet * glyphSet, GlyphSet::GlyphSortOrder sortOrder = GlyphSet::kNoOrder) = 0;

 virtual int32 GetFilteredGlyphs(IPMFont *font, LanguageID id, GlyphSet * glyphSet, GlyphFilterProcList& includeFilterProcList, GlyphFilterProcList& excludeFilterProcList, GlyphSet::GlyphSortOrder sortOrder = GlyphSet::kNoOrder ) = 0;

 virtual int32 GetOTFFeatureGlyphSet(const char * tags, int32 numTags, IPMFont * font, LanguageID id, GlyphSet * glyphSet, GlyphSet::GlyphSortOrder sortOrder = GlyphSet::kNoOrder) = 0;


 virtual bool16 GetOTFFeature(IPMFont * font, IFontInstance * fontInstance, LanguageID id, const GlyphEntry * baseGlyph, const GlyphEntry * alternate, char * tagBuffer/* 4 bytes */, int32 & choice) = 0;

 virtual int32 GetGlyphsForFeatureAccessInfo(const char * tags, int32 numTags, IPMFont * font, LanguageID id,
 GlyphSet * glyphSet) = 0;

 virtual int32 GetGlyphAccessInfo(Text::GlyphID glyphID, IPMFont * font, LanguageID id,
 GlyphAccessData * glyphAccessData) = 0;


 virtual int32 GetGlyphAllAccessInfo(Text::GlyphID glyphID, IPMFont * font, LanguageID langID, 
 K2Vector<GlyphAccessData*>& glyphAccessDataList) = 0;

 virtual bool16 TestFeatureSubstitution(IFontInstance * fontInstance, LanguageID id, const WideString& textString, char * tags, int32 * choices, int32 numFeatures, Text::GlyphID testGlyphID) = 0;

 virtual void GetOTFAttribute(char * tags, int32 choice, AttributeBossList * attrBossList, OpenTypeFeatureList& featureList, int32& form,
 IFontInstance *fontInstance, LanguageID id, const WideString& stringToApply, Text::GlyphID g) = 0;

 virtual void InsertTheCharacterAtRange(ISelectionManager *selMgr, IPMFont *font, LanguageID id, const GlyphEntry * baseGlyphEntry,
 const GlyphEntry * alternateGlyphEntry, bool16 selectChar = kFalse, bool16 setFont = kFalse, TextIndex start = kInvalidTextIndex,
 TextIndex end = kInvalidTextIndex, const RangeData* rangeToSelect = nil) = 0;
};


#endif
 // __IGlyphUtilsME__