IRubyAdornmentData Class Reference

#include <IRubyAdornmentData.h>

Inheritance diagram for IRubyAdornmentData:

Public Types
enum	{ kDefaultIID = IID_IRUBYADORNMENTDATA }
enum	RubyKind { kGroup = IRubyStyle::kRubyKind_Group, kMono }
enum	RubyPosition { kTopRight = IRubyStyle::kRubyPosition_TopRight, kBottomLeft }
enum	RubyOverHang {   kOHNone = IRubyStyle::kRubyOverHang_None, kOHOneRuby, kOHHalfRuby, kOHOneChar,   kOHHalfChar, kOHNoLimit }
enum	RubyAdjustBaseText {   kABTAdjustNone = IRubyStyle::kRubyAdjustParent_None, kABTBothSide, kABTMojikumi, kABTEqualAki,   kABTJustify }
enum	RubyAlign {   kLeft = IRubyStyle::kRubyAlign_Left, kCenter, kRight, kJustify,   kJISRule, kEqualSpace, kEdgeOneRuby }
enum	RubyPlacementResult {   kNotPlaced = 0, kGreat = 0x8, kGood = 0x10, kFine = 0x18,   kOk = 0x20, kNotBad = 0x28, kKindaBad = 0x30, kBad = 0x38,   kVeryBad = 0x40, kPanic = 0x48 }

Public Member Functions
virtual void	SetRubyText (int32 length)=0
virtual void	SetRubyFont (UID font, const PMReal &size, PMString style)=0
virtual void	SetRubyPlacementResult (enum RubyPlacementResult result)=0
virtual void	SetBaseTextRun (IWaxRun *baseTextWaxRun)=0
virtual bool16	IsFeatureOn () const =0
virtual int32	GetLength () const =0
virtual enum RubyPlacementResult	GetRubyPlacementResult () 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 Ruby IAdornmentData

See Also

Adornments

Member Function Documentation

virtual int32 IRubyAdornmentData::GetLength ( ) const

pure virtual

Returns number of base text characters covered by this ruby adornment

Returns

number of base text characters

Implements IKRAdornmentData.

virtual enum RubyPlacementResult IRubyAdornmentData::GetRubyPlacementResult ( ) const

pure virtual

Get how "good" the ruby placement is

Returns

enum RubyPlacementResult

virtual bool16 IRubyAdornmentData::IsFeatureOn ( ) const

pure virtual

Returns if there is ruby on the base text to adorn

Returns

true if there is ruby

Implements IKRAdornmentData.

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

pure virtual

Custom impl of QueryFont for ruby font

Parameters

database

of current pub

Returns

ruby font

Implements IKRAdornmentData.

virtual void IRubyAdornmentData::SetBaseTextRun ( IWaxRun *  baseTextWaxRun )

pure virtual

Set base text IWaxRun this adornment is adorning

Parameters

baseTextWaxRun

IN IWaxRun corresponding to base text run ruby is adorning

Implements IKRAdornmentData.

virtual void IRubyAdornmentData::SetRubyFont ( UID  font, const PMReal &  size, PMString  style  )

pure virtual

Set font used by Ruby

Parameters

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

virtual void IRubyAdornmentData::SetRubyPlacementResult ( enum RubyPlacementResult  result )

pure virtual

Set ruby placement result. Can be used to give feedback to user similar to H&J violation hilight for ruby.

Parameters

result

IN description of how "good" the ruby layout is

virtual void IRubyAdornmentData::SetRubyText ( int32  length )

pure virtual

Set number of base text characters covered by this ruby adornment

Parameters

length

IN number of characters

virtual bool16 IRubyAdornmentData::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.