Class: TTransliteratorModifier

Declaration: TextModifier.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TTextModifier

Inherited By:

None.

Purpose:

TTransliteratorModifier is derived from TTextModifier. It provides the typing configuration access to transliterators.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TTransliteratorModifier::TTransliteratorModifier

TTransliteratorModifier ()
TTransliteratorModifier (const TTransliteratorModifier & tran)
TTransliteratorModifier (const TLocalizableName & transliteratorName)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructor for creating a TTransliteratorModifier with the specified localizable (human readable) name.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Called to construct a TTransliteratorModifier with the specified localizable (human readable) name.

Parameters:

Takes no parameters.
const TTransliteratorModifier & tran -The object to copy.
const TLocalizableName & transliteratorName -The name for the transliterator modifier.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransliteratorModifier::~TTransliteratorModifier

virtual ~ TTransliteratorModifier ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransliteratorModifier::Modify

virtual bool Modify (const TText & currentText, const TTextRange & newRange, const TText & newText, TText & replacementText, TTextRange & replacementRange)

Interface Category:

API.

Purpose:

Given the current text, the new text to be added to the current text, and the newRange indicating where the new text is to be added, this function generates the replacement text by applying the transliterator modifier particular to thisobject to the new text. The modified text is returned in the replacementText parameter. This function also generates the replacement range, which indicates the range of text in currentText that is to be replaced by the modified text.

Calling Context:

Called by the typing configuration on each of its text modifiers.

Parameters:

const TText & currentText -The current text.
const TTextRange & newRange -The range indicating where new text is to be added, including any backspaces. Note: newRange.GetCount is defined to be the number of deletions, and newRange.GetEnd is defined to be the insertion point relative to currentText.
const TText & newText -The new text to be added to currentText.
TText & replacementText -The modified text, after invoking the modifiers on the new text.
TTextRange & replacementRange -The range of text in currentText that is to be replaced.

Return Value:

Returns true if a modification was made, and thus replacementText was generated.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TTextModifier function.

Member Function: TTransliteratorModifier::operator=

TTransliteratorModifier & operator =(const TTransliteratorModifier & tran)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTransliteratorModifier & tran -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransliteratorModifier::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTransliteratorModifier::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.