InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ILocalFontManager Class Referenceabstract
Inheritance diagram for ILocalFontManager:
IFontMgrIPMUnknown

Public Member Functions

virtual bool IsDocumentInstalledFont (IPMFont *font) const =0
 
virtual IPMFontQueryDocumentFont (PMString const &family, PMString const &face)=0
 
virtual int32 GetNumDocumentFontGroups () const =0
 
virtual IFontGroupQueryDocumentFontGroup (int32 groupIndex)=0
 
virtual IFontGroupQueryDocumentFontGroup (PMString const &groupName)=0
 
virtual void IterateDocumentFontGroups (DocumentFontGroupIteratorCallBack *callBack)=0
 
- Public Member Functions inherited from IFontMgr
virtual int32 CurrentFontSystemSeed (bool16 fullCheck=kFalse, bool16 cooltypeSeedOnly=kFalse) const =0
 
virtual void CoolTypeShuttingDown ()=0
 
virtual const PMStringGetDefaultFontName ()=0
 
virtual void SetDefaultFontName (const PMString &s)=0
 
virtual bool16 IsFontAvailable (const PMString &fontname, int32 writingscript=kDontKnowScript)=0
 
virtual bool16 IsSuitableUIFont (IPMFont *pmFont)=0
 
virtual IPMFontQueryFont (const std::string &fontName, FontStyleBits style=kNormal, int32 writingscript=kDontKnowScript, PMReal smallcapscale=0.7, InternalFake fake=kInternalFake_Not)=0
 
virtual IPMFontQueryFont (const PMString &fontName, FontStyleBits style=kNormal, int32 writingscript=kDontKnowScript, PMReal smallcapscale=0.7, InternalFake fake=kInternalFake_Not)=0
 
virtual IPMFontQueryFont (const IFontGroup *fontGroup, int32 index, FontStyleBits style=kNormal, PMReal smallcapscale=0.7, InternalFake fake=kInternalFake_Not)=0
 
virtual IPMFontQueryFont (const CTFontDict *rawFont, InternalFake fake=kInternalFake_Not, int32 index=-1, bool16 bIsEPSFont=kFalse, bool16 bIsEmbeddedFont=kFalse, CCTEncoding *encoding=nil)=0
 
virtual IPMFontQueryFont (const CTFontDict *rawFont, Fixed *designAxes, InternalFake fake=kInternalFake_Not, bool16 bIsEPSFont=kFalse, bool16 bIsEmbeddedFont=kFalse, CCTEncoding *encoding=nil)=0
 
virtual IPMFontQueryFontPlatform (const PMString &fontName, FontStyleBits style, int32 ctScript=kDontKnowScript, OriginalOS os=kOriginalUnknownOS, FontNameInfo *outNameInfo=nil)=0
 
virtual IFontInstanceQueryFontInstance (const PMString &fontName, const PMMatrix &matrix, int32 writingscript=kDontKnowScript, WritingDirection dir=kWD_LeftToRight, FontStyleBits style=kNormal, Fixed *designV=nil, PMReal smallcapscale=0.7)=0
 
virtual IFontInstanceQueryFontInstance (const IPMFont *font, const PMMatrix &matrix, WritingDirection dir=kWD_LeftToRight)=0
 
virtual IFontGroupQueryFontGroup (const PMString &groupName)=0
 
virtual IFontGroupQueryFontGroup (int32 groupIndex)=0
 
virtual int32 GetNumFontGroups ()=0
 
virtual void IterateFontGroups (FontGroupIteratorCallBack *callBack)=0
 
virtual void ForceUpdateFontSystem ()=0
 
virtual IPMFontFindVariant (IPMFont *basefont, FontStyleBits stylebits, PMReal smallCapScale, int32 technology)=0
 
virtual void MarkBadFont (CTFontDict *badFontDict)=0
 
virtual IPMFontQueryFontFromDisplayName (const PMString &displayFamilyName, PMString &fontStyle)=0
 
virtual void AddFont (CTFontDict *dict)=0
 
virtual void DeleteFont (CTFontDict *dict)=0
 
virtual std::string GetDefaultFontPSName (int32 script=kDontKnowScript)=0
 
virtual IWRFontContext * GetWRFontContext () const =0
 
virtual void AllowPurge ()=0
 
virtual void DisallowPurge ()=0
 
virtual void AddDirectory (IDFile fontsPath)=0
 
virtual void RemoveUnusedFontsFromCache ()=0
 
virtual ActionID IterateTypeQuestFonts (const ActionID lastLocalActionID, IFontMenuData *fontMenuData)=0
 
virtual HarfbuzzCooltype * GetHarfbuzzFontAccess ()=0
 
virtual bool16 AddCustomOTVarInstance (IFontGroup *fontGroup, const Fixed *designAxis)=0
 
virtual bool16 HasExtraDefaultVariableFont (CTFontDict *dict) const =0
 
virtual void GetDefaultVariableFontName (PMString &fontName, CTFontDict *dict) const =0
 
virtual IPMFontQueryVariableFont (const IFontGroup *fontGroup, const PMString &styleName) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Additional Inherited Members

- Public Types inherited from IFontMgr
enum  { kDefaultIID = IID_IFONTMGR }
 
enum  FontStyleBits {
  kNormal = 0x00, kItalic = 0x01, kBold = 0x02, kBoldItalic = 0x03,
  kSmallCaps = 0x04, kCapStyles = 0x04
}
 
enum  WritingDirection { kWD_LeftToRight = 0, kWD_RightToLeft, kWD_TopToBottom }
 
enum  InternalFake { kInternalFake_Not = 0x0000, kInternal_Substitution = 0x0001, kInternalFake_Smallcap = 0x0004 }
 
enum  OriginalOS { kOriginalMacOS, kOriginalWinOS, kOriginalUnknownOS }
 

Member Function Documentation

virtual int32 ILocalFontManager::GetNumDocumentFontGroups () const
pure virtual

Count the number of font groups (families) installed by the document.

Returns
The count of font groups (families) installed by the document. As of this writing, there are no conditions under which this count would change over the life of the open document.
virtual bool ILocalFontManager::IsDocumentInstalledFont (IPMFontfont) const
pure virtual

Determine whether the supplied font has been installed by the document and is therefore local to the document.

Parameters
fontThe IPMFont whose status is to be queried.
virtual void ILocalFontManager::IterateDocumentFontGroups (DocumentFontGroupIteratorCallBackcallBack)
pure virtual

Iterate over the document font groups. This will return only fonts installed by the document.

Parameters
callBackThe object you construct to receive notifications from this method.
virtual IPMFont* ILocalFontManager::QueryDocumentFont (PMString const & family,
PMString const & face 
)
pure virtual

Request an IPMFont given a family and face.

Parameters
familyThe native or non-native font family name (not the display name). (This corresponds to IPMFont::AppendFamilyName or IPMFont::AppendFamilyNameNative.)
faceThe name of the font style. May be empty for a plain style. (This corresponds to IPMFont::AppendStyleName or IPMFont::AppendStyleNameNative.)
virtual IFontGroup* ILocalFontManager::QueryDocumentFontGroup (int32 groupIndex)
pure virtual

Retrieve a font group by index. The font group is only for fonts installed by the document. For fonts installed in the session and available to all documents, use the IFontMgr you acquire from the session.

Parameters
groupIndexIndex of group. Must be less than GetNumDocumentFontGroups().
Returns
IFontGroup* Font group found. Nil if out of range.
virtual IFontGroup* ILocalFontManager::QueryDocumentFontGroup (PMString const & groupName)
pure virtual

Retrieve a font group by name. The font group is only for fonts installed by the document. For fonts installed in the session and available to all documents, use the IFontMgr you acquire from the session.

Parameters
groupNameGroup name or family name, which can be either native or non-native. If more than one group with same name exists, then this returns the first one found. Calling IFontGroup->GetGroupsWithSameName will return other groups with same name.
Returns
IFontGroup* Font group found. NULL if none found.