Inheritance diagram for IRubyAttrStrand:

Public Types
enum	{ kDefaultIID = IID_IRUBYATTRSTRAND }

Public Member Functions
virtual void	SetRubyState (TextIndex startpos, int32 numchars, const AttributeBossList *over)=0

virtual bool16	GetRubyRun (TextIndex position, int32 count, TextIndex runBegin=nil)=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

Strand interface for the Japanese attribute: Ruby.

Member Function Documentation

virtual bool16 IRubyAttrStrand::GetRubyRun	(	TextIndex	position,
		int32 *	count,
		TextIndex *	runBegin = `nil`
	)

pure virtual

Return ruby range, if any, at the given position.

Parameters

position	IN Desired text index. NOP if position < 0
count	OUT if non-nil, return the distance from position to the end of the strand
runBegin	OUT if non-nil, return the text index of the beginning of the ruby

virtual void IRubyAttrStrand::SetRubyState	(	TextIndex *	startpos,
		int32 *	numchars,
		const AttributeBossList *	over
	)

pure virtual

Setup the ruby strand at the given location over the given length of text based on the attributes in the overrides list.

Parameters

startpos	IN Where in the text to start the ruby
numchars	IN How many chars to apply the state to. Method is a NOP if *numchars <= 0
over	IN The overrides to apply.