IKentenAdornmentData Class Reference

#include <IKentenAdornmentData.h>

Inheritance diagram for IKentenAdornmentData:

Public Types
enum	{ kDefaultIID = IID_IKENTENADORNMENTDATA }
enum	KentenKind {   kNoKind = IKentenStyle::Kenten_None, kBlackSesameDot, kWhiteSesameDot, kFisheye,   kBlackCircle, kSmallBlackCircle, kBullseye, kBlackTriangle,   kWhiteTriangle, kWhiteCircle, kSmallWhiteCircle, kCustomKind }
enum	KentenAlignment { kLeft, kCenter, kRight }

Public Member Functions
virtual void	SetKentenKind (uchar val, int32 offsetInRun, int32 len)=0
virtual void	AddLength (int32 lenToAdd)=0
virtual void	SetKentenFont (UID font, const PMReal &size, PMString style)=0
virtual void	SetBaseTextRun (IWaxRun *baseTextWaxRun)=0
virtual bool16	IsFeatureOn () const =0
virtual int32	GetLength () const =0
virtual IPMFont *	QueryFont (IDataBase *db) const =0
virtual bool16	SplitInto (IKRAdornmentData *other, int32 offsetInRun)=0
Public Member Functions inherited from IKRAdornmentData
virtual IWaxRun *	QueryBaseTextRun () const =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

Adornment data interface for Kenten (dotted emphasis) IAdornmentData

See Also

Adornments

Member Function Documentation

virtual void IKentenAdornmentData::AddLength ( int32  lenToAdd )

pure virtual

Adds characters to adorned length in base text wax run

Parameters

lenToAdd

IN number of characters to add

virtual int32 IKentenAdornmentData::GetLength ( ) const

pure virtual

Number of characters in adorned base text run

Returns

number of characters

Implements IKRAdornmentData.

virtual bool16 IKentenAdornmentData::IsFeatureOn ( ) const

pure virtual

Is there kenten on this run?

Returns

true if there is kenten

Implements IKRAdornmentData.

virtual IPMFont* IKentenAdornmentData::QueryFont ( IDataBase *  db ) const

pure virtual

Custom impl of QueryFont for kenten font

Parameters

database

of current pub

Returns

kenten font

Implements IKRAdornmentData.

virtual void IKentenAdornmentData::SetBaseTextRun ( IWaxRun *  baseTextWaxRun )

pure virtual

Attaches this adornment to a base text IWaxRun

Parameters

baseTextWaxRun

IN wax run to attach to

Implements IKRAdornmentData.

virtual void IKentenAdornmentData::SetKentenFont ( UID  font, const PMReal &  size, PMString  style  )

pure virtual

Sets font of custom kenten

Parameters

font	IN UID of IPMFont
size	IN pt size of font
style	IN face of font (non-native)

virtual void IKentenAdornmentData::SetKentenKind ( uchar  val, int32  offsetInRun, int32  len  )

pure virtual

Set kind of kenten (which dot style)

Parameters

val	IN from enum KentenKind
offsetInRun	IN offset in characters into the base text wax run
len	IN number of characters to adorn

virtual bool16 IKentenAdornmentData::SplitInto ( IKRAdornmentData *  other, int32  offsetInRun  )

pure virtual

Splits adornment into two at offset

Parameters

other	OUT ptr to split off adornment
offsetInRun	IN offset into base text run to split at

Returns

true if split occurred

Implements IKRAdornmentData.