AIATECurrentTextFeaturesSuite Struct Reference
[API Suite List]

These functions allow you to access and manipulate the character and paragraph style attributes of text. More...

#include <AIATECurrTextFeatures.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetCurrentCharFeature )(ATE::CharFeaturesRef *charFeatures)
	Retrieves the character attributes for the current text selection, in a flattened attribute chain, as displayed in the Character Attribute palette.
AIAPI AIErr(*	GetCurrentParaFeature )(ATE::ParaFeaturesRef *paraFeatures)
	Retrieves the paragraph attributes for the current text selection, in a flattened attribute chain, as displayed in the Paragraph Attribute palette.
AIAPI AIErr(*	SetCurrentCharFeature )(ATE::CharFeaturesRef charFeatures)
	Sets the character attributes for the current text selection,.
AIAPI AIErr(*	SetCurrentParaFeature )(ATE::ParaFeaturesRef paraFeatures)
	Sets the paragraph attributes for the current text selection,.
AIAPI AIErr(*	GetCurrentCharStyle )(ATE::CharStyleRef *pStyle)
	Retrieves the named character style that are applied to new text objects.
AIAPI AIErr(*	GetCurrentParaStyle )(ATE::ParaStyleRef *pStyle)
	Retrieves the named paragraph style that are applied to new text objects.
AIAPI AIErr(*	SetCurrentCharStyle )(ATE::CharStyleRef pStyle)
	Sets the named character style to be applied to new text objects.
AIAPI AIErr(*	SetCurrentParaStyle )(ATE::ParaStyleRef pStyle)
	Sets the named paragraph style to be applied to new text objects.
AIAPI AIErr(*	Invalidate )()
	Updates the UI to reflect any modifications you have made to the current text styles or features.
AIAPI AIErr(*	GetCurrentCharOverrides )(ATE::CharFeaturesRef *pFeatures)
	Retrieves the current local character override attributes that are applied to new text objects.
AIAPI AIErr(*	GetCurrentParaOverrides )(ATE::ParaFeaturesRef *pFeatures)
	Retrieves the current local paragraph override attributes that are applied to new text objects.
AIAPI AIErr(*	SetCurrentCharOverrides )(ATE::CharFeaturesRef pFeatures)
	Sets the current local character override attributes that are applied to new text objects.
AIAPI AIErr(*	SetCurrentParaOverrides )(ATE::ParaFeaturesRef pFeatures)
	Sets the current local paragraph override attributes that are applied to new text objects.

---

Detailed Description

These functions allow you to access and manipulate the character and paragraph style attributes of text.

• The current styles are those that are applied to new text.
• The styles applied to currently selected text are the ones displayed in the Character and Paragraph palettes.

You can define overrides for a character or paragraph style -- that is, a subset of features with override values.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIATECurrentTextFeaturesSuite and kAIATECurrentTextFeaturesVersion.

---

Member Data Documentation

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::GetCurrentCharFeature)(ATE::CharFeaturesRef *charFeatures)

Retrieves the character attributes for the current text selection, in a flattened attribute chain, as displayed in the Character Attribute palette.

Parameters:

charFeatures

[out] A buffer in which to return the character attributes.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::GetCurrentCharOverrides)(ATE::CharFeaturesRef *pFeatures)

Retrieves the current local character override attributes that are applied to new text objects.

Parameters:

pFeatures

[out] A buffer in which to return the character features containing override values.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::GetCurrentCharStyle)(ATE::CharStyleRef *pStyle)

Retrieves the named character style that are applied to new text objects.

The default is the normal style in new documents.

Parameters:

pStyle

[out] A buffer in which to return the character style.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::GetCurrentParaFeature)(ATE::ParaFeaturesRef *paraFeatures)

Retrieves the paragraph attributes for the current text selection, in a flattened attribute chain, as displayed in the Paragraph Attribute palette.

Parameters:

paraFeatures

[out] A buffer in which to return the paragraph attributes.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::GetCurrentParaOverrides)(ATE::ParaFeaturesRef *pFeatures)

Retrieves the current local paragraph override attributes that are applied to new text objects.

Parameters:

pFeatures

[out] A buffer in which to return the paragraph features containing override values.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::GetCurrentParaStyle)(ATE::ParaStyleRef *pStyle)

Retrieves the named paragraph style that are applied to new text objects.

The default is the normal style in new documents.

Parameters:

pStyle

[out] A buffer in which to return the paragraph style.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::Invalidate)()

Updates the UI to reflect any modifications you have made to the current text styles or features.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::SetCurrentCharFeature)(ATE::CharFeaturesRef charFeatures)

Sets the character attributes for the current text selection,.

Parameters:

charFeatures

A flattened attribute chain, as displayed in the Character Attribute palette.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::SetCurrentCharOverrides)(ATE::CharFeaturesRef pFeatures)

Sets the current local character override attributes that are applied to new text objects.

Parameters:

pFeatures

The character features with override values. If all attributes are unassigned, clears the current overrides.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::SetCurrentCharStyle)(ATE::CharStyleRef pStyle)

Sets the named character style to be applied to new text objects.

If no text selection is present, overrides are cleared.

Parameters:

pStyle

The character style.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::SetCurrentParaFeature)(ATE::ParaFeaturesRef paraFeatures)

Sets the paragraph attributes for the current text selection,.

Parameters:

paraFeatures

A flattened attribute chain, as displayed in the Paragraph Attribute palette.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::SetCurrentParaOverrides)(ATE::ParaFeaturesRef pFeatures)

Sets the current local paragraph override attributes that are applied to new text objects.

Parameters:

pFeatures

The paragraph features with override values. If all attributes are unassigned, clears the current overrides.

AIAPI AIErr(* AIATECurrentTextFeaturesSuite::SetCurrentParaStyle)(ATE::ParaStyleRef pStyle)

Sets the named paragraph style to be applied to new text objects.

If no text selection is present, overrides are cleared.

Parameters:

pStyle

The paragraph style.

---

The documentation for this struct was generated from the following file:

• AIATECurrTextFeatures.h