SnpRubyDataSettings Struct Reference

Public Attributes
bool16	fAttrOn
WideString	fString
bool16	fMojiRuby
IRubyStyle::RubyAlign	fAlignment
bool16	fPosition
PMReal	fXOffset
PMReal	fYOffset
UID	fFont
PMString	fFontStyle
PMReal	fRelativeSize
PMReal	fPointSize
PMReal	fXScale
PMReal	fYScale
bool16	fOTPro
bool16	fOverhangFlag
IRubyStyle::RubyOverHang	fOverhang
IRubyStyle::RubyAdjustParent	fAdjustParent
bool16	fAutoScaling
PMReal	fAutoScaleMin
bool16	fEdgeSpace
UID	fColor
PMReal	fTint
int16	fOverprint
UID	fStrokeColor
PMReal	fStrokeTint
int16	fStrokeOverprint
PMReal	fOutline
int16	fAutoTCYNumDigits
bool16	fAutoTCYIncludeRoman
bool16	fAutoTCYAutoScale

Detailed Description

Stores all Ruby related attributes in a single structure. Note that this sample only sets a few of the members, however all members are inspected. All member variables correspond to a ruby attribute.

Member Data Documentation

IRubyStyle::RubyAdjustParent SnpRubyDataSettings::fAdjustParent

Specifies how the extra ruby text will cause the base (parent) text to expand.

See Also

kTARubyAdjustParentBoss

IRubyStyle

IRubyStyle::RubyAlign SnpRubyDataSettings::fAlignment

Ruby alignment.

See Also

kTARubyAlignmentBoss

IRubyStyle

bool16 SnpRubyDataSettings::fAttrOn

Specifies whether ruby is on or off. kTrue = on; kFalse = off

See Also

kTARubyAttrBoss

PMReal SnpRubyDataSettings::fAutoScaleMin

Specifies the minimum compression factor (in %/100) if kTARubyAutoScaling is enabled.

See Also

kTARubyAutoScaleMinBoss

bool16 SnpRubyDataSettings::fAutoScaling

Specifies if the ruby text should be automatically compressed if it's longer than basetext. kTrue = Yes; kFalse = No

See Also

kTARubyAutoScalingBoss

bool16 SnpRubyDataSettings::fAutoTCYAutoScale

Specifies if the AutoTCY ruby text should be scaled to fit in 1 em width.

See Also

kTARubyAutoTCYAutoScaleBoss

bool16 SnpRubyDataSettings::fAutoTCYIncludeRoman

Specifies if the AutoTCY ruby text should include Roman characters or just numbers.

See Also

kTARubyAutoTCYIncludeRomanBoss

int16 SnpRubyDataSettings::fAutoTCYNumDigits

Specifies if the ruby text should be Auto TCY in vertical, and how many digits.

See Also

kTARubyAutoTCYNumDigitsBoss

UID SnpRubyDataSettings::fColor

Specifies the color (UID) of the ruby text.

See Also

kTARubyColorBoss

bool16 SnpRubyDataSettings::fEdgeSpace

Specifies whether to make the ruby fit in the text frame/frame grid if it is longer than base text that comes at the edge of a frame. kTrue = On; kFalse = Off

See Also

kTARubyEdgeSpaceBoss

UID SnpRubyDataSettings::fFont

Specifies the ruby font.

See Also

kTARubyFontUIDBoss

PMString SnpRubyDataSettings::fFontStyle

Specifies the ruby font style (face)

See Also

kTARubyFontStyleBoss

bool16 SnpRubyDataSettings::fMojiRuby

Specifies whether to use Moji (mono) ruby or group ruby. kTrue = mono (moji) ruby; kFalse = group ruby

See Also

kTAMojiRubyBoss

bool16 SnpRubyDataSettings::fOTPro

Specifies if you want to use OpenType Pro ruby glyphs. kTrue = Yes; kFalse = No

See Also

kTARubyOTProBoss

PMReal SnpRubyDataSettings::fOutline

Specifies the width (in points) of the ruby text stroke. Auto = -1.0; Otherwise specify the stroke width in points.

See Also

kTARubyOutlineBoss

IRubyStyle::RubyOverHang SnpRubyDataSettings::fOverhang

Specifies the ruby overhang type.

See Also

kTARubyOverhangBoss

IRubyStyle

bool16 SnpRubyDataSettings::fOverhangFlag

Specifies of ruby overhang (if ruby text is longer than base text) is on. kTrue = On; kFalse = Off

See Also

kTARubyOverhangFlagBoss

int16 SnpRubyDataSettings::fOverprint

Specifies if overprint is on or off. Auto = -1; Off = 0; On = 1

See Also

kTARubyOverprintBoss

PMReal SnpRubyDataSettings::fPointSize

Specifies the point size of the ruby text, if autoscale is off.

See Also

kTARubyPointSizeBoss

bool16 SnpRubyDataSettings::fPosition

Specifies the position of the Ruby.

0 = right/top

1 = left/bottom

See Also

kTARubyPositionBoss

PMReal SnpRubyDataSettings::fRelativeSize

Specifies the relative size of the ruby (between 0.0-1.0 of base text size), if autoscale is turned on.

See Also

kTARubyRelativeSizeBoss

WideString SnpRubyDataSettings::fString

The ruby string.

See Also

kTARubyStringBoss

UID SnpRubyDataSettings::fStrokeColor

Specifies of the color (UID) of the ruby text stroke.

See Also

kTARubyStrokeColorBoss

int16 SnpRubyDataSettings::fStrokeOverprint

Specifies if the ruby text stroke overprint is on or off. Auto = -1; Off = 0; On = 1

See Also

kTARubyStrokeOverprintBoss

PMReal SnpRubyDataSettings::fStrokeTint

Specifies the tint (in %) of the ruby text stroke. Auto = -1.0; Otherwise specify (tint percent/100).

See Also

kTARubyStrokeTintBoss

PMReal SnpRubyDataSettings::fTint

Specifies the tint (in %) of the ruby text.

See Also

kTARubyTintBoss

PMReal SnpRubyDataSettings::fXOffset

Specifies the X-direction distance from the base text in points.

See Also

kTARubyXOffsetBoss

PMReal SnpRubyDataSettings::fXScale

Specifies X-direction scaling (between 0.0-1.0). Note that in a vertical text story, X increases downwards.

See Also

kTARubyXScaleBoss

PMReal SnpRubyDataSettings::fYOffset

Specifies the Y-direction distance from the base text in points.

See Also

kTARubyYOffsetBoss

PMReal SnpRubyDataSettings::fYScale

Specifies vertical scaling (between 0.0-1.0). Note that in a vertical text story, Y increases to the left.

See Also

kTARubyYScaleBoss