ATE::IDocumentTextResources Class Reference

This object encapsulates the text resources of a document. More...

#include <IText.h>

List of all members.

Public Member Functions
	IDocumentTextResources ()
	Constructor.
	IDocumentTextResources (const IDocumentTextResources &src)
	Copy constructor.
IDocumentTextResources &	operator= (const IDocumentTextResources &rhs)
	Assignment operator.
bool	operator== (const IDocumentTextResources &rhs) const
	Comparison operator tests for equality.
bool	operator!= (const IDocumentTextResources &rhs) const
	Comparison operator tests for inequality.
	IDocumentTextResources (DocumentTextResourcesRef documenttextresources)
	Constructs this C++ object from the corresponding C object returned by an ATE suite function.
virtual	~IDocumentTextResources ()
	Destructor.
DocumentTextResourcesRef	GetRef () const
	Retrieves a reference to this object.
bool	IsNull () const
	Reports whether this is a null object.
IKinsokuSet	GetKinsokuSet () const
	Retrieves the Kinsoku set for the document.
IMojiKumiSet	GetMojiKumiSet () const
	Retrieves the MojiKumi set for the document.
ICompFontClassSet	GetCompFontClassSet () const
	Retrieves the composite font class set for the document.
ICompFontSet	GetCompFontSet () const
	Retrieves the composite font set for the document.
ITextResources	GetTextResources ()
	Retrieves the text resources for the document.
IFind	GetFind ()
	Retrieves the search object for the document.
ISpell	GetSpell ()
	Retrieves the spell-check object for the document.
IGlyph	GetGlyphAndAlternates () const
	Retrieves the glyph for the document.
IGlyph	GetAlternateGlyph () const
	Retrieves the alternate glyph for the document.
void	InsertAlternateGlyph (const ATETextDOM::Unicode *theCharacters, const ATEGlyphID glyphID, const char *otFeatureArray, ATETextDOM::Int32 otFeatureCount, const ATETextDOM::Int32 *otFeatureIndexArray, bool leaveSelected)
	Inserts a new alternate glyph.
IArrayInteger	GetAlternatesAvailableThroughoutSelection () const
	Retrieves the alternate glyphs for the document that are available for selection.
JapaneseAlternateFeature	GetJapaneseAlternateFeatureInSelection (bool *isFeature) const
	Retrieves the Japanese alternate-feature value for the document selection.
void	SetJapaneseAlternateFeatureInSelection (JapaneseAlternateFeature feature)
	Sets the Japanese alternate-feature value for the document selection.
ICharStyles	GetCharStylesInDocument () const
	Retrieves the character style set for the document.
IParaStyles	GetParaStylesInDocument () const
	Retrieves the paragraph style set for the document.
ICharStyle	GetCharStyle (const ATETextDOM::Unicode *pName) const
	Retrieves a specific character style from the style set for the document.
IParaStyle	GetParaStyle (const ATETextDOM::Unicode *pName) const
	Retrieves a specific paragraph style from the style set for the document.
ICharStyle	GetNormalCharStyle () const
	Retrieves the normal character style for the document.
IParaStyle	GetNormalParaStyle () const
	Retrieves the normal paragraph style for the document.
void	ResetNormalCharStyle ()
	Sets the normal character style for the document to the application default.
void	ResetNormalParaStyle ()
	Sets the normal paragraph style for the document to the application default.
ICharStyle	CreateCharStyle (const ATETextDOM::Unicode *pName)
	Creates a new, empty character style and adds it to the style set for the document.
IParaStyle	CreateParaStyle (const ATETextDOM::Unicode *pName)
	Creates a new, empty paragraph style and adds it to the style set for the document.
ICharStyle	CreateCharStyleWithFeatures (const ATETextDOM::Unicode *pName, ICharFeatures pFeatures)
	Creates a new character style with specified features and adds it to the style set for the document.
IParaStyle	CreateParaStyleWithFeatures (const ATETextDOM::Unicode *pName, IParaFeatures pFeatures)
	Creates a new paragraph style with specified features and adds it to the style set for the document.
bool	RemoveCharStyle (const ATETextDOM::Unicode *pName)
	Removes a character style from the style set for the document.
bool	RemoveParaStyle (const ATETextDOM::Unicode *pName)
	Removes a paragraph style from the style set for the document.
void	ImportCharStyles (ITextResources pSrcResources)
	Imports a set of character styles into this document from another resource set.
void	ImportParaStyles (ITextResources pSrcResources)
	Imports a set of paragraph styles into this document from another resource set.
void	SetUseSmartQuotes (bool smartQuotesAreOn)
	Turns smart-quotes on or off for this document.
void	SetSmartDoubleQuoteCharacters (ATETextDOM::Unicode openQuote, ATETextDOM::Unicode closeQuote, Language language)
	Sets the smart-quotes double-quote character codes for a specific language.
void	SetSmartSingleQuoteCharacters (ATETextDOM::Unicode openQuote, ATETextDOM::Unicode closeQuote, Language language)
	Sets the smart-quotes single-quote character codes for a specific language.
bool	UseSmartQuotes ()
	Reports whether smart-quotes are on for this document.
void	GetSmartDoubleQuoteCharacters (ATETextDOM::Unicode *openQuote, ATETextDOM::Unicode *closeQuote, Language language)
	Retrieves the smart-quotes double-quote character codes for a specific language.
void	GetSmartSingleQuoteCharacters (ATETextDOM::Unicode *openQuote, ATETextDOM::Unicode *closeQuote, Language language)
	Retrieves the smart-quotes single-quote character codes for a specific language.
ICharFeatures	GetInsertionCharFeatures () const
	Retrieves the local overrides (character features) from the insertion attributes, saved from the most recent text selection or attribute change to text.
ICharStyle	GetInsertionCharStyle () const
	Retrieves the character style from the insertion attributes, saved from the most recent text selection or attribute change to text.
void	SetInsertionFeaturesAndStyle (const ICharFeatures &pFeatures, const ATETextDOM::Unicode *pStyleName)
	Sets the character features and style for the current insertion attributes.
ATETextDOM::Real	GetSuperscriptSize () const
	Retrieves the superscript size.
void	SetSuperscriptSize (ATETextDOM::Real value)
	Sets the superscript size.
ATETextDOM::Real	GetSuperscriptPosition () const
	Retrieves the superscript position.
void	SetSuperscriptPosition (ATETextDOM::Real value)
	Sets the superscript position.
ATETextDOM::Real	GetSubscriptSize () const
	Retrieves the subscript size.
void	SetSubscriptSize (ATETextDOM::Real value)
	Sets the supbscript size.
ATETextDOM::Real	GetSubscriptPosition () const
	Retrieves the subscript position.
void	SetSubscriptPosition (ATETextDOM::Real value)
	Sets the subscript position.
ATETextDOM::Real	GetSmallCapSize () const
	Retrieves the small-cap size.
void	SetSmallCapSize (ATETextDOM::Real value)
	Sets the small-cap size.
bool	GetShowHiddenCharacters () const
	Reports whether hidden characters are shown.
void	SetShowHiddenCharacters (bool value)
	Turns show hidden characters on or off.
ATETextDOM::Int32	GetGreekingSize () const
	Retrieves the greeking threshhold.
void	SetGreekingSize (ATETextDOM::Int32 value)
	Sets the greeking threshhold.
bool	GetHighlightSubstituteFonts () const
	Reports whether substitute fonts are highlighted.
void	SetHighlightSubstituteFonts (bool value)
	Turns highlighting of substitute fonts on or off.
bool	GetHighlightAlternateGlyphs () const
	Reports whether alternate glyphs are highlighted.
void	SetHighlightAlternateGlyphs (bool value)
	Turns highlighting of alternate glyphs on or off.

---

Detailed Description

This object encapsulates the text resources of a document.

Text resources include fonts, character and paragraph styles, and various text preferences.

---

Constructor & Destructor Documentation

ATE::IDocumentTextResources::IDocumentTextResources

(

)

Constructor.

Returns:

The new object.

ATE::IDocumentTextResources::IDocumentTextResources

(

const IDocumentTextResources &

src

)

Copy constructor.

Parameters:

src

The object to copy.

Returns:

The new object.

References ATE::sDocumentTextResources.

ATE::IDocumentTextResources::IDocumentTextResources

(

DocumentTextResourcesRef

documenttextresources

)

[explicit]

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

The C++ object manages reference counting.

Parameters:

documenttextresources

The C object.

Returns:

The new C++ object.

ATE::IDocumentTextResources::~IDocumentTextResources

(

)

[virtual]

Destructor.

References ATE::sDocumentTextResources.

---

Member Function Documentation

ICharStyle ATE::IDocumentTextResources::CreateCharStyle

(

const ATETextDOM::Unicode *

pName

)

Creates a new, empty character style and adds it to the style set for the document.

Parameters:

pName

The style name.

Returns:

The character style object, or a null object if a style with this name already exists, or if the name is an empty string. If no style is created, the document style set remains unchanged.

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

ICharStyle ATE::IDocumentTextResources::CreateCharStyleWithFeatures	(	const ATETextDOM::Unicode *	pName,
		ICharFeatures	pFeatures
	)

Creates a new character style with specified features and adds it to the style set for the document.

Parameters:

	pName	The style name.
	pFeatures	The feature set for the new style.

Returns:

The character style object, or a null object if a style with this name already exists, or if the name is an empty string. If no style is created, the document style set remains unchanged.

References ATE::ICharFeatures::GetRef(), ATE::sDocumentTextResources, and ATE::Throw_ATE_Exception().

IParaStyle ATE::IDocumentTextResources::CreateParaStyle

(

const ATETextDOM::Unicode *

pName

)

Creates a new, empty paragraph style and adds it to the style set for the document.

Parameters:

pName

The style name.

Returns:

The paragraph style object, or a null object if a style with this name already exists, or if the name is an empty string. If no style is created, the document style set remains unchanged.

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

IParaStyle ATE::IDocumentTextResources::CreateParaStyleWithFeatures	(	const ATETextDOM::Unicode *	pName,
		IParaFeatures	pFeatures
	)

Creates a new paragraph style with specified features and adds it to the style set for the document.

Parameters:

	pName	The style name.
	pFeatures	The feature set for the new style.

Returns:

The paragraph style object, or a null object if a style with this name already exists, or if the name is an empty string. If no style is created, the document style set remains unchanged.

References ATE::IParaFeatures::GetRef(), ATE::sDocumentTextResources, and ATE::Throw_ATE_Exception().

IGlyph ATE::IDocumentTextResources::GetAlternateGlyph

(

)

const

Retrieves the alternate glyph for the document.

Returns:

The glyph object.

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

IArrayInteger ATE::IDocumentTextResources::GetAlternatesAvailableThroughoutSelection

(

)

const

Retrieves the alternate glyphs for the document that are available for selection.

Returns:

The array of alternate glyphs.

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

ICharStyle ATE::IDocumentTextResources::GetCharStyle

(

const ATETextDOM::Unicode *

pName

)

const

Retrieves a specific character style from the style set for the document.

Parameters:

pName

The style name.

Returns:

The character style object.

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

ICharStyles ATE::IDocumentTextResources::GetCharStylesInDocument

(

)

const

Retrieves the character style set for the document.

Returns:

The character style set object.

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

ICompFontClassSet ATE::IDocumentTextResources::GetCompFontClassSet

(

)

const

Retrieves the composite font class set for the document.

Returns:

The composite font class set object.

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

ICompFontSet ATE::IDocumentTextResources::GetCompFontSet

(

)

const

Retrieves the composite font set for the document.

Returns:

The composite font set object.

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

IFind ATE::IDocumentTextResources::GetFind

(

)

Retrieves the search object for the document.

Returns:

The search object.

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

IGlyph ATE::IDocumentTextResources::GetGlyphAndAlternates

(

)

const

Retrieves the glyph for the document.

Returns:

The glyph object.

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

ATETextDOM::Int32 ATE::IDocumentTextResources::GetGreekingSize

(

)

const

Retrieves the greeking threshhold.

Returns:

The greeking threshhold in document points.

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

bool ATE::IDocumentTextResources::GetHighlightAlternateGlyphs

(

)

const

Reports whether alternate glyphs are highlighted.

Returns:

True if alternate glyphs are highlighted.

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

bool ATE::IDocumentTextResources::GetHighlightSubstituteFonts

(

)

const

Reports whether substitute fonts are highlighted.

Returns:

True if substitute fonts are highlighted.

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

ICharFeatures ATE::IDocumentTextResources::GetInsertionCharFeatures

(

)

const

Retrieves the local overrides (character features) from the insertion attributes, saved from the most recent text selection or attribute change to text.

Returns:

The character features object.

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

ICharStyle ATE::IDocumentTextResources::GetInsertionCharStyle

(

)

const

Retrieves the character style from the insertion attributes, saved from the most recent text selection or attribute change to text.

Returns:

The character style object.

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

JapaneseAlternateFeature ATE::IDocumentTextResources::GetJapaneseAlternateFeatureInSelection

(

bool *

isFeature

)

const

Retrieves the Japanese alternate-feature value for the document selection.

Parameters:

isFeature

[out] A buffer in which to return true if the alternate is found.

Returns:

The feature constant.

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

IKinsokuSet ATE::IDocumentTextResources::GetKinsokuSet

(

)

const

Retrieves the Kinsoku set for the document.

Returns:

The Kinsoku set object.

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

IMojiKumiSet ATE::IDocumentTextResources::GetMojiKumiSet

(

)

const

Retrieves the MojiKumi set for the document.

Returns:

The MojiKumi set object.

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

ICharStyle ATE::IDocumentTextResources::GetNormalCharStyle

(

)

const

Retrieves the normal character style for the document.

Returns:

The character style object.

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

IParaStyle ATE::IDocumentTextResources::GetNormalParaStyle

(

)

const

Retrieves the normal paragraph style for the document.

Returns:

The paragraph style object.

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

IParaStyle ATE::IDocumentTextResources::GetParaStyle

(

const ATETextDOM::Unicode *

pName

)

const

Retrieves a specific paragraph style from the style set for the document.

Parameters:

pName

The style name.

Returns:

The paragraph style object.

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

IParaStyles ATE::IDocumentTextResources::GetParaStylesInDocument

(

)

const

Retrieves the paragraph style set for the document.

Returns:

The paragraph style set object.

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

DocumentTextResourcesRef ATE::IDocumentTextResources::GetRef

(

)

const

Retrieves a reference to this object.

Returns:

The object reference.

bool ATE::IDocumentTextResources::GetShowHiddenCharacters

(

)

const

Reports whether hidden characters are shown.

Returns:

True if hidden characters are shown.

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

ATETextDOM::Real ATE::IDocumentTextResources::GetSmallCapSize

(

)

const

Retrieves the small-cap size.

Returns:

The size in document points.

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

void ATE::IDocumentTextResources::GetSmartDoubleQuoteCharacters	(	ATETextDOM::Unicode *	openQuote,
		ATETextDOM::Unicode *	closeQuote,
		Language	language
	)

Retrieves the smart-quotes double-quote character codes for a specific language.

Parameters:

	openQuote	[out] A buffer in which to return the code used for opening double-quote.
	closeQuote	[out] A buffer in which to return the code used for opening double-quote.
	language	The language for which to get codes.

Returns:

Nothing

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

void ATE::IDocumentTextResources::GetSmartSingleQuoteCharacters	(	ATETextDOM::Unicode *	openQuote,
		ATETextDOM::Unicode *	closeQuote,
		Language	language
	)

Retrieves the smart-quotes single-quote character codes for a specific language.

Parameters:

	openQuote	[out] A buffer in which to return the code used for opening single-quote.
	closeQuote	[out] A buffer in which to return the code used for opening single-quote.
	language	The language for which to get codes.

Returns:

Nothing

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

ISpell ATE::IDocumentTextResources::GetSpell

(

)

Retrieves the spell-check object for the document.

Returns:

The spell-check object.

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

ATETextDOM::Real ATE::IDocumentTextResources::GetSubscriptPosition

(

)

const

Retrieves the subscript position.

Returns:

The position in document points and page coordinates.

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

ATETextDOM::Real ATE::IDocumentTextResources::GetSubscriptSize

(

)

const

Retrieves the subscript size.

Returns:

The size in document points.

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

ATETextDOM::Real ATE::IDocumentTextResources::GetSuperscriptPosition

(

)

const

Retrieves the superscript position.

Returns:

The position in document points and page coordinates.

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

ATETextDOM::Real ATE::IDocumentTextResources::GetSuperscriptSize

(

)

const

Retrieves the superscript size.

Returns:

The size in document points.

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

ITextResources ATE::IDocumentTextResources::GetTextResources

(

)

Retrieves the text resources for the document.

Returns:

The text resources object.

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

void ATE::IDocumentTextResources::ImportCharStyles

(

ITextResources

pSrcResources

)

Imports a set of character styles into this document from another resource set.

Parameters:

pSrcResources

The source text-resources object.

Returns:

Nothing.

References ATE::ITextResources::GetRef(), ATE::sDocumentTextResources, and ATE::Throw_ATE_Exception().

void ATE::IDocumentTextResources::ImportParaStyles

(

ITextResources

pSrcResources

)

Imports a set of paragraph styles into this document from another resource set.

Parameters:

pSrcResources

The source text-resources object.

Returns:

Nothing.

References ATE::ITextResources::GetRef(), ATE::sDocumentTextResources, and ATE::Throw_ATE_Exception().

void ATE::IDocumentTextResources::InsertAlternateGlyph	(	const ATETextDOM::Unicode *	theCharacters,
		const ATEGlyphID	glyphID,
		const char *	otFeatureArray,
		ATETextDOM::Int32	otFeatureCount,
		const ATETextDOM::Int32 *	otFeatureIndexArray,
		bool	leaveSelected
	)

Inserts a new alternate glyph.

Parameters:

	theCharacters	The characters for which this glyph is an alternate.
	glyphID	The glyph identifier.
	otFeatureArray	An array of features.
	otFeatureCount	The size of the feature array.
	otFeatureIndexArray	A mapping of the glyph-feature array to the character features.
	leaveSelected	True to leave the character in the selected state.

Returns:

Nothing.

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

bool ATE::IDocumentTextResources::IsNull

(

)

const

Reports whether this is a null object.

Returns:

True if this is a null object.

References ATE::sDocumentTextResources.

bool ATE::IDocumentTextResources::operator!=

(

const IDocumentTextResources &

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.

IDocumentTextResources & ATE::IDocumentTextResources::operator=

(

const IDocumentTextResources &

rhs

)

Assignment operator.

Parameters:

rhs

The object to assign to this one.

Returns:

A reference to this object.

References ATE::sDocumentTextResources.

bool ATE::IDocumentTextResources::operator==

(

const IDocumentTextResources &

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::IDocumentTextResources::RemoveCharStyle

(

const ATETextDOM::Unicode *

pName

)

Removes a character style from the style set for the document.

Parameters:

pName

The style name.

Returns:

True if a style with this name is removed, false if no style with this name is in the document, or if the name is an empty string.

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

bool ATE::IDocumentTextResources::RemoveParaStyle

(

const ATETextDOM::Unicode *

pName

)

Removes a paragraph style from the style set for the document.

Parameters:

pName

The style name.

Returns:

True if a style with this name is removed, false if no style with this name is in the document, or if the name is an empty string.

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

void ATE::IDocumentTextResources::ResetNormalCharStyle

(

)

Sets the normal character style for the document to the application default.

Returns:

Nothing.

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

void ATE::IDocumentTextResources::ResetNormalParaStyle

(

)

Sets the normal paragraph style for the document to the application default.

Returns:

Nothing.

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

void ATE::IDocumentTextResources::SetGreekingSize

(

ATETextDOM::Int32

value

)

Sets the greeking threshhold.

Parameters:

value

The new threshhold in document points.

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetHighlightAlternateGlyphs

(

bool

value

)

Turns highlighting of alternate glyphs on or off.

Parameters:

value

True to highligh alternate glyphs, false to turn highlighting off.

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

void ATE::IDocumentTextResources::SetHighlightSubstituteFonts

(

bool

value

)

Turns highlighting of substitute fonts on or off.

Parameters:

value

True to highlight substitute fonts, false to turn highlighting off.

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

void ATE::IDocumentTextResources::SetInsertionFeaturesAndStyle	(	const ICharFeatures &	pFeatures,
		const ATETextDOM::Unicode *	pStyleName
	)

Sets the character features and style for the current insertion attributes.

Parameters:

	pFeatures	The new character features object.
	pStyleName	The new style name.

Returns:

Nothing

References ATE::ICharFeatures::GetRef(), ATE::sDocumentTextResources, and ATE::Throw_ATE_Exception().

void ATE::IDocumentTextResources::SetJapaneseAlternateFeatureInSelection

(

JapaneseAlternateFeature

feature

)

Sets the Japanese alternate-feature value for the document selection.

Parameters:

feature

The feature constant.

Returns:

Nothing.

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

void ATE::IDocumentTextResources::SetShowHiddenCharacters

(

bool

value

)

Turns show hidden characters on or off.

Parameters:

value

True to show hidden characters, false to hide them.

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

void ATE::IDocumentTextResources::SetSmallCapSize

(

ATETextDOM::Real

value

)

Sets the small-cap size.

Parameters:

value

The new size in document points.

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetSmartDoubleQuoteCharacters	(	ATETextDOM::Unicode	openQuote,
		ATETextDOM::Unicode	closeQuote,
		Language	language
	)

Sets the smart-quotes double-quote character codes for a specific language.

Parameters:

	openQuote	The code to use for opening double-quote.
	closeQuote	The code to use for opening double-quote.
	language	The language in which to use these codes.

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetSmartSingleQuoteCharacters	(	ATETextDOM::Unicode	openQuote,
		ATETextDOM::Unicode	closeQuote,
		Language	language
	)

Sets the smart-quotes single-quote character codes for a specific language.

Parameters:

	openQuote	The code to use for opening single-quote.
	closeQuote	The code to use for opening single-quote.
	language	The language in which to use these codes.

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetSubscriptPosition

(

ATETextDOM::Real

value

)

Sets the subscript position.

Parameters:

value

The new position in document points and page coordinates.Text that does not fit is truncated

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetSubscriptSize

(

ATETextDOM::Real

value

)

Sets the supbscript size.

Parameters:

value

The new size in document points.

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetSuperscriptPosition

(

ATETextDOM::Real

value

)

Sets the superscript position.

Parameters:

value

The new position in document points and page coordinates.

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetSuperscriptSize

(

ATETextDOM::Real

value

)

Sets the superscript size.

Parameters:

value

The new size in document points.

Returns:

Nothing

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

void ATE::IDocumentTextResources::SetUseSmartQuotes

(

bool

smartQuotesAreOn

)

Turns smart-quotes on or off for this document.

Parameters:

smartQuotesAreOn

True to turn smart-quotes on, false to turn them off.

Returns:

Nothing

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

bool ATE::IDocumentTextResources::UseSmartQuotes

(

)

Reports whether smart-quotes are on for this document.

Returns:

True if smart-quotes are on.

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

---

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

• IText.h
• IText.cpp