#include <IRubyStyle.h>

Inheritance diagram for IRubyStyle:

Public Types
enum	{ kDefaultIID = IID_IRUBYSTYLE }

enum	RubyKind { kRubyKind_Group = 0, kRubyKind_Mono }

enum	RubyPosition { kRubyPosition_TopRight = 0, kRubyPosition_BottomLeft }

enum	RubyOverHang { kRubyOverHang_None = 0, kRubyOverHang_OneRuby, kRubyOverHang_HalfRuby, kRubyOverHang_OneChar, kRubyOverHang_HalfChar, kRubyOverHang_NoLimit }

enum	RubyAdjustParent { kRubyAdjustParent_None = 0, kRubyAdjustParent_BothSide, kRubyAdjustParent_Mojikumi, kRubyAdjustParent_EqualAki, kRubyAdjustParent_Justify }

enum	RubyAlign { kRubyAlign_Left = 0, kRubyAlign_Center, kRubyAlign_Right, kRubyAlign_Justify, kRubyAlign_JISRule, kRubyAlign_EqualSpace, kRubyAlign_EdgeOneRuby }

Public Member Functions
virtual void	SetRubyFlag (bool16 flag)=0

virtual bool16	GetRubyFlag () const =0

virtual void	SetRubyString (const WideString &str)=0

virtual const WideString &	GetRubyString () const =0

virtual void	SetRubyKind (RubyKind kind)=0

virtual RubyKind	GetRubyKind () const =0

virtual void	SetRubyPosition (RubyPosition flag)=0

virtual RubyPosition	GetRubyPosition () const =0

virtual void	SetRubyContinued (bool16 flag)=0

virtual bool16	GetRubyContinued () const =0

virtual void	SetRubyOverHangFlag (bool16 flag)=0

virtual bool16	GetRubyOverHangFlag () const =0

virtual void	SetRubyOverHang (RubyOverHang hang)=0

virtual RubyOverHang	GetRubyOverHang () const =0

virtual void	SetRubyAutoScaling (bool16 flag)=0

virtual bool16	GetRubyAutoScaling () const =0

virtual void	SetRubyAutoScaleMinimum (PMReal min)=0

virtual PMReal	GetRubyAutoScaleMinimum () const =0

virtual void	SetRubyAdjustParent (RubyAdjustParent adjust)=0

virtual RubyAdjustParent	GetRubyAdjustParent () const =0

virtual void	SetRubyEdgeAdjustment (bool16 flag)=0

virtual bool16	GetRubyEdgeAdjustment () const =0

virtual void	SetRubyAlignment (RubyAlign align)=0

virtual RubyAlign	GetRubyAlignment () const =0

virtual void	SetRubyXOffset (PMReal r)=0

virtual PMReal	GetRubyXOffset () const =0

virtual void	SetRubyYOffset (PMReal r)=0

virtual PMReal	GetRubyYOffset () const =0

virtual void	SetRubyFontUID (UID u)=0

virtual UID	GetRubyFontUID () const =0

virtual void	SetRubyFontStyleName (const PMString &name)=0

virtual const PMString &	GetRubyFontStyleName () const =0

virtual void	SetRubyFontSize (PMReal p)=0

virtual PMReal	GetRubyFontSize () const =0

virtual void	SetRubyRelativeSize (PMReal p)=0

virtual PMReal	GetRubyRelativeSize () const =0

virtual void	SetRubyXScale (PMReal scale)=0

virtual PMReal	GetRubyXScale () const =0

virtual void	SetRubyYScale (PMReal scale)=0

virtual PMReal	GetRubyYScale () const =0

virtual void	SetRubyColorUID (UID u)=0

virtual UID	GetRubyColorUID () const =0

virtual UID	GetColorUID (bool16 stroke) const =0

virtual void	SetColorUID (bool16 stroke, UID newColor)=0

virtual void	SetTint (bool16 stroke, PMReal tint)=0

virtual PMReal	GetTint (bool16 stroke) const =0

virtual void	SetOverprint (bool16 stroke, bool16 over)=0

virtual bool16	GetOverprint (bool16 stroke) const =0

virtual bool16	IsOutlined () const =0

virtual void	SetOutlineWidth (PMReal width)=0

virtual PMReal	GetOutlineWidth () const =0

virtual void	SetUseOTRubyGlyphs (bool16 use)=0

virtual bool16	GetUseOTRubyGlyphs () const =0

virtual void	SetAutoTCYNumDigits (int16 num)=0

virtual int16	GetAutoTCYNumDigits () const =0

virtual void	SetAutoTCYIncludeRoman (bool16 b)=0

virtual bool16	GetAutoTCYIncludeRoman () const =0

virtual void	SetAutoTCYAutoScale (bool16 b)=0

virtual bool16	GetAutoTCYAutoScale () 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

IRubyStyle is the primary interface of character attributes for ruby summary data.

See Also: IDrawingStyle

Member Enumeration Documentation

enum IRubyStyle::RubyAdjustParent

RubyAdjustParent

enum IRubyStyle::RubyAlign

RubyAlign

enum IRubyStyle::RubyKind

RubyKind

enum IRubyStyle::RubyOverHang

RubyOverHang

enum IRubyStyle::RubyPosition

RubyPosition

Member Function Documentation

virtual bool16 IRubyStyle::GetAutoTCYAutoScale ( ) const

pure virtual

Get whether or not the TCY of ruby text will automatically be scaled.

Returns: the attribute.

virtual bool16 IRubyStyle::GetAutoTCYIncludeRoman ( ) const

pure virtual

Get whether or not the TCY of ruby text should include non-digit roman characters.

Returns: the attribute.

virtual int16 IRubyStyle::GetAutoTCYNumDigits ( ) const

pure virtual

Get the maximum number of digits at which TCY will occur.

Returns: the attribute.

virtual UID IRubyStyle::GetColorUID ( bool16 stroke ) const

pure virtual

Get the color of the ruby text for the given stroke.

Parameters

stroke if kTrue, the stroke color, else the fill color.

Returns: the attribute.

virtual PMReal IRubyStyle::GetOutlineWidth ( ) const

pure virtual

Get the outline width.

Returns: the attribute.

virtual bool16 IRubyStyle::GetOverprint ( bool16 stroke ) const

pure virtual

Get whether or not the ruby text will overprint.

Parameters

stroke if kTrue, the stroke color, else the fill color.

Returns: the attribute.

virtual RubyAdjustParent IRubyStyle::GetRubyAdjustParent ( ) const

pure virtual

Get whether Ruby will adjust spacing before/after and between parent characters and by how much.

Returns: the attribute.

virtual RubyAlign IRubyStyle::GetRubyAlignment ( ) const

pure virtual

Get the Ruby Alignment

Returns: the attribute.

virtual PMReal IRubyStyle::GetRubyAutoScaleMinimum ( ) const

pure virtual

Get the minimum amount of scaling that will occur.

Returns: the attribute.

virtual bool16 IRubyStyle::GetRubyAutoScaling ( ) const

pure virtual

Get whether Ruby text will scale or not

Returns: the attribute.

virtual UID IRubyStyle::GetRubyColorUID ( ) const

pure virtual

Get the color of the ruby text (the fill color).

Returns: the attribute.

virtual bool16 IRubyStyle::GetRubyContinued ( ) const

pure virtual

Get whether or not Ruby is continued. kTrue when style is not on the first base text character.

Returns: the attribute.

virtual bool16 IRubyStyle::GetRubyEdgeAdjustment ( ) const

pure virtual

Get whether Ruby will change the position of the base text when it's on the edge of a line or adjacent to some specific characters/attributes.

Returns: the attribute.

virtual bool16 IRubyStyle::GetRubyFlag ( ) const

pure virtual

Get whether Ruby is on/off

Returns: the attribute.

Note: : obsolete. Ruby on/off is now determined strictly by the RubyString attribute. (if the string is empty, it's off, otherwise on)

virtual PMReal IRubyStyle::GetRubyFontSize ( ) const

pure virtual

Get the size of the ruby text

Returns: the attribute.

virtual const PMString& IRubyStyle::GetRubyFontStyleName ( ) const

pure virtual

Get the Font Style name to be used for Ruby text

Returns: the attribute.

virtual UID IRubyStyle::GetRubyFontUID ( ) const

pure virtual

Get the font to be used for Ruby text.

Returns: the attribute.

virtual RubyKind IRubyStyle::GetRubyKind ( ) const

pure virtual

Get the Ruby kind

Returns: the attribute.

virtual RubyOverHang IRubyStyle::GetRubyOverHang ( ) const

pure virtual

Get whether Ruby will over hang and by how much

Returns: the attribute.

virtual bool16 IRubyStyle::GetRubyOverHangFlag ( ) const

pure virtual

Get whether Ruby will overhang or not

Returns: the attribute.

virtual RubyPosition IRubyStyle::GetRubyPosition ( ) const

pure virtual

Get the Ruby position

Returns: the attribute.

virtual PMReal IRubyStyle::GetRubyRelativeSize ( ) const

pure virtual

Get the relative size of the ruby text.

Returns: the attribute.

virtual const WideString& IRubyStyle::GetRubyString ( ) const

pure virtual

Get the Ruby string - this is the text that will appear as ruby

Returns: the attribute.

virtual PMReal IRubyStyle::GetRubyXOffset ( ) const

pure virtual

Get the offset of the ruby text in the X-direction

Returns: the attribute.

virtual PMReal IRubyStyle::GetRubyXScale ( ) const

pure virtual

Get the scaling of the ruby text in the X-direction

Returns: the attribute.

virtual PMReal IRubyStyle::GetRubyYOffset ( ) const

pure virtual

Get the offset of the ruby text in the Y-direction

Returns: the attribute.

virtual PMReal IRubyStyle::GetRubyYScale ( ) const

pure virtual

Get the scaling of the ruby text in the Y-direction

Returns: the attribute.

virtual PMReal IRubyStyle::GetTint ( bool16 stroke ) const

pure virtual

Get the tint of the ruby text.

Parameters

stroke if kTrue, the stroke color, else the fill color.

Returns: the attribute.

virtual bool16 IRubyStyle::GetUseOTRubyGlyphs ( ) const

pure virtual

Get whether or not the ruby text will use OpenType glyphs.

Returns: the attribute.

virtual bool16 IRubyStyle::IsOutlined ( ) const

pure virtual

Get whether or not the ruby text will outline.

Returns: the attribute.

virtual void IRubyStyle::SetAutoTCYAutoScale ( bool16 b )

pure virtual

Set whether or not the TCY of ruby text will automatically be scaled.

Parameters

the	attribute.

virtual void IRubyStyle::SetAutoTCYIncludeRoman ( bool16 b )

pure virtual

Set whether or not the TCY of ruby text should include non-digit roman characters.

Parameters

the	attribute.

virtual void IRubyStyle::SetAutoTCYNumDigits ( int16 num )

pure virtual

Set the maximum number of digits at which TCY will occur.

Parameters

the	attribute.

virtual void IRubyStyle::SetColorUID	(	bool16	stroke,
		UID	newColor
	)

pure virtual

Set the color of the ruby text for the given stroke.

Parameters

stroke	if kTrue, the stroke color, else the fill color.
the	attribute.

virtual void IRubyStyle::SetOutlineWidth ( PMReal width )

pure virtual

Set the outline width.

Parameters

the	attribute.

virtual void IRubyStyle::SetOverprint	(	bool16	stroke,
		bool16	over
	)

pure virtual

Set whether or not the ruby text will overprint.

Parameters

stroke	if kTrue, the stroke color, else the fill color.
the	attribute.

virtual void IRubyStyle::SetRubyAdjustParent ( RubyAdjustParent adjust )

pure virtual

Set whether Ruby will adjust spacing before/after and between parent characters and by how much.

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyAlignment ( RubyAlign align )

pure virtual

Set the Ruby Alignment

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyAutoScaleMinimum ( PMReal min )

pure virtual

Set the minimum amount of scaling that will occur.

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyAutoScaling ( bool16 flag )

pure virtual

Set whether Ruby text will scale or not

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyColorUID ( UID u )

pure virtual

Set the color of the ruby text (the fill color).

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyContinued ( bool16 flag )

pure virtual

Set whether or not Ruby is continued. kTrue when style is not on the first base text character.

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyEdgeAdjustment ( bool16 flag )

pure virtual

Set whether Ruby will change the position of the base text when it's on the edge of a line or adjacent to some specific characters/attributes.

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyFlag ( bool16 flag )

pure virtual

Set whether Ruby is on/off

Parameters

the	attribute.

Note: : obsolete. Ruby on/off is now determined strictly by the RubyString attribute. (if the string is empty, it's off, otherwise on)

virtual void IRubyStyle::SetRubyFontSize ( PMReal p )

pure virtual

Set the size of the ruby text

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyFontStyleName ( const PMString & name )

pure virtual

Set the Font Style name to be used for Ruby text

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyFontUID ( UID u )

pure virtual

Set the font to be used for Ruby text.

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyKind ( RubyKind kind )

pure virtual

Set the Ruby kind

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyOverHang ( RubyOverHang hang )

pure virtual

Set whether Ruby will over hang and by how much

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyOverHangFlag ( bool16 flag )

pure virtual

Set whether Ruby will overhang or not

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyPosition ( RubyPosition flag )

pure virtual

Set the Ruby position

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyRelativeSize ( PMReal p )

pure virtual

Set the relative size of the ruby text.

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyString ( const WideString & str )

pure virtual

Set the Ruby string - this is the text that will appear as ruby

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyXOffset ( PMReal r )

pure virtual

Set the offset of the ruby text in the X-direction

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyXScale ( PMReal scale )

pure virtual

Set the scaling of the ruby text in the X-direction

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyYOffset ( PMReal r )

pure virtual

Set the offset of the ruby text in the Y-direction

Parameters

the	attribute.

virtual void IRubyStyle::SetRubyYScale ( PMReal scale )

pure virtual

Set the scaling of the ruby text in the Y-direction

Parameters

the	attribute.

virtual void IRubyStyle::SetTint	(	bool16	stroke,
		PMReal	tint
	)

pure virtual

Set the tint of the ruby text.

Parameters

stroke	if kTrue, the stroke color, else the fill color.
the	attribute.

virtual void IRubyStyle::SetUseOTRubyGlyphs ( bool16 use )

pure virtual

Set whether or not the ruby text will use OpenType glyphs.

Parameters

the	attribute.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation