IKRAdornmentData Class Reference

#include <IKRAdornmentData.h>

Inheritance diagram for IKRAdornmentData:

Public Member Functions
virtual bool16	IsFeatureOn () const =0
virtual int32	GetLength () const =0
virtual IPMFont *	QueryFont (IDataBase *db) const =0
virtual IWaxRun *	QueryBaseTextRun () const =0
virtual void	SetBaseTextRun (IWaxRun *baseTextWaxRun)=0
virtual bool16	SplitInto (IKRAdornmentData *other, int32 offsetInRun)=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

Common interface for Kenten/Ruby IAdornmentData - they look pretty much the same once they are composed and their wax is built. This interface provides common code with a mechanism to deal with the common data elements of their specific adornment data.

Member Function Documentation

virtual int32 IKRAdornmentData::GetLength ( ) const

pure virtual

Number of characters in adorned base text run

Returns

number of characters

Implemented in IRubyAdornmentData, and IKentenAdornmentData.

virtual bool16 IKRAdornmentData::IsFeatureOn ( ) const

pure virtual

Is there kenten or ruby on this run?

Returns

true if there is kenten

Implemented in IRubyAdornmentData, and IKentenAdornmentData.

virtual IWaxRun* IKRAdornmentData::QueryBaseTextRun ( ) const

pure virtual

Some code (PDF) requires access to the waxRun and waxLine so it can, for instance, convert to

pasteboard coordinates or reference the containing parcel/frame. Since we are really associated with the baseText WaxRun/Line, that's what it'll want.

Returns

base text IWaxRun

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

pure virtual

Custom impl of QueryFont for kenten or ruby font

Parameters

database

of current pub

Returns

kenten font

Implemented in IRubyAdornmentData, and IKentenAdornmentData.

virtual void IKRAdornmentData::SetBaseTextRun ( IWaxRun *  baseTextWaxRun )

pure virtual

Attaches this adornment to a base text IWaxRun

Parameters

baseTextWaxRun

IN wax run to attach to

Implemented in IRubyAdornmentData, and IKentenAdornmentData.

virtual bool16 IKRAdornmentData::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

Implemented in IRubyAdornmentData, and IKentenAdornmentData.