IDocumentFontUsage Class Reference

#include <IDocumentFontUsage.h>

Inheritance diagram for IDocumentFontUsage:

Public Types
enum	{ kDefaultIID = IID_IDOCUMENTFONTUSAGE }

Public Member Functions
virtual int32	GetNumMissingFonts () const =0
virtual const PMString &	GetNthMissingFontString (int32 index) const =0
virtual const PMString &	GetNthMissingFontFaceString (int32 index) const =0
virtual UID	GetNthMissingFontUID (int32 index) const =0
virtual int32	GetNumUsedFonts () const =0
virtual const PMString &	GetNthUsedFontString (int32 index) const =0
virtual const PMString &	GetNthUsedFontFaceString (int32 index) const =0
virtual UID	GetNthUsedFontUID (int32 index) const =0
virtual int32	GetNthUsedFontFaceIndex (int32 index) const =0
virtual int32	GetNumGraphicFonts () const =0
virtual const PMString &	GetNthGraphicFontString (int32 index) const =0
virtual UID	GetNthGraphicFontPageItemUID (int32 index) const =0
virtual bool16	GetNthGraphicFontEmbedded (int32 index) const =0
virtual bool16	GetNthGraphicFontMissing (int32 index) const =0
virtual void	UpdateFontList ()=0
virtual int32	GetNumFontsByType (IPMFont::FontType type)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

Interface off the document that contains all the font family UIDs and font faces used in a document. First call to UpdateFontList() on the same interface to make sure the fonts are up to date. Use this interface rather than IUsedFontList is to gain access to information about fonts in graphics.

Member Function Documentation

virtual bool16 IDocumentFontUsage::GetNthGraphicFontEmbedded ( int32  index ) const

pure virtual

Get embedded state of nth graphic font.

Parameters

index

0 based index. must be less than value returned by GetNumGraphicFonts

Returns

bool16 kTrue if font is embedded

virtual bool16 IDocumentFontUsage::GetNthGraphicFontMissing ( int32  index ) const

pure virtual

Get missing state of nth graphic font.

Parameters

index

0 based index. must be less than value returned by GetNumGraphicFonts

Returns

bool16 kTrue if font is missing

virtual UID IDocumentFontUsage::GetNthGraphicFontPageItemUID ( int32  index ) const

pure virtual

Get graphic page UID of nth graphic font.

Parameters

index

0 based index. must be less than value returned by GetNumGraphicFonts

Returns

UID graphic page item UID

virtual const PMString& IDocumentFontUsage::GetNthGraphicFontString ( int32  index ) const

pure virtual

Get nth graphic font face display name.

Parameters

index

0 based index. must be less than value returned by GetNumGraphicFonts

Returns

PMString& font face display name

virtual const PMString& IDocumentFontUsage::GetNthMissingFontFaceString ( int32  index ) const

pure virtual

Get nth missing font face display name.

Parameters

index

0 based index. must be less than value returned by GetNumMissingFonts

Returns

PMString& font face display name

virtual const PMString& IDocumentFontUsage::GetNthMissingFontString ( int32  index ) const

pure virtual

Get nth missing font family display name.

Parameters

index

0 based index. must be less than value returned by GetNumMissingFonts

Returns

PMString& font family display name

virtual UID IDocumentFontUsage::GetNthMissingFontUID ( int32  index ) const

pure virtual

Get nth missing font family UID. This is an IFontFamily UID

Parameters

index

0 based index. must be less than value returned by GetNumMissingFonts

Returns

UID font family UID

virtual int32 IDocumentFontUsage::GetNthUsedFontFaceIndex ( int32  index ) const

pure virtual

Get nth font face index. This is the index used to call APIs like IFontFamily::AppendStyleName

Parameters

index

0 based index. must be less than value returned by GetNumUsedFonts.

Returns

int32 index into IFontFamily to get font. WARNING: If the font face is a document-installed font, then this result will be less than 0 and will not work in IFontFamily::AppendStyleName and similar scenarios. You must instead use PMString queries such as IFontFamily::GetFaceNativeName.

virtual const PMString& IDocumentFontUsage::GetNthUsedFontFaceString ( int32  index ) const

pure virtual

Get nth used font face display name.

Parameters

index

0 based index. must be less than value returned by GetNumUsedFonts

Returns

PMString& font face display name

virtual const PMString& IDocumentFontUsage::GetNthUsedFontString ( int32  index ) const

pure virtual

Get nth used font family display name.

Parameters

index

0 based index. must be less than value returned by GetNumUsedFonts

Returns

PMString& font family display name

virtual UID IDocumentFontUsage::GetNthUsedFontUID ( int32  index ) const

pure virtual

Get nth used font family UID. This is an IFontFamily UID

Parameters

index

0 based index. must be less than value returned by GetNumUsedFonts

Returns

UID font family UID

virtual int32 IDocumentFontUsage::GetNumFontsByType ( IPMFont::FontType  type )

pure virtual

Get number of fonts of particular type used in the document. Includes missing and graphic fonts.

Parameters

type

Font type

Returns

int32 Number of fonts of particular type used in the document

virtual int32 IDocumentFontUsage::GetNumGraphicFonts ( ) const

pure virtual

Gets number of fonts used in graphics.

Returns

int32 number of fonts used in graphics

virtual int32 IDocumentFontUsage::GetNumMissingFonts ( ) const

pure virtual

Gets number of missing fonts

Returns

int32 number of missing fonts

virtual int32 IDocumentFontUsage::GetNumUsedFonts ( ) const

pure virtual

Gets number of used fonts. Does not include missing fonts.

Returns

int32 number of used fonts

virtual void IDocumentFontUsage::UpdateFontList ( )

pure virtual

Update font list. Calling this will cause the font list to be recalculated by looking at all stories and graphics in the pub. Please use sparingly.