SnpPerformFontGroupIterator Class Reference

Inheritance diagram for SnpPerformFontGroupIterator:

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

Additional Inherited Members
Public Types inherited from FontGroupIteratorCallBack
enum	MissingFonts { kSkip, kBeforeFonts, kAfterFonts, kOnly }

Detailed Description

Sample code snippet that shows how to implement a FontGroupIteratorCallBack (see IFontMgr.h) to iterate all fonts.

Constructor & Destructor Documentation

SnpPerformFontGroupIterator::SnpPerformFontGroupIterator	(	bool16	nativeNames = kFalse,
		bool16	verbose = kFalse
	)

Constructor.

Parameters

nativeNames	kTrue if native names to be reported, kFalse otherwise.
verbose	kTrue if every callback is to be logged, kFalse otherwise.

Member Function Documentation

int16 SnpPerformFontGroupIterator::GetNamesFlag ( ) const

virtual

Determines the format of names returned in OnFont

Returns

Names flag value. See enum ITextUtils::DisplayNamesFlag.

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnEnd ( )

virtual

Called at the end of the iteration, last call

Implements FontGroupIteratorCallBack.

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

virtual

Called for each item

Parameters

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

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnFontGroupEnd ( IFontGroup *  fontGroup )

virtual

Called at the end of a font group

Parameters

fontGroup

font group we are done iterating

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnFontGroupStart ( IFontGroup *  fontGroup )

virtual

Called at the start of a font group

Parameters

fontGroup

font group we are starting to iterate

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnFontsAddedForLastScript ( )

virtual

Called on script change

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnLocaleScriptFontsEnd ( )

virtual

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

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnLocaleScriptFontsStart ( )

virtual

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

Implements FontGroupIteratorCallBack.

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

virtual

Called for each missing font

Parameters

fontFamily
faceIndex
displayFamilyName
displayStyleName

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnMissingFontsEnd ( )

virtual

Called after missing fonts are being collected.

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnMissingFontsStart ( )

virtual

Called before missing fonts are being collected

Implements FontGroupIteratorCallBack.

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

virtual

Called for each multiple master instance

Parameters

pFont	multiple master font
sourceAxes	axes
numAxes	number of axes

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnMMFontsEnd ( )

virtual

Called after multiple master fonts are being collected.

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnMMFontsStart ( )

virtual

Called before multiple master fonts are being collected.

Implements FontGroupIteratorCallBack.

void SnpPerformFontGroupIterator::OnStart ( )

virtual

Called at the start of the iteration, first call

Implements FontGroupIteratorCallBack.

IUsedFontList * SnpPerformFontGroupIterator::QueryUsedFontList ( )

virtual

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

Returns

IUsedFontList*

Implements FontGroupIteratorCallBack.

bool16 SnpPerformFontGroupIterator::RunDuplicateFonts ( ) const

virtual

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

Returns

bool16

Implements FontGroupIteratorCallBack.

bool16 SnpPerformFontGroupIterator::RunFamilyOnly ( ) const

virtual

Called by FontGroupIterator; drives the iterator to skip styles

Returns

kTrue skip styles. kFalse iterate styles.

Implements FontGroupIteratorCallBack.

FontGroupIteratorCallBack::MissingFonts SnpPerformFontGroupIterator::RunMissingFonts ( ) const

virtual

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

Returns

MissingFonts

Implements FontGroupIteratorCallBack.

bool16 SnpPerformFontGroupIterator::RunMMFonts ( ) const

virtual

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

Returns

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

Implements FontGroupIteratorCallBack.

bool16 SnpPerformFontGroupIterator::SkipThisFont ( IPMFont *  font ) const

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.

Implements FontGroupIteratorCallBack.

const UIDList * SnpPerformFontGroupIterator::UseFontUIDList ( ) const

virtual

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

Returns

UIDList*

Implements FontGroupIteratorCallBack.