ATE::ICharFeatures Class Reference

This class encapsulates the complete set of character attributes that can be applied to text. More...

#include <IText.h>

List of all members.

Public Member Functions
	ICharFeatures ()
	Constructor.
	ICharFeatures (const ICharFeatures &src)
	Copy constructor.
ICharFeatures &	operator= (const ICharFeatures &rhs)
	Assignment operator.
bool	operator== (const ICharFeatures &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const ICharFeatures &rhs) const
	Comparison operator tests for inequality.
	ICharFeatures (CharFeaturesRef charfeatures)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~ICharFeatures ()
	Destructor.
CharFeaturesRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
ICharFeatures	Clone () const
	Creates a duplicate of this object.
IFont	GetFont (bool *isAssigned) const
	Retrieves the font attribute of this character.
ATETextDOM::Real	GetFontSize (bool *isAssigned) const
	Retrieves the font size attribute of this character.
ATETextDOM::Real	GetHorizontalScale (bool *isAssigned) const
	Retrieves the horizontal scale attribute of this character.
ATETextDOM::Real	GetVerticalScale (bool *isAssigned) const
	Retrieves the vertical scale attribute of this character.
bool	GetAutoLeading (bool *isAssigned) const
	Retrieves the automatic leading attribute of this character.
ATETextDOM::Real	GetLeading (bool *isAssigned) const
	Retrieves the leading attribute of this character.
ATETextDOM::Int32	GetTracking (bool *isAssigned) const
	Retrieves the tracking attribute of this character.
ATETextDOM::Real	GetBaselineShift (bool *isAssigned) const
	Retrieves the baseline shift attribute of this character.
ATETextDOM::Real	GetCharacterRotation (bool *isAssigned) const
	Retrieves the character rotation attribute of this character.
AutoKernType	GetAutoKernType (bool *isAssigned) const
	Retrieves the automatic kerning type attribute of this character.
FontCapsOption	GetFontCapsOption (bool *isAssigned) const
	Retrieves the font caps option attribute of this character.
FontBaselineOption	GetFontBaselineOption (bool *isAssigned) const
	Retrieves the font baseline option attribute of this character.
FontOpenTypePositionOption	GetFontOpenTypePositionOption (bool *isAssigned) const
	Retrieves the font OpenType position option attribute of this character.
StrikethroughPosition	GetStrikethroughPosition (bool *isAssigned) const
	Retrieves the strikethrough position attribute of this character.
UnderlinePosition	GetUnderlinePosition (bool *isAssigned) const
	Retrieves the underline position attribute of this character.
ATETextDOM::Real	GetUnderlineOffset (bool *isAssigned) const
	Retrieves the underline offset attribute of this character.
bool	GetLigature (bool *isAssigned) const
	Retrieves the OpenType ligature attribute of this character.
bool	GetDiscretionaryLigatures (bool *isAssigned) const
	Retrieves the OpenType discretionary ligatures attribute of this character.
bool	GetContextualLigatures (bool *isAssigned) const
	Retrieves the OpenType context ligatures attribute of this character.
bool	GetAlternateLigatures (bool *isAssigned) const
	Retrieves the OpenType alternate ligatures attribute of this character.
bool	GetOldStyle (bool *isAssigned) const
	Retrieves the OpenType old-style attribute of this character.
bool	GetFractions (bool *isAssigned) const
	Retrieves the OpenType fractions attribute of this character.
bool	GetOrdinals (bool *isAssigned) const
	Retrieves the OpenType ordinals attribute of this character.
bool	GetSwash (bool *isAssigned) const
	Retrieves the OpenType swash attribute of this character.
bool	GetTitling (bool *isAssigned) const
	Retrieves the OpenType titling attribute of this character.
bool	GetConnectionForms (bool *isAssigned) const
	Retrieves the OpenType connection forms attribute of this character.
bool	GetStylisticAlternates (bool *isAssigned) const
	Retrieves the OpenType stylistic alternates attribute of this character.
ATETextDOM::Int32	GetStylisticSets (bool *isAssigned) const
	Retrieves the OpenType stylistic sets attribute of this character.
bool	GetOrnaments (bool *isAssigned) const
	Retrieves the OpenType ornaments attribute of this character.
FigureStyle	GetFigureStyle (bool *isAssigned) const
	Retrieves the OpenType figure style attribute of this character.
bool	GetProportionalMetrics (bool *isAssigned) const
	Retrieves the Japanese OpenType proportional metrics attribute of this character.
bool	GetKana (bool *isAssigned) const
	Retrieves the Japanese OpenType Kana attribute of this character.
bool	GetRuby (bool *isAssigned) const
	Retrieves the Japanese OpenType Ruby attribute of this character.
bool	GetItalics (bool *isAssigned) const
	Retrieves the Japanese OpenType italics attribute of this character.
BaselineDirection	GetBaselineDirection (bool *isAssigned) const
	Retrieves the Japanese OpenType baseline direction attribute of this character.
Language	GetLanguage (bool *isAssigned) const
	Retrieves the Japanese OpenType language attribute of this character.
JapaneseAlternateFeature	GetJapaneseAlternateFeature (bool *isAssigned) const
	Retrieves the Japanese OpenType alternate feature attribute of this character.
ATETextDOM::Real	GetTsume (bool *isAssigned) const
	Retrieves the Japanese OpenType Tsume attribute of this character style.
StyleRunAlignment	GetStyleRunAlignment (bool *isAssigned) const
	Retrieves the Japanese OpenType style run alignment attribute of this character.
bool	GetWariChuEnabled (bool *isAssigned) const
	Retrieves the WariChu-enabled attribute of this character.
ATETextDOM::Int32	GetWariChuLineCount (bool *isAssigned) const
	Retrieves the WariChu line count attribute of this character style.
ATETextDOM::Int32	GetWariChuLineGap (bool *isAssigned) const
	Retrieves the WariChu line gap attribute of this character style.
ATETextDOM::Real	GetWariChuScale (bool *isAssigned) const
	Retrieves the WariChu scale attribute of this character style.
ATETextDOM::Real	GetWariChuSize (bool *isAssigned) const
	Retrieves the WariChu size attribute of this character style.
ATETextDOM::Int32	GetWariChuWidowAmount (bool *isAssigned) const
	Retrieves the WariChu widow amount attribute of this character style.
ATETextDOM::Int32	GetWariChuOrphanAmount (bool *isAssigned) const
	Retrieves the WariChu orphan amount attribute of this character style.
WariChuJustification	GetWariChuJustification (bool *isAssigned) const
	Retrieves the WariChu justification attribute of this character.
ATETextDOM::Int32	GetTCYUpDownAdjustment (bool *isAssigned) const
	Retrieves the Tate Chu Yoko up-down adjustment attribute of this character style.
ATETextDOM::Int32	GetTCYLeftRightAdjustment (bool *isAssigned) const
	Retrieves the Tate Chu Yoko right-left adjustment attribute of this character style.
ATETextDOM::Real	GetLeftAki (bool *isAssigned) const
	Retrieves the left Aki attribute of this character.
ATETextDOM::Real	GetRightAki (bool *isAssigned) const
	Retrieves the right Aki attribute of this character.
bool	GetNoBreak (bool *isAssigned) const
	Retrieves the no-break attribute of this character.
IApplicationPaint	GetFillColor (bool *isAssigned) const
	Retrieves the fill color attribute of this character.
IApplicationPaint	GetStrokeColor (bool *isAssigned) const
	Retrieves the stroke color attribute of this character.
bool	GetFill (bool *isAssigned) const
	Retrieves the fill attribute of this character.
bool	GetFillVisible (bool *isAssigned) const
	Retrieves the fill visibilty attribute of this character.
bool	GetStroke (bool *isAssigned) const
	Retrieves the stroke attribute of this character.
bool	GetStrokeVisible (bool *isAssigned) const
	Retrieves the stroke visibility attribute of this character.
bool	GetFillFirst (bool *isAssigned) const
	Retrieves the fill-first attribute of this character.
bool	GetFillOverPrint (bool *isAssigned) const
	Retrieves the fill overprint attribute of this character.
bool	GetStrokeOverPrint (bool *isAssigned) const
	Retrieves the stroke overprint attribute of this character.
IApplicationPaint	GetFillBackgroundColor (bool *isAssigned) const
	Retrieves the fill background color attribute of this character.
bool	GetFillBackground (bool *isAssigned) const
	Retrieves the fill background attribute of this character.
LineCapType	GetLineCap (bool *isAssigned) const
	Retrieves the line cap attribute of this character.
LineJoinType	GetLineJoin (bool *isAssigned) const
	Retrieves the line join attribute of this character.
ATETextDOM::Real	GetLineWidth (bool *isAssigned) const
	Retrieves the line width attribute of this character.
ATETextDOM::Real	GetMiterLimit (bool *isAssigned) const
	Retrieves the miter limit attribute of this character.
ATETextDOM::Real	GetLineDashOffset (bool *isAssigned) const
	Retrieves the line dash offset attribute of this character.
IArrayReal	GetLineDashArray (bool *isAssigned) const
	Retrieves the line dash array attribute of this character.
Kashidas	GetKashidas (bool *isAssigned) const
	Retrieves the kashidas attribute of this character.
DirOverride	GetDirOverride (bool *isAssigned) const
	Retrieves the direction override attribute of this character.
DigitSet	GetDigitSet (bool *isAssigned) const
	Retrieves the digit set attribute of this character.
DiacVPos	GetDiacVPos (bool *isAssigned) const
	Retrieves the diacritics positioning attribute of this character.
ATETextDOM::Real	GetDiacXOffset (bool *isAssigned) const
	Retrieves the diacritics x offset attribute of this character as a real number.
ATETextDOM::Real	GetDiacYOffset (bool *isAssigned) const
	Retrieves the diacritics y offset attribute of this character as a real number.
bool	GetAutoMydfb (bool *isAssigned) const
	Retrieves the automatic diacritics y distance from baseline attribute of this character.
ATETextDOM::Real	GetMarkYDistFromBaseline (bool *isAssigned) const
	Retrieves the diacritics y distance from baseline attribute of this character as a real number.
bool	GetOverlapSwash (bool *isAssigned) const
	Retrieves the OpenType overlap swash attribute of this character.
bool	GetJustificationAlternates (bool *isAssigned) const
	Retrieves the justification alternates attribute of this character.
bool	GetStretchedAlternates (bool *isAssigned) const
	Retrieves the stretched alternates attribute of this character.
void	SetFont (IFont newVal)
	Sets the local font attribute for this character.
void	SetFontSize (ATETextDOM::Real newVal)
	Sets the local font size attribute for this character.
void	SetHorizontalScale (ATETextDOM::Real newVal)
	Sets the local horizontal scale attribute for this character.
void	SetVerticalScale (ATETextDOM::Real newVal)
	Sets the local vertical scale attribute for this character.
void	SetAutoLeading (bool newVal)
	Sets the local automatic leading attribute for this character.
void	SetLeading (ATETextDOM::Real newVal)
	Sets the local leading attribute for this character.
void	SetTracking (ATETextDOM::Int32 newVal)
	Sets the local tracking attribute for this character.
void	SetBaselineShift (ATETextDOM::Real newVal)
	Sets the local baseline shift attribute for this character.
void	SetCharacterRotation (ATETextDOM::Real newVal)
	Sets the local character rotation attribute for this character.
void	SetAutoKernType (AutoKernType newVal)
	Sets the local automatic kerning type attribute for this character style.
void	SetFontCapsOption (FontCapsOption newVal)
	Sets the local font caps option attribute for this character style.
void	SetFontBaselineOption (FontBaselineOption newVal)
	Sets the local font baseline option attribute for this character style.
void	SetFontOpenTypePositionOption (FontOpenTypePositionOption newVal)
	Sets the local font OpenType position option attribute for this character style.
void	SetStrikethroughPosition (StrikethroughPosition newVal)
	Sets the local strikethrough position attribute for this character style.
void	SetUnderlinePosition (UnderlinePosition newVal)
	Sets the local underline position attribute for this character style.
void	SetUnderlineOffset (ATETextDOM::Real newVal)
	Sets the local underline offset attribute for this character style.
void	SetLigature (bool newVal)
	Sets the local OpenType ligature attribute for this character style.
void	SetDiscretionaryLigatures (bool newVal)
	Sets the local OpenType discretionary ligatures attribute for this character style.
void	SetContextualLigatures (bool newVal)
	Sets the local OpenType contextual ligatures attribute for this character style.
void	SetAlternateLigatures (bool newVal)
	Sets the local OpenType alternate ligatures attribute for this character style.
void	SetOldStyle (bool newVal)
	Sets the local OpenType old-style attribute for this character style.
void	SetFractions (bool newVal)
	Sets the local OpenType fractions attribute for this character style.
void	SetOrdinals (bool newVal)
	Sets the local OpenType ordinals attribute for this character style.
void	SetSwash (bool newVal)
	Sets the local OpenType swash attribute for this character style.
void	SetTitling (bool newVal)
	Sets the local OpenType titling attribute for this character style.
void	SetConnectionForms (bool newVal)
	Sets the local OpenType connection forms attribute for this character style.
void	SetStylisticAlternates (bool newVal)
	Sets the local OpenType stylistic alternates attribute for this character style.
void	SetStylisticSets (ATETextDOM::Int32 newVal)
	Sets the local OpenType stylistic sets attributes for this character style.
void	SetOrnaments (bool newVal)
	Sets the local OpenType ornaments attribute for this character style.
void	SetFigureStyle (FigureStyle newVal)
	Sets the local OpenType figure style attribute for this character style.
void	SetProportionalMetrics (bool newVal)
	Sets the local Japanese OpenType proportional metrics attribute of this character.
void	SetKana (bool newVal)
	Sets the local Japanese OpenType Kana attribute of this character.
void	SetItalics (bool newVal)
	Sets the local Japanese OpenType italics attribute of this character.
void	SetRuby (bool newVal)
	Sets the local Japanese OpenType Ruby attribute of this character.
void	SetBaselineDirection (BaselineDirection newVal)
	Sets the local Japanese OpenType baseline direction attribute of this character.
void	SetLanguage (Language newVal)
	Sets the local Japanese OpenType language attribute of this character.
void	SetJapaneseAlternateFeature (JapaneseAlternateFeature newVal)
	Sets the local Japanese OpenType Japanese alternate feature attribute of this character.
void	SetTsume (ATETextDOM::Real newVal)
	Sets the local Japanese OpenType Tsume attribute of this character.
void	SetStyleRunAlignment (StyleRunAlignment newVal)
	Sets the local Japanese OpenType style run alignment attribute of this character.
void	SetWariChuEnabled (bool newVal)
	Sets the local WariChu enabled attribute of this character.
void	SetWariChuLineCount (ATETextDOM::Int32 newVal)
	Sets the local WariChu line count attribute of this character.
void	SetWariChuLineGap (ATETextDOM::Int32 newVal)
	Sets the local WariChu line gap attribute of this character.
void	SetWariChuScale (ATETextDOM::Real newVal)
	Sets the local WariChu scale attribute of this character.
void	SetWariChuSize (ATETextDOM::Real newVal)
	Sets the local WariChu size attribute of this character.
void	SetWariChuWidowAmount (ATETextDOM::Int32 newVal)
	Sets the local WariChu widow amount attribute of this character.
void	SetWariChuOrphanAmount (ATETextDOM::Int32 newVal)
	Sets the local WariChu orphan amount attribute of this character.
void	SetWariChuJustification (WariChuJustification newVal)
	Sets the local WariChu justification attribute of this character.
void	SetTCYUpDownAdjustment (ATETextDOM::Int32 newVal)
	Sets the local Tate Chu Yoko up-down adjustment attribute of this character.
void	SetTCYLeftRightAdjustment (ATETextDOM::Int32 newVal)
	Sets the local Tate Chu Yoko right-left adjustment attribute of this character.
void	SetLeftAki (ATETextDOM::Real newVal)
	Sets the local left Aki attribute of this character.
void	SetRightAki (ATETextDOM::Real newVal)
	Sets the local right Aki attribute of this character.
void	SetNoBreak (bool newVal)
	Sets the local no-break attribute of this character.
void	SetFillColor (IApplicationPaint newVal)
	Sets the local fill color attribute of this character.
void	SetStrokeColor (IApplicationPaint newVal)
	Sets the local stroke color attribute of this character.
void	SetFill (bool newVal)
	Sets the local fill attribute of this character.
void	SetFillVisible (bool newVal)
	Sets the local fill visibilty attribute of this character.
void	SetStroke (bool newVal)
	Sets the local stroke attribute of this character.
void	SetStrokeVisible (bool newVal)
	Sets the local stroke visibility attribute of this character.
void	SetFillFirst (bool newVal)
	Sets the local fill-first attribute of this character.
void	SetFillOverPrint (bool newVal)
	Sets the local fill overprint attribute of this character.
void	SetStrokeOverPrint (bool newVal)
	Sets the local stroke overprint attribute of this character.
void	SetFillBackgroundColor (IApplicationPaint newVal)
	Sets the local fill background color attribute of this character.
void	SetFillBackground (bool newVal)
	Sets the local fill background attribute of this character.
void	SetLineCap (LineCapType newVal)
	Sets the local line cap attribute of this character.
void	SetLineJoin (LineJoinType newVal)
	Sets the local line join attribute of this character.
void	SetLineWidth (ATETextDOM::Real newVal)
	Sets the local line width attribute of this character.
void	SetMiterLimit (ATETextDOM::Real newVal)
	Sets the local miter limit attribute of this character.
void	SetLineDashOffset (ATETextDOM::Real newVal)
	Sets the local line dash offset attribute of this character.
void	SetLineDashArray (IArrayReal newVal)
	Sets the local line dash array attribute of this character.
void	SetKashidas (Kashidas newVal)
	Sets the kashidas attribute of this character.
void	SetDirOverride (DirOverride newVal)
	Sets the direction override attribute of this character.
void	SetDigitSet (DigitSet newVal)
	Sets the digit set attribute of this character.
void	SetDiacVPos (DiacVPos newVal)
	Sets the diacritics positioning attribute of this character.
void	SetDiacXOffset (ATETextDOM::Real newVal)
	Sets the diacritics x offset attribute of this character.
void	SetDiacYOffset (ATETextDOM::Real newVal)
	Sets the diacritics y offset attribute of this character.
void	SetAutoMydfb (bool newVal)
	Sets the automatic diacritics y distance from baseline attribute of this character.
void	SetMarkYDistFromBaseline (ATETextDOM::Real newVal)
	Sets the diacritics y distance from baseline attribute of this character.
void	SetOverlapSwash (bool newVal)
	Sets the overlap swash attribute of this character.
void	SetJustificationAlternates (bool newVal)
	Sets the justification alternates attribute of this character.
void	SetStretchedAlternates (bool newVal)
	Sets the stretched alternates attribute of this character.
void	ClearFont ()
	Removes the local font attribute value of this character.
void	ClearFontSize ()
	Removes the local font size attribute value of this character.
void	ClearHorizontalScale ()
	Removes the local horizontal scale attribute value of this character.
void	ClearVerticalScale ()
	Removes the local vertical scale attribute value of this character.
void	ClearAutoLeading ()
	Removes the local automatic leading attribute value of this character.
void	ClearLeading ()
	Removes the local leading attribute value of this character.
void	ClearTracking ()
	Removes the local tracking attribute value of this character.
void	ClearBaselineShift ()
	Removes the local baseline shift attribute value of this character.
void	ClearCharacterRotation ()
	Removes the local character rotation attribute value of this character.
void	ClearAutoKernType ()
	Removes the local automatic kerning attribute value of this character style.
void	ClearFontCapsOption ()
	Removes the local font caps option attribute value of this character.
void	ClearFontBaselineOption ()
	Removes the local font baseline option attribute value of this character.
void	ClearFontOpenTypePositionOption ()
	Removes the local font OpenType position option attribute value of this character.
void	ClearStrikethroughPosition ()
	Removes the local strikethrough position attribute value of this character.
void	ClearUnderlinePosition ()
	Removes the local underline position attribute value of this character.
void	ClearUnderlineOffset ()
	Removes the local underline offset attribute value of this character.
void	ClearLigature ()
	Removes the local OpenType ligature attribute value of this character.
void	ClearDiscretionaryLigatures ()
	Removes the local OpenType discretionary ligature attribute value of this character.
void	ClearContextualLigatures ()
	Removes the local OpenType contextual ligature attribute value of this character.
void	ClearAlternateLigatures ()
	Removes the local OpenType alternate ligature attribute value of this character.
void	ClearOldStyle ()
	Removes the local OpenType old-style attribute value of this character.
void	ClearFractions ()
	Removes the local OpenType fractions attribute value of this character.
void	ClearOrdinals ()
	Removes the local OpenType ordinals attribute value of this character.
void	ClearSwash ()
	Removes the local OpenType swash attribute value of this character.
void	ClearTitling ()
	Removes the local OpenType titling attribute value of this character.
void	ClearConnectionForms ()
	Removes the local OpenType connection forms attribute value of this character.
void	ClearStylisticAlternates ()
	Removes the local OpenType stylistic alternates attribute value of this character.
void	ClearStylisticSets ()
	Removes the local OpenType stylistic sets attribute value of this character.
void	ClearOrnaments ()
	Removes the local OpenType ornaments attribute value of this character.
void	ClearFigureStyle ()
	Removes the local OpenType figure style attribute value of this character.
void	ClearProportionalMetrics ()
	Removes the local Japanese OpenType proportional metrics attribute value of this character.
void	ClearKana ()
	Removes the local Japanese OpenType Kana attribute value of this character.
void	ClearItalics ()
	Removes the local Japanese OpenType italics attribute value of this character.
void	ClearRuby ()
	Removes the local Japanese OpenType Ruby attribute value of this character.
void	ClearBaselineDirection ()
	Removes the local Japanese OpenType baseline direction attribute value of this character.
void	ClearLanguage ()
	Removes the local Japanese OpenType language attribute value of this character.
void	ClearJapaneseAlternateFeature ()
	Removes the local Japanese OpenType Japanese alternate feature attribute value of this character.
void	ClearTsume ()
	Removes the local Japanese OpenType Tsume attribute value of this character.
void	ClearStyleRunAlignment ()
	Removes the local Japanese OpenType style-run alignment attribute value of this character.
void	ClearWariChuEnabled ()
	Removes the local WariChu enabled attribute value of this character.
void	ClearWariChuLineCount ()
	Removes the local WariChu line count attribute value of this character.
void	ClearWariChuLineGap ()
	Removes the local WariChu line gap attribute value of this character.
void	ClearWariChuSubLineAmount ()
	Removes the local WariChu sub-line amount attribute value of this character.
void	ClearWariChuWidowAmount ()
	Removes the local WariChu widow amount attribute value of this character.
void	ClearWariChuOrphanAmount ()
	Removes the local WariChu orphan amount attribute value of this character.
void	ClearWariChuJustification ()
	Removes the local WariChu justification attribute value of this character.
void	ClearTCYUpDownAdjustment ()
	Removes the local Tate Chu Yoko up-down adjustment attribute value of this character.
void	ClearTCYLeftRightAdjustment ()
	Removes the local Tate Chu Yoko right-left adjustment attribute value of this character.
void	ClearLeftAki ()
	Removes the local left Aki attribute value of this character.
void	ClearRightAki ()
	Removes the local right Aki attribute value of this character.
void	ClearNoBreak ()
	Removes the local no-break attribute value of this character.
void	ClearFillColor ()
	Removes the local fill color attribute value of this character.
void	ClearStrokeColor ()
	Removes the local stroke color attribute value of this character.
void	ClearFill ()
	Removes the local fill attribute value of this character.
void	ClearFillVisible ()
	Removes the local fill visibility attribute value of this character.
void	ClearStroke ()
	Removes the local stroke attribute value of this character.
void	ClearStrokeVisible ()
	Removes the local stroke visibility attribute value of this character.
void	ClearFillFirst ()
	Removes the local fill-first attribute value of this character.
void	ClearFillOverPrint ()
	Removes the local fill overprint attribute value of this character.
void	ClearStrokeOverPrint ()
	Removes the local stroke overprint attribute value of this character.
void	ClearFillBackgroundColor ()
	Removes the local fill background color attribute value of this character.
void	ClearFillBackground ()
	Removes the local fill background attribute value of this character.
void	ClearLineCap ()
	Removes the local line cap attribute value of this character.
void	ClearLineJoin ()
	Removes the local line join attribute value of this character.
void	ClearLineWidth ()
	Removes the local line width attribute value of this character.
void	ClearMiterLimit ()
	Removes the local miter limit attribute value of this character.
void	ClearLineDashOffset ()
	Removes the local line dash offset attribute value of this character.
void	ClearLineDashArray ()
	Removes the local line dash array attribute value of this character.
void	ClearKashidas ()
	Removes the kashidas attribute value of this character.
void	ClearDirOverride ()
	Removes the direction override attribute value of this character.
void	ClearDigitSet ()
	Removes the digit set attribute value of this character.
void	ClearDiacVPos ()
	Removes the diacritics positioning attribute value of this character.
void	ClearDiacXOffset ()
	Removes the diacritics x offset attribute value of this character.
void	ClearDiacYOffset ()
	Removes the diacritics y offset attribute value of this character.
void	ClearAutoMydfb ()
	Removes the automatic diacritics y distance from baseline attribute value of this character.
void	ClearMarkYDistFromBaseline ()
	Removes the diacritics y distance from baseline attribute value of this character.
void	ClearOverlapSwash ()
	Removes the overlap swash attribute value of this character.
void	ClearJustificationAlternates ()
	Removes the justification alternates attribute value of this character.
void	ClearStretchedAlternates ()
	Removes the stretched alternates attribute value of this character.
bool	IntersectFeatures (ICharFeatures rhs)
	Clears any attributes in this object whose values are not the same as or are unassigned in the comparison object.
bool	ReplaceOrAddFeatures (ICharFeatures rhs)
	Sets any attributes in this object whose values are assigned in the comparison object to those values.
bool	UnassignEachIfEqual (ICharFeatures rhs)
	Clears any attributes in this object whose values are the same as in the comparison object.
bool	IsEachNotAssigned () const
	Reports whether all attributes of this object are unassigned.
bool	IsEachAssigned () const
	Reports whether all attributes of this object are assigned.

---

Detailed Description

This class encapsulates the complete set of character attributes that can be applied to text.

An object of this type is contained in an ICharStyle object, and is returned from various methods that query character features of text runs and text ranges. A paragraph style can also have a default set of character features; see IParaFeatures::GetDefaultCharFeatures().

Attribute values are inherited from the Normal style, and can be overridden in a named style associated with the character, or at the local character level.

A style or character can partially define attributes. Only those values that are assigned override the inherited values. The constructor creates an empty object, in which all attribute values are unassigned. Setting a value causes it to be assigned, and clearing it causes it to be unassigned. When you retrieve an attribute value, a boolean return value, isAssigned, reports whether that attribute has a local value in the queried object.

See also:

ICharInspector

---

Constructor & Destructor Documentation

ATE::ICharFeatures::ICharFeatures

(

)

Constructor.

The object is empty; that is, all attribute values are unassigned.

Returns:

The new object.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

Referenced by Clone().

ATE::ICharFeatures::ICharFeatures

(

const ICharFeatures &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sCharFeatures.

ATE::ICharFeatures::ICharFeatures

(

CharFeaturesRef

charfeatures

)

[explicit]

Constructs this C++ object from the corresponding C object returned by an ATE suite function.

The C++ object manages reference counting.

Parameters:

charfeatures

The C object.

Returns:

The new C++ object.

ATE::ICharFeatures::~ICharFeatures

(

)

[virtual]

Destructor.

References ATE::sCharFeatures.

---

Member Function Documentation

void ATE::ICharFeatures::ClearAlternateLigatures

(

)

Removes the local OpenType alternate ligature attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearAutoKernType

(

)

Removes the local automatic kerning attribute value of this character style.

This is not available for individual characters.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearAutoLeading

(

)

Removes the local automatic leading attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearAutoMydfb

(

)

Removes the automatic diacritics y distance from baseline attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearBaselineDirection

(

)

Removes the local Japanese OpenType baseline direction attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearBaselineShift

(

)

Removes the local baseline shift attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearCharacterRotation

(

)

Removes the local character rotation attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearConnectionForms

(

)

Removes the local OpenType connection forms attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearContextualLigatures

(

)

Removes the local OpenType contextual ligature attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearDiacVPos

(

)

Removes the diacritics positioning attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearDiacXOffset

(

)

Removes the diacritics x offset attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearDiacYOffset

(

)

Removes the diacritics y offset attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearDigitSet

(

)

Removes the digit set attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearDirOverride

(

)

Removes the direction override attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearDiscretionaryLigatures

(

)

Removes the local OpenType discretionary ligature attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFigureStyle

(

)

Removes the local OpenType figure style attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFill

(

)

Removes the local fill attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFillBackground

(

)

Removes the local fill background attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFillBackgroundColor

(

)

Removes the local fill background color attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFillColor

(

)

Removes the local fill color attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFillFirst

(

)

Removes the local fill-first attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFillOverPrint

(

)

Removes the local fill overprint attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFillVisible

(

)

Removes the local fill visibility attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFont

(

)

Removes the local font attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFontBaselineOption

(

)

Removes the local font baseline option attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFontCapsOption

(

)

Removes the local font caps option attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFontOpenTypePositionOption

(

)

Removes the local font OpenType position option attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFontSize

(

)

Removes the local font size attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearFractions

(

)

Removes the local OpenType fractions attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearHorizontalScale

(

)

Removes the local horizontal scale attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearItalics

(

)

Removes the local Japanese OpenType italics attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearJapaneseAlternateFeature

(

)

Removes the local Japanese OpenType Japanese alternate feature attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearJustificationAlternates

(

)

Removes the justification alternates attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearKana

(

)

Removes the local Japanese OpenType Kana attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearKashidas

(

)

Removes the kashidas attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLanguage

(

)

Removes the local Japanese OpenType language attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLeading

(

)

Removes the local leading attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLeftAki

(

)

Removes the local left Aki attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLigature

(

)

Removes the local OpenType ligature attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLineCap

(

)

Removes the local line cap attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLineDashArray

(

)

Removes the local line dash array attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLineDashOffset

(

)

Removes the local line dash offset attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLineJoin

(

)

Removes the local line join attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearLineWidth

(

)

Removes the local line width attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearMarkYDistFromBaseline

(

)

Removes the diacritics y distance from baseline attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearMiterLimit

(

)

Removes the local miter limit attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearNoBreak

(

)

Removes the local no-break attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearOldStyle

(

)

Removes the local OpenType old-style attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearOrdinals

(

)

Removes the local OpenType ordinals attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearOrnaments

(

)

Removes the local OpenType ornaments attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearOverlapSwash

(

)

Removes the overlap swash attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearProportionalMetrics

(

)

Removes the local Japanese OpenType proportional metrics attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearRightAki

(

)

Removes the local right Aki attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearRuby

(

)

Removes the local Japanese OpenType Ruby attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStretchedAlternates

(

)

Removes the stretched alternates attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStrikethroughPosition

(

)

Removes the local strikethrough position attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStroke

(

)

Removes the local stroke attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStrokeColor

(

)

Removes the local stroke color attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStrokeOverPrint

(

)

Removes the local stroke overprint attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStrokeVisible

(

)

Removes the local stroke visibility attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStyleRunAlignment

(

)

Removes the local Japanese OpenType style-run alignment attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStylisticAlternates

(

)

Removes the local OpenType stylistic alternates attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearStylisticSets

(

)

Removes the local OpenType stylistic sets attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearSwash

(

)

Removes the local OpenType swash attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearTCYLeftRightAdjustment

(

)

Removes the local Tate Chu Yoko right-left adjustment attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearTCYUpDownAdjustment

(

)

Removes the local Tate Chu Yoko up-down adjustment attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearTitling

(

)

Removes the local OpenType titling attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearTracking

(

)

Removes the local tracking attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearTsume

(

)

Removes the local Japanese OpenType Tsume attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearUnderlineOffset

(

)

Removes the local underline offset attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearUnderlinePosition

(

)

Removes the local underline position attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearVerticalScale

(

)

Removes the local vertical scale attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearWariChuEnabled

(

)

Removes the local WariChu enabled attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearWariChuJustification

(

)

Removes the local WariChu justification attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearWariChuLineCount

(

)

Removes the local WariChu line count attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearWariChuLineGap

(

)

Removes the local WariChu line gap attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearWariChuOrphanAmount

(

)

Removes the local WariChu orphan amount attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearWariChuSubLineAmount

(

)

Removes the local WariChu sub-line amount attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::ClearWariChuWidowAmount

(

)

Removes the local WariChu widow amount attribute value of this character.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ICharFeatures ATE::ICharFeatures::Clone

(

)

const

Creates a duplicate of this object.

Returns:

The new object.

References ICharFeatures(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetAlternateLigatures

(

bool *

isAssigned

)

const

Retrieves the OpenType alternate ligatures attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if alternate ligatures are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

AutoKernType ATE::ICharFeatures::GetAutoKernType

(

bool *

isAssigned

)

const

Retrieves the automatic kerning type attribute of this character.

(The actual kerning value applies to character pairs rather than individual characters, so is available through the ICharStyle.)

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The automatic kerning type constant.

Note:

Use IStory::GetKern( ) to get the kerning value for a text range.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetAutoLeading

(

bool *

isAssigned

)

const

Retrieves the automatic leading attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if automatic leading is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetAutoMydfb

(

bool *

isAssigned

)

const

Retrieves the automatic diacritics y distance from baseline attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

True if automatic diacritics y distance from baseline is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

BaselineDirection ATE::ICharFeatures::GetBaselineDirection

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType baseline direction attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The baseline direction constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetBaselineShift

(

bool *

isAssigned

)

const

Retrieves the baseline shift attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The baseline shift value in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetCharacterRotation

(

bool *

isAssigned

)

const

Retrieves the character rotation attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The character rotation value in degrees.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetConnectionForms

(

bool *

isAssigned

)

const

Retrieves the OpenType connection forms attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if connection forms are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetContextualLigatures

(

bool *

isAssigned

)

const

Retrieves the OpenType context ligatures attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if context ligatures are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

DiacVPos ATE::ICharFeatures::GetDiacVPos

(

bool *

isAssigned

)

const

Retrieves the diacritics positioning attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

The diacritics positioning object.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetDiacXOffset

(

bool *

isAssigned

)

const

Retrieves the diacritics x offset attribute of this character as a real number.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

diacritics x offset as a real number.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetDiacYOffset

(

bool *

isAssigned

)

const

Retrieves the diacritics y offset attribute of this character as a real number.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

diacritics y offset as a real number.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

DigitSet ATE::ICharFeatures::GetDigitSet

(

bool *

isAssigned

)

const

Retrieves the digit set attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

The digit set object.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

DirOverride ATE::ICharFeatures::GetDirOverride

(

bool *

isAssigned

)

const

Retrieves the direction override attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

The direction override object.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetDiscretionaryLigatures

(

bool *

isAssigned

)

const

Retrieves the OpenType discretionary ligatures attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if discretionary ligatures are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

FigureStyle ATE::ICharFeatures::GetFigureStyle

(

bool *

isAssigned

)

const

Retrieves the OpenType figure style attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The figure style constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetFill

(

bool *

isAssigned

)

const

Retrieves the fill attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if fill is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetFillBackground

(

bool *

isAssigned

)

const

Retrieves the fill background attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if fill is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

IApplicationPaint ATE::ICharFeatures::GetFillBackgroundColor

(

bool *

isAssigned

)

const

Retrieves the fill background color attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The paint object containing the fill color.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

IApplicationPaint ATE::ICharFeatures::GetFillColor

(

bool *

isAssigned

)

const

Retrieves the fill color attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The paint object containing the fill color.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetFillFirst

(

bool *

isAssigned

)

const

Retrieves the fill-first attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if fill-first is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetFillOverPrint

(

bool *

isAssigned

)

const

Retrieves the fill overprint attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if fill overprint is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetFillVisible

(

bool *

isAssigned

)

const

Retrieves the fill visibilty attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if fill is visible, false if it is not.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

IFont ATE::ICharFeatures::GetFont

(

bool *

isAssigned

)

const

Retrieves the font attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The font object.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

FontBaselineOption ATE::ICharFeatures::GetFontBaselineOption

(

bool *

isAssigned

)

const

Retrieves the font baseline option attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The font baseline option constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

FontCapsOption ATE::ICharFeatures::GetFontCapsOption

(

bool *

isAssigned

)

const

Retrieves the font caps option attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The font caps option constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

FontOpenTypePositionOption ATE::ICharFeatures::GetFontOpenTypePositionOption

(

bool *

isAssigned

)

const

Retrieves the font OpenType position option attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The font OpenType position option constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetFontSize

(

bool *

isAssigned

)

const

Retrieves the font size attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The font size in dcoument points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetFractions

(

bool *

isAssigned

)

const

Retrieves the OpenType fractions attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if fractions are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetHorizontalScale

(

bool *

isAssigned

)

const

Retrieves the horizontal scale attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The scale value, where 1 is 100%

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetItalics

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType italics attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if italics is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

JapaneseAlternateFeature ATE::ICharFeatures::GetJapaneseAlternateFeature

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType alternate feature attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The Japanese alternate feature constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetJustificationAlternates

(

bool *

isAssigned

)

const

Retrieves the justification alternates attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

True if justification alternates is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetKana

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType Kana attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if Kana is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

Kashidas ATE::ICharFeatures::GetKashidas

(

bool *

isAssigned

)

const

Retrieves the kashidas attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

The kashidas object.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

Language ATE::ICharFeatures::GetLanguage

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType language attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The language constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetLeading

(

bool *

isAssigned

)

const

Retrieves the leading attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The leading value in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetLeftAki

(

bool *

isAssigned

)

const

Retrieves the left Aki attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The left Aki value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetLigature

(

bool *

isAssigned

)

const

Retrieves the OpenType ligature attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if ligature is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

LineCapType ATE::ICharFeatures::GetLineCap

(

bool *

isAssigned

)

const

Retrieves the line cap attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The line cap type constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

IArrayReal ATE::ICharFeatures::GetLineDashArray

(

bool *

isAssigned

)

const

Retrieves the line dash array attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The line dash array object.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetLineDashOffset

(

bool *

isAssigned

)

const

Retrieves the line dash offset attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The line dash offset value in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

LineJoinType ATE::ICharFeatures::GetLineJoin

(

bool *

isAssigned

)

const

Retrieves the line join attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The line join type constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetLineWidth

(

bool *

isAssigned

)

const

Retrieves the line width attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The line width value in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetMarkYDistFromBaseline

(

bool *

isAssigned

)

const

Retrieves the diacritics y distance from baseline attribute of this character as a real number.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

diacritics y distance from baseline as a real number.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetMiterLimit

(

bool *

isAssigned

)

const

Retrieves the miter limit attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The miter limit value in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetNoBreak

(

bool *

isAssigned

)

const

Retrieves the no-break attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if no-break is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetOldStyle

(

bool *

isAssigned

)

const

Retrieves the OpenType old-style attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if the character is old-style, false if it is not.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetOrdinals

(

bool *

isAssigned

)

const

Retrieves the OpenType ordinals attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if ordinals are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetOrnaments

(

bool *

isAssigned

)

const

Retrieves the OpenType ornaments attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if ornaments are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetOverlapSwash

(

bool *

isAssigned

)

const

Retrieves the OpenType overlap swash attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

True if overlap swash is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetProportionalMetrics

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType proportional metrics attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if proportional metrics are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

CharFeaturesRef ATE::ICharFeatures::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

Referenced by ATE::IDocumentTextResources::CreateCharStyleWithFeatures(), IntersectFeatures(), ATE::ICharStyle::ReplaceOrAddFeatures(), ReplaceOrAddFeatures(), ATE::ITextRanges::ReplaceOrAddLocalCharFeatures(), ATE::ITextRange::ReplaceOrAddLocalCharFeatures(), ATE::IParaFeatures::SetDefaultCharFeatures(), ATE::ICharStyle::SetFeatures(), ATE::IDocumentTextResources::SetInsertionFeaturesAndStyle(), ATE::ITextRanges::SetLocalCharFeatures(), ATE::ITextRange::SetLocalCharFeatures(), and UnassignEachIfEqual().

ATETextDOM::Real ATE::ICharFeatures::GetRightAki

(

bool *

isAssigned

)

const

Retrieves the right Aki attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The right Aki value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetRuby

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType Ruby attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if Ruby is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetStretchedAlternates

(

bool *

isAssigned

)

const

Retrieves the stretched alternates attribute of this character.

Parameters:

isAssigned

[out] a buffer in which to return true if this attribute has a local value.

Returns:

True if stretched alternates is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

StrikethroughPosition ATE::ICharFeatures::GetStrikethroughPosition

(

bool *

isAssigned

)

const

Retrieves the strikethrough position attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The strikethrough position constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetStroke

(

bool *

isAssigned

)

const

Retrieves the stroke attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if stroke is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

IApplicationPaint ATE::ICharFeatures::GetStrokeColor

(

bool *

isAssigned

)

const

Retrieves the stroke color attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The paint object containing the stroke color.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetStrokeOverPrint

(

bool *

isAssigned

)

const

Retrieves the stroke overprint attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if stroke overprint is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetStrokeVisible

(

bool *

isAssigned

)

const

Retrieves the stroke visibility attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if stroke is visible, false if it is not.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

StyleRunAlignment ATE::ICharFeatures::GetStyleRunAlignment

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType style run alignment attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The style run alignment constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetStylisticAlternates

(

bool *

isAssigned

)

const

Retrieves the OpenType stylistic alternates attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if stylistic alternates are on, false if they are off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetStylisticSets

(

bool *

isAssigned

)

const

Retrieves the OpenType stylistic sets attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetSwash

(

bool *

isAssigned

)

const

Retrieves the OpenType swash attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if swash is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetTCYLeftRightAdjustment

(

bool *

isAssigned

)

const

Retrieves the Tate Chu Yoko right-left adjustment attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The right-left adjustment value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetTCYUpDownAdjustment

(

bool *

isAssigned

)

const

Retrieves the Tate Chu Yoko up-down adjustment attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The up-down adjustment value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetTitling

(

bool *

isAssigned

)

const

Retrieves the OpenType titling attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if titling is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetTracking

(

bool *

isAssigned

)

const

Retrieves the tracking attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The tracking value in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetTsume

(

bool *

isAssigned

)

const

Retrieves the Japanese OpenType Tsume attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The Tsume value, in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetUnderlineOffset

(

bool *

isAssigned

)

const

Retrieves the underline offset attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The underline offset value, in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

UnderlinePosition ATE::ICharFeatures::GetUnderlinePosition

(

bool *

isAssigned

)

const

Retrieves the underline position attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The underline position constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetVerticalScale

(

bool *

isAssigned

)

const

Retrieves the vertical scale attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The scale value, where 1 is 100%.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::GetWariChuEnabled

(

bool *

isAssigned

)

const

Retrieves the WariChu-enabled attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

True if WariChu is on, false if it is off.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

WariChuJustification ATE::ICharFeatures::GetWariChuJustification

(

bool *

isAssigned

)

const

Retrieves the WariChu justification attribute of this character.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The WariChu justification constant.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetWariChuLineCount

(

bool *

isAssigned

)

const

Retrieves the WariChu line count attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The WariChu line count value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetWariChuLineGap

(

bool *

isAssigned

)

const

Retrieves the WariChu line gap attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The WariChu line gap value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetWariChuOrphanAmount

(

bool *

isAssigned

)

const

Retrieves the WariChu orphan amount attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The WariChu orphan amount value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetWariChuScale

(

bool *

isAssigned

)

const

Retrieves the WariChu scale attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The WariChu scale factor, where 1 is 100%

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Real ATE::ICharFeatures::GetWariChuSize

(

bool *

isAssigned

)

const

Retrieves the WariChu size attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The WariChu size in document points.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

ATETextDOM::Int32 ATE::ICharFeatures::GetWariChuWidowAmount

(

bool *

isAssigned

)

const

Retrieves the WariChu widow amount attribute of this character style.

Parameters:

isAssigned

[out] A buffer in which to return true if this attribute has a local value.

Returns:

The WariChu widow amount value.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::IntersectFeatures

(

ICharFeatures

rhs

)

Clears any attributes in this object whose values are not the same as or are unassigned in the comparison object.

The only values that remain are those that match the corresponding value in the comparison object.

Parameters:

rhs

Right-hand side of comparison.

Returns:

True if changes were made.

References GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::IsEachAssigned

(

)

const

Reports whether all attributes of this object are assigned.

Returns:

True if all attributes have local values.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::IsEachNotAssigned

(

)

const

Reports whether all attributes of this object are unassigned.

Returns:

True if no attributes have local values.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sCharFeatures.

bool ATE::ICharFeatures::operator!=

(

const ICharFeatures &

rhs

)

const

Comparison operator tests for inequality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are not the same.

ICharFeatures & ATE::ICharFeatures::operator=

(

const ICharFeatures &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sCharFeatures.

bool ATE::ICharFeatures::operator==

(

const ICharFeatures &

rhs

)

const

Comparison operator tests for equality.

Parameters:

rhs

The object to compare to this one.

Returns:

True if the two objects are the same.

bool ATE::ICharFeatures::ReplaceOrAddFeatures

(

ICharFeatures

rhs

)

Sets any attributes in this object whose values are assigned in the comparison object to those values.

Parameters:

rhs

Right-hand side of comparison.

Returns:

True if changes were made.

References GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetAlternateLigatures

(

bool

newVal

)

Sets the local OpenType alternate ligatures attribute for this character style.

Parameters:

newVal

True to turn alternate ligatures on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetAutoKernType

(

AutoKernType

newVal

)

Sets the local automatic kerning type attribute for this character style.

This is not available for individual characters.

Parameters:

newVal

The new automatic kerning type constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetAutoLeading

(

bool

newVal

)

Sets the local automatic leading attribute for this character.

Parameters:

newVal

True to turn automatic leading on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetAutoMydfb

(

bool

newVal

)

Sets the automatic diacritics y distance from baseline attribute of this character.

Parameters:

newVal

True to turn automatic diacritics y distance from baseline on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetBaselineDirection

(

BaselineDirection

newVal

)

Sets the local Japanese OpenType baseline direction attribute of this character.

Parameters:

newVal

The new baseline direction constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetBaselineShift

(

ATETextDOM::Real

newVal

)

Sets the local baseline shift attribute for this character.

Parameters:

newVal

The new baseline shift value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetCharacterRotation

(

ATETextDOM::Real

newVal

)

Sets the local character rotation attribute for this character.

Parameters:

newVal

The new rotation value in degrees.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetConnectionForms

(

bool

newVal

)

Sets the local OpenType connection forms attribute for this character style.

Parameters:

newVal

True to turn connection forms on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetContextualLigatures

(

bool

newVal

)

Sets the local OpenType contextual ligatures attribute for this character style.

Parameters:

newVal

True to turn contextual ligatures on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetDiacVPos

(

DiacVPos

newVal

)

Sets the diacritics positioning attribute of this character.

Parameters:

newVal

The diacritics positioning object.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetDiacXOffset

(

ATETextDOM::Real

newVal

)

Sets the diacritics x offset attribute of this character.

Parameters:

newVal

The new diacritics x offset in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetDiacYOffset

(

ATETextDOM::Real

newVal

)

Sets the diacritics y offset attribute of this character.

Parameters:

newVal

The new diacritics y offset in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetDigitSet

(

DigitSet

newVal

)

Sets the digit set attribute of this character.

Parameters:

newVal

The new digit set object.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetDirOverride

(

DirOverride

newVal

)

Sets the direction override attribute of this character.

Parameters:

newVal

The new direction override object.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetDiscretionaryLigatures

(

bool

newVal

)

Sets the local OpenType discretionary ligatures attribute for this character style.

Parameters:

newVal

True to turn discretionary ligatures on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFigureStyle

(

FigureStyle

newVal

)

Sets the local OpenType figure style attribute for this character style.

Parameters:

newVal

The new figure style constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFill

(

bool

newVal

)

Sets the local fill attribute of this character.

Parameters:

newVal

True to turn fill on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFillBackground

(

bool

newVal

)

Sets the local fill background attribute of this character.

Parameters:

newVal

True to turn fill on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFillBackgroundColor

(

IApplicationPaint

newVal

)

Sets the local fill background color attribute of this character.

Parameters:

newVal

The paint object containing the new fill color value.

Returns:

Nothing.

References ATE::IApplicationPaint::GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFillColor

(

IApplicationPaint

newVal

)

Sets the local fill color attribute of this character.

Parameters:

newVal

The paint object containing the new fill color value.

Returns:

Nothing.

References ATE::IApplicationPaint::GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFillFirst

(

bool

newVal

)

Sets the local fill-first attribute of this character.

Parameters:

newVal

True to turn fill-first on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFillOverPrint

(

bool

newVal

)

Sets the local fill overprint attribute of this character.

Parameters:

newVal

True to turn fill overprint on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFillVisible

(

bool

newVal

)

Sets the local fill visibilty attribute of this character.

Parameters:

newVal

True to turn fill visibility on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFont

(

IFont

newVal

)

Sets the local font attribute for this character.

Parameters:

newVal

The new font object.

Returns:

Nothing.

References ATE::IFont::GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFontBaselineOption

(

FontBaselineOption

newVal

)

Sets the local font baseline option attribute for this character style.

Parameters:

newVal

The new font baseline option constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFontCapsOption

(

FontCapsOption

newVal

)

Sets the local font caps option attribute for this character style.

Parameters:

newVal

The new font caps option constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFontOpenTypePositionOption

(

FontOpenTypePositionOption

newVal

)

Sets the local font OpenType position option attribute for this character style.

Parameters:

newVal

The new font OpenType position option constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFontSize

(

ATETextDOM::Real

newVal

)

Sets the local font size attribute for this character.

Parameters:

newVal

The new value, in the range [0.1..1296].

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetFractions

(

bool

newVal

)

Sets the local OpenType fractions attribute for this character style.

Parameters:

newVal

True to turn fractions on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetHorizontalScale

(

ATETextDOM::Real

newVal

)

Sets the local horizontal scale attribute for this character.

Parameters:

newVal

The new scaling factor, in the range [0.1..100], where 1 is 100%.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetItalics

(

bool

newVal

)

Sets the local Japanese OpenType italics attribute of this character.

Parameters:

newVal

True to turn italics on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetJapaneseAlternateFeature

(

JapaneseAlternateFeature

newVal

)

Sets the local Japanese OpenType Japanese alternate feature attribute of this character.

Parameters:

newVal

The new Japanese alternate feature constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetJustificationAlternates

(

bool

newVal

)

Sets the justification alternates attribute of this character.

Parameters:

newVal

True to turn justification alternates on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetKana

(

bool

newVal

)

Sets the local Japanese OpenType Kana attribute of this character.

Parameters:

newVal

True to turn Kana on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetKashidas

(

Kashidas

newVal

)

Sets the kashidas attribute of this character.

Parameters:

newVal

The new kashidas object.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLanguage

(

Language

newVal

)

Sets the local Japanese OpenType language attribute of this character.

Parameters:

newVal

The new language constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLeading

(

ATETextDOM::Real

newVal

)

Sets the local leading attribute for this character.

Parameters:

newVal

The new leading value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLeftAki

(

ATETextDOM::Real

newVal

)

Sets the local left Aki attribute of this character.

Parameters:

newVal

The new left Aki value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLigature

(

bool

newVal

)

Sets the local OpenType ligature attribute for this character style.

Parameters:

newVal

The new underline offset value, in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLineCap

(

LineCapType

newVal

)

Sets the local line cap attribute of this character.

Parameters:

newVal

The new line cap type constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLineDashArray

(

IArrayReal

newVal

)

Sets the local line dash array attribute of this character.

Parameters:

newVal

The new line dash array object.

Returns:

Nothing.

References ATE::IArrayReal::GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLineDashOffset

(

ATETextDOM::Real

newVal

)

Sets the local line dash offset attribute of this character.

Parameters:

newVal

The new line dash offset value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLineJoin

(

LineJoinType

newVal

)

Sets the local line join attribute of this character.

Parameters:

newVal

The new line join type constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetLineWidth

(

ATETextDOM::Real

newVal

)

Sets the local line width attribute of this character.

Parameters:

newVal

The new line width value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetMarkYDistFromBaseline

(

ATETextDOM::Real

newVal

)

Sets the diacritics y distance from baseline attribute of this character.

Parameters:

newVal

The new diacritics y distance from baseline in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetMiterLimit

(

ATETextDOM::Real

newVal

)

Sets the local miter limit attribute of this character.

Parameters:

newVal

The new miter limit value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetNoBreak

(

bool

newVal

)

Sets the local no-break attribute of this character.

Parameters:

newVal

True to turn no-break on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetOldStyle

(

bool

newVal

)

Sets the local OpenType old-style attribute for this character style.

Parameters:

newVal

True to turn old-style on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetOrdinals

(

bool

newVal

)

Sets the local OpenType ordinals attribute for this character style.

Parameters:

newVal

True to turn ordinals on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetOrnaments

(

bool

newVal

)

Sets the local OpenType ornaments attribute for this character style.

Parameters:

newVal

True to turn ornaments on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetOverlapSwash

(

bool

newVal

)

Sets the overlap swash attribute of this character.

Parameters:

newVal

True to turn overlap swash on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetProportionalMetrics

(

bool

newVal

)

Sets the local Japanese OpenType proportional metrics attribute of this character.

Parameters:

newVal

True to turn proportional metrics on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetRightAki

(

ATETextDOM::Real

newVal

)

Sets the local right Aki attribute of this character.

Parameters:

newVal

The new right Aki value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetRuby

(

bool

newVal

)

Sets the local Japanese OpenType Ruby attribute of this character.

Parameters:

newVal

True to turn Ruby on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStretchedAlternates

(

bool

newVal

)

Sets the stretched alternates attribute of this character.

Parameters:

newVal

Trues to turn stretched alternates on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStrikethroughPosition

(

StrikethroughPosition

newVal

)

Sets the local strikethrough position attribute for this character style.

Parameters:

newVal

The new strikethrough position constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStroke

(

bool

newVal

)

Sets the local stroke attribute of this character.

Parameters:

newVal

True to turn stroke on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStrokeColor

(

IApplicationPaint

newVal

)

Sets the local stroke color attribute of this character.

Parameters:

newVal

The paint object containing the new stroke color value.

Returns:

Nothing.

References ATE::IApplicationPaint::GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStrokeOverPrint

(

bool

newVal

)

Sets the local stroke overprint attribute of this character.

Parameters:

newVal

True to turn stroke overprint on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStrokeVisible

(

bool

newVal

)

Sets the local stroke visibility attribute of this character.

Parameters:

newVal

True to turn stroke visibility on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStyleRunAlignment

(

StyleRunAlignment

newVal

)

Sets the local Japanese OpenType style run alignment attribute of this character.

Parameters:

newVal

The new style run alignment constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStylisticAlternates

(

bool

newVal

)

Sets the local OpenType stylistic alternates attribute for this character style.

Parameters:

newVal

True to turn stylistic alternates on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetStylisticSets

(

ATETextDOM::Int32

newVal

)

Sets the local OpenType stylistic sets attributes for this character style.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetSwash

(

bool

newVal

)

Sets the local OpenType swash attribute for this character style.

Parameters:

newVal

True to turn swash on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetTCYLeftRightAdjustment

(

ATETextDOM::Int32

newVal

)

Sets the local Tate Chu Yoko right-left adjustment attribute of this character.

Parameters:

newVal

The new adjustment value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetTCYUpDownAdjustment

(

ATETextDOM::Int32

newVal

)

Sets the local Tate Chu Yoko up-down adjustment attribute of this character.

Parameters:

newVal

The new adjustment value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetTitling

(

bool

newVal

)

Sets the local OpenType titling attribute for this character style.

Parameters:

newVal

True to turn titling on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetTracking

(

ATETextDOM::Int32

newVal

)

Sets the local tracking attribute for this character.

Parameters:

newVal

The new tracking value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetTsume

(

ATETextDOM::Real

newVal

)

Sets the local Japanese OpenType Tsume attribute of this character.

Parameters:

newVal

The new Tsume value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetUnderlineOffset

(

ATETextDOM::Real

newVal

)

Sets the local underline offset attribute for this character style.

Parameters:

newVal

The new underline offset value, in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetUnderlinePosition

(

UnderlinePosition

newVal

)

Sets the local underline position attribute for this character style.

Parameters:

newVal

The new underline position constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetVerticalScale

(

ATETextDOM::Real

newVal

)

Sets the local vertical scale attribute for this character.

Parameters:

newVal

The new scaling factor, in the range [0.1..100], where 1 is 100%.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuEnabled

(

bool

newVal

)

Sets the local WariChu enabled attribute of this character.

Parameters:

newVal

True to turn enabling on, false to turn it off.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuJustification

(

WariChuJustification

newVal

)

Sets the local WariChu justification attribute of this character.

Parameters:

newVal

The new justification constant.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuLineCount

(

ATETextDOM::Int32

newVal

)

Sets the local WariChu line count attribute of this character.

Parameters:

newVal

The new line count value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuLineGap

(

ATETextDOM::Int32

newVal

)

Sets the local WariChu line gap attribute of this character.

Parameters:

newVal

The new line gap value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuOrphanAmount

(

ATETextDOM::Int32

newVal

)

Sets the local WariChu orphan amount attribute of this character.

Parameters:

newVal

The new orphan amount value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuScale

(

ATETextDOM::Real

newVal

)

Sets the local WariChu scale attribute of this character.

Parameters:

newVal

The new scaling factor, where 1 is 100%.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuSize

(

ATETextDOM::Real

newVal

)

Sets the local WariChu size attribute of this character.

Parameters:

newVal

The new size value in document points.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

void ATE::ICharFeatures::SetWariChuWidowAmount

(

ATETextDOM::Int32

newVal

)

Sets the local WariChu widow amount attribute of this character.

Parameters:

newVal

The new widow amount value.

Returns:

Nothing.

References ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

bool ATE::ICharFeatures::UnassignEachIfEqual

(

ICharFeatures

rhs

)

Clears any attributes in this object whose values are the same as in the comparison object.

Parameters:

rhs

Right-hand side of comparison.

Returns:

True if changes were made.

References GetRef(), ATE::sCharFeatures, and ATE::Throw_ATE_Exception().

---

The documentation for this class was generated from the following files:

• IText.h
• IText.cpp