ITextReferences Class Reference

#include <ITextReferences.h>

Inheritance diagram for ITextReferences:

Public Types
enum	{ kDefaultIID = IID_ITEXTREFERENCES }

Public Member Functions
virtual int32	CountUsedFontFamilies ()=0
virtual UID	GetUsedFontFamily (int32 n)=0
virtual int32	CountUsedFontVariants (UID family)=0
virtual const PMString *	GetUsedFontVariant (UID family, int32 n)=0
virtual int32	CountMissingFonts ()=0
virtual void	GetMissingFont (int32 n, UID *family, PMString &setMe)=0
virtual int32	CountUsedParaStyles ()=0
virtual UID	GetUsedParaStyle (int32 n)=0
virtual int32	CountUsedCharStyles ()=0
virtual UID	GetUsedCharStyle (int32 n)=0
virtual int32	CountUsedColors ()=0
virtual UID	GetUsedColor (int32 n)=0
virtual int32	CountUsedConditions ()=0
virtual UID	GetUsedCondition (int32 n)=0
virtual void	Invalidate ()=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

Used to track of usage of UIDs. Example is kTextStoryBoss.

Member Function Documentation

virtual int32 ITextReferences::CountMissingFonts ( )

pure virtual

Count used missing fonts.

Returns

int32 number of used missing fonts

virtual int32 ITextReferences::CountUsedCharStyles ( )

pure virtual

Number of used character styles

Returns

int32 count of used character styles

virtual int32 ITextReferences::CountUsedColors ( )

pure virtual

Number of used colors

Returns

int32 count of used colors

virtual int32 ITextReferences::CountUsedConditions ( )

pure virtual

Number of used conditions

Returns

int32 count of used conditions

virtual int32 ITextReferences::CountUsedFontFamilies ( )

pure virtual

Number of IFontFamily uids used. Looks for any of these font family class ids - kTextAttrFontUIDBoss, kTARubyFontUIDBoss, kTAKentenFontFamilyBoss, kBNBulletFontUIDBoss

Returns

int32 count of IFontFamily uids

virtual int32 ITextReferences::CountUsedFontVariants ( UID  family )

pure virtual

Get number of used font styles for this font family uid

Parameters

family

font family uid to get number of styles for

Returns

int32 number of used font styles for this font family uid

virtual int32 ITextReferences::CountUsedParaStyles ( )

pure virtual

Number of used paragraph styles

Returns

int32 count of used paragraph styles

virtual void ITextReferences::GetMissingFont ( int32  n, UID *  family, PMString &  setMe  )

pure virtual

Get nth used missing font UID and style name

Parameters

n	nth used missing font. must be < CountMissingFonts()
family	OUT font family UID
setMe	OUT missing font style name

virtual UID ITextReferences::GetUsedCharStyle ( int32  n )

pure virtual

Get nth used character style

Parameters

n	nth used character style. must be < CountUsedCharStyles()

Returns

UID character style UID

virtual UID ITextReferences::GetUsedColor ( int32  n )

pure virtual

Get nth used color

Parameters

n	nth used color. must be < CountUsedColors()

Returns

UID color UID

virtual UID ITextReferences::GetUsedCondition ( int32  n )

pure virtual

Get nth used condition

Parameters

n	nth used color. must be < CountUsedConditions()

Returns

UID condition UID

virtual UID ITextReferences::GetUsedFontFamily ( int32  n )

pure virtual

Get nth font family uid

Parameters

n	get nth used font family. must be < CountUsedFontFamilies()

Returns

UID IFontFamily uid.

virtual const PMString* ITextReferences::GetUsedFontVariant ( UID  family, int32  n  )

pure virtual

Get nth used font style.

Parameters

family	font family uid
n	nth style to get style name for

Returns

font style name

virtual UID ITextReferences::GetUsedParaStyle ( int32  n )

pure virtual

Get nth used paragraph style

Parameters

n	nth used paragraph style. must be < CountUsedParaStyles()

Returns

UID paragraph style UID

virtual void ITextReferences::Invalidate ( )

pure virtual

Invalidate the references. Next call to get reference will recalculate the references.