FontGroupIteratorCallBack Class Reference

#include <IFontMgr.h>

Inheritance diagram for FontGroupIteratorCallBack:

Public Types
enum	MissingFonts { kSkip, kBeforeFonts, kAfterFonts, kOnly }

Public Member Functions
virtual void	OnStart ()=0
virtual void	OnEnd ()=0
virtual void	OnLocaleScriptFontsStart ()=0
virtual void	OnLocaleScriptFontsEnd ()=0
virtual void	OnMMFontsStart ()=0
virtual void	OnMMFontsEnd ()=0
virtual void	OnMMAxes (IPMFont *pFont, const Fixed *sourceAxes, int32 numAxes)=0
virtual void	OnFont (IPMFont *pFont, IFontGroup *fontGroup, const PMString &displayFamilyName, const PMString &displayStyleName)=0
virtual void	OnFontGroupStart (IFontGroup *fontGroup)=0
virtual void	OnFontGroupEnd (IFontGroup *fontGroup)=0
virtual void	OnFontsAddedForLastScript ()=0
virtual bool16	RunFamilyOnly () const =0
virtual int16	GetNamesFlag () const =0
virtual bool16	RunMMFonts () const =0
virtual bool16	SkipThisFont (IPMFont *font) const =0
virtual MissingFonts	RunMissingFonts () const =0
virtual void	OnMissingFontsStart ()=0
virtual void	OnMissingFontsEnd ()=0
virtual IUsedFontList *	QueryUsedFontList ()=0
virtual void	OnMissingFont (IFontFamily *fontFamily, int32 faceIndex, const PMString &displayFamilyName, const PMString &displayStyleName)=0
virtual const UIDList *	UseFontUIDList () const =0
virtual bool16	RunDuplicateFonts () const =0

Detailed Description

Parameter for IFontMgr::IterateFontGroups()

Member Function Documentation

virtual int16 FontGroupIteratorCallBack::GetNamesFlag ( ) const

pure virtual

Determines the format of names returned in OnFont

Returns

Names flag value. See enum ITextUtils::DisplayNamesFlag.

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnEnd ( )

pure virtual

Called at the end of the iteration, last call

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnFont ( IPMFont *  pFont, IFontGroup *  fontGroup, const PMString &  displayFamilyName, const PMString &  displayStyleName  )

pure virtual

Called for each item

Parameters

pFont	font to iterate
fontGroup	font group font belongs to
displayFamilyName	name for family as it shows in font menu
displayStyleName	name for font style as it shows in font menu

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnFontGroupEnd ( IFontGroup *  fontGroup )

pure virtual

Called at the end of a font group

Parameters

fontGroup

font group we are done iterating

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnFontGroupStart ( IFontGroup *  fontGroup )

pure virtual

Called at the start of a font group

Parameters

fontGroup

font group we are starting to iterate

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnFontsAddedForLastScript ( )

pure virtual

Called on script change

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnLocaleScriptFontsEnd ( )

pure virtual

Called after the fonts that use locale writing script are being colected.

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnLocaleScriptFontsStart ( )

pure virtual

Called before the fonts that use locale writing script are being colected.

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnMissingFont ( IFontFamily *  fontFamily, int32  faceIndex, const PMString &  displayFamilyName, const PMString &  displayStyleName  )

pure virtual

Called for each missing font

Parameters

fontFamily
faceIndex
displayFamilyName
displayStyleName

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnMissingFontsEnd ( )

pure virtual

Called after missing fonts are being colected.

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnMissingFontsStart ( )

pure virtual

Called before missing fonts are being colected

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnMMAxes ( IPMFont *  pFont, const Fixed *  sourceAxes, int32  numAxes  )

pure virtual

Called for each multiple master instance

Parameters

pFont	multiple master font
sourceAxes	axes
numAxes	number of axes

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnMMFontsEnd ( )

pure virtual

Called after multiple master fonts are being collected.

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnMMFontsStart ( )

pure virtual

Called before multiple master fonts are being colected.

Implemented in SnpPerformFontGroupIterator.

virtual void FontGroupIteratorCallBack::OnStart ( )

pure virtual

Called at the start of the iteration, first call

Implemented in SnpPerformFontGroupIterator.

virtual IUsedFontList* FontGroupIteratorCallBack::QueryUsedFontList ( )

pure virtual

Called by FontGroupIterator for missing fonts, usually front doc's IUsedFontList.

Returns

IUsedFontList*

Implemented in SnpPerformFontGroupIterator.

virtual bool16 FontGroupIteratorCallBack::RunDuplicateFonts ( ) const

pure virtual

Called by FontGroupIterator. drives the iterator to allow duplicate font names.

Returns

bool16

Implemented in SnpPerformFontGroupIterator.

virtual bool16 FontGroupIteratorCallBack::RunFamilyOnly ( ) const

pure virtual

Called by FontGroupIterator; drives the iterator to skip styles

Returns

kTrue skip styles. kFalse iterate styles.

Implemented in SnpPerformFontGroupIterator.

virtual MissingFonts FontGroupIteratorCallBack::RunMissingFonts ( ) const

pure virtual

Called by FontGroupIterator. drives the iterator to flatten the menu to "Times Bold".

Returns

MissingFonts

Implemented in SnpPerformFontGroupIterator.

virtual bool16 FontGroupIteratorCallBack::RunMMFonts ( ) const

pure virtual

Called by FontGroupIterator; drives the iterator to flatten MM Fonts.

Returns

kTrue iterate MM axes. kFalse only show Regular Style for MM fonts.

Implemented in SnpPerformFontGroupIterator.

virtual bool16 FontGroupIteratorCallBack::SkipThisFont ( IPMFont *  font ) const

pure virtual

Called by FontGroupIterator; drives the iterator to skip a font entirely.

Parameters

*font

font to choose to skip

Returns

bool16 kTrue skip this font. kFalse iterate this font.

Implemented in SnpPerformFontGroupIterator.

virtual const UIDList* FontGroupIteratorCallBack::UseFontUIDList ( ) const

pure virtual

Called by FontGroupIterator. drives the iterator to use the returned UIDList instead of the FontMgr.

Returns

UIDList*

Implemented in SnpPerformFontGroupIterator.