Class: TFormattableText

Declaration: TextFormatter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TFormattable

Inherited By:

None.

Purpose:

Derived from TFormattable, this class encapsulates a TText object, allowing it to be formatted by TFormatter classes.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TFormattableText is a concrete class designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TFormattableText::TFormattableText

TFormattableText ()
TFormattableText (const TFormattableText & toCopy)
TFormattableText (const TText & newFormat)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Constructs a Formattable that encapsulates the specified text object.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Called to construct a Formattable with a particular text string.

Parameters:

Takes no parameters.
const TFormattableText & toCopy -The object to copy.
const TText & newFormat -The text object this Formattable encapsulates.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFormattableText::~TFormattableText

~ TFormattableText ()

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: TFormattableText::operator=

virtual TFormattableText & operator =(const TFormattableText & toCopy)
virtual TFormattable & operator =(const TFormattable & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.
Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.
Called when an object is assigned to another compatible object.

Parameters:

const TFormattableText & toCopy -The source object for the assignment.
const TFormattable & toCopy -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: TFormattableText::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFormattableText::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 is streamed 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.

Member Function: TFormattableText::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 is streamed 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: TFormattableText::GetText

virtual const TText * GetText () const

Interface Category:

API.

Purpose:

Returns the text object encapsulated by this Formattable.

Calling Context:

Called to get the value of this Formattable.

Parameters:

Takes no parameters.

Return Value:

The text object encapsulated by this Formattable.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFormattableText::SetText

virtual void SetText (const TText & value)

Interface Category:

API.

Purpose:

Specifies the text object to be encapsulated by this Formattable.

Calling Context:

Called to set the text value of this Formattable after construction.

Parameters:

const TText & value -The text object to be encapsulated by this Formattable.

Return Value:

None.

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.