Class: TTextCount

Declaration: TextTypes.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

One of three simple types (TTextCount, TTextIndex, and TTextOffset) for use when referencing the Unicode characters stored within a TText object. TText, TTextRange, and TInsertionOffset classes depend upon these three types. TTextCount is for counting UniCode characters in a TText object. For example, the string abc has a TTextCount of 3 for its length. Typically used to specify the length of an entire TText object or the length of a TTextRange within a TText object.

Instantiation:

Allocate on the stack.

Deriving Classes:

This is a primitive class that is not designed for deriving. TTextCount is used pervasively with text and performance is critical.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTextCount::GetMaximum

static const TTextCount & GetMaximum ()

Interface Category:

API.

Purpose:

Gets the maximum possible value for a TTextCount.

Calling Context:

When you need to know the largest positive value possible for a TTextCount, you can call this static member function.

Parameters:

Takes no parameters.

Return Value:

A TTextCount with the largest positive value possible.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator<<=

TStream & operator <<= (TStream & fromStream)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromStream -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: TTextCount::operator>>=

TStream & operator >>=(TStream & toStream) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toStream -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.

Member Function: TTextCount::operator--

TTextCount & operator --()
TTextCount operator --(int)

Interface Category:

API.

Purpose:

Decrement operator.
Decrement operator.

Calling Context:

Call to decrement a TTextCount by 1.
Call to decrement a TTextCount by a specific amount.

Parameters:

Takes no parameters.
int -The number by which to decrement the text count.

Return Value:

The decremented text count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator++

TTextCount & operator ++ ()
TTextCount operator ++ (int)

Interface Category:

API.

Purpose:

Increment operator.
Increment operator.

Calling Context:

Call to increment a TTextCount by 1.
Call to increment a TTextCount by a specific amount.

Parameters:

Takes no parameters.
int -The number by which to increment the text count.

Return Value:

The incremented text count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator%=

TTextCount & operator %= (long that)

Interface Category:

API.

Purpose:

Performs modulus division on the text count and assigns the result to the text count.

Calling Context:

Call to perform modulus division and assign the result to the text count.

Parameters:

long that -The number by which to divide the text count.

Return Value:

The new value of the text count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator/=

TTextCount & operator /= (long that)

Interface Category:

API.

Purpose:

Performs division on the text count and assigns the result to the text count.

Calling Context:

Call to perform division on the text count and assign the result to the text count.

Parameters:

long that -The number by which to divide the text count.

Return Value:

The new value of the text count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator*=

TTextCount & operator *= (long that)

Interface Category:

API.

Purpose:

Performs multiplication on the text count and assigns the result to the text count.

Calling Context:

Call to perform multiplication on the text count and assign the result to the text count.

Parameters:

long that -The number by which to multiply the text count.

Return Value:

The new value of the text count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator-=

TTextCount & operator -=(long that)

Interface Category:

API.

Purpose:

Performs subtraction on the text count and assigns the result to the text count.

Calling Context:

Call to perform subtraction on the text count and assign the result to the text count.

Parameters:

long that -The number to subtract from the text count.

Return Value:

The new value of the text count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator+=

TTextCount & operator += (long that)

Interface Category:

API.

Purpose:

Performs addition on the text count and assigns the result to the text count.

Calling Context:

Call to perform addition on the text count and assign the result to the text count.

Parameters:

long that -The number to add to the text count.

Return Value:

The new value of the text count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operator=

TTextCount & operator =(const TTextCount & that)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTextCount & that -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: TTextCount::TTextCount

TTextCount ()
TTextCount (long that)
TTextCount (const TTextCount & that)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a TTextCount of a particular length.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to construct a TTextCount of a particular length.
Called to copy an object.

Parameters:

Takes no parameters.
long that -The length of this TTextCount.
const TTextCount & that -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextCount::operatorlong

operator long () const

Interface Category:

API.

Purpose:

Converts the TTextCount into a long value.

Calling Context:

Called to convert the TTextCount into a long value.

Parameters:

Takes no parameters.

Return Value:

Implicitly int.

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.