DocumentFontGroupIteratorCallBack Class Reference

#include <ILocalFontManager.h>

Public Member Functions
virtual void	OnStart ()=0
virtual void	OnEnd ()=0
virtual void	OnPreiteration ()=0
virtual void	OnFontGroupStart (IFontGroup *fontGroup)=0
virtual void	OnFont (IPMFont *pFont, IFontGroup *fontGroup, PMString const &displayFamilyName, PMString const &displayStyleName)=0
virtual void	OnFontGroupEnd (IFontGroup *fontGroup)=0
virtual void	OnPostiteration ()=0
virtual bool16	RunFamilyOnly () const =0
virtual int16	GetNamesFlag () const =0
virtual bool16	SkipThisFont (IPMFont *font) const =0
virtual void	OnMMAxes (IPMFont *pFont, const Fixed *sourceAxes, int32 numAxes)=0

Detailed Description

Parameter for ILocalFontManager::IterateDocumentFontGroups()

Member Function Documentation

virtual int16 DocumentFontGroupIteratorCallBack::GetNamesFlag ( ) const

pure virtual

Determines the format of names returned in OnFont

Returns

Names Flag value. See enum ITextUtils::DisplayNamesFlag.

virtual void DocumentFontGroupIteratorCallBack::OnEnd ( )

pure virtual

Called at the end of the iteration, as the last call to this DocumentFontGroupIteratorCallBack.

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

pure virtual

Called for each font.

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.

virtual void DocumentFontGroupIteratorCallBack::OnFontGroupEnd ( IFontGroup *  fontGroup )

pure virtual

Called at the end of a font group

Parameters

fontGroup

Font group we are done iterating

virtual void DocumentFontGroupIteratorCallBack::OnFontGroupStart ( IFontGroup *  fontGroup )

pure virtual

Called at the start of a font group

Parameters

fontGroup

Font group we are starting to iterate.

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

pure virtual

Called for each font either variable or MMFont.

Parameters

pFont	Font to iterate.
sourceAxes	Design Axes of a font
numAxes	number of design axes

virtual void DocumentFontGroupIteratorCallBack::OnPostiteration ( )

pure virtual

Called after last call to OnFontGroupEnd. Only gets called if OnPreiteration got called.

virtual void DocumentFontGroupIteratorCallBack::OnPreiteration ( )

pure virtual

Called before first call to OnFontGroupStart. Only gets called if their are eligible fonts.

virtual void DocumentFontGroupIteratorCallBack::OnStart ( )

pure virtual

Called at the start of the iteration, as the first call. Will get called whether or not any eligible fonts are present.

virtual bool16 DocumentFontGroupIteratorCallBack::RunFamilyOnly ( ) const

pure virtual

Drives the iterator to skip styles and only report families.

Returns

kTrue Direct the iterator to skip styles. kFalse: Report styles.

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

pure virtual

Directs the iterator to skip a font entirely.

Parameters

*font

Font to choose to skip

Returns

bool16 kTrue directs the iterator to skip this font. kFalse: Report this font.