Class: TTextLineLayoutHyphenationInfo

Declaration: DeviceDependentLayout.h

Taxonomy Categories:

Member Functions:

operator==
operator<<=
operator>>=

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

This simple class is used by Line Layout to parameterize control over the appearance of soft hyphens.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive classes from TTextLineLayoutHypenationInfo.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TTextLineLayoutHyphenationInfo::operator==

int operator ==(const TTextLineLayoutHyphenationInfo &) const

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Call to compare two instances of this class.

Parameters:

const TTextLineLayoutHyphenationInfo & -The instance of this class to compare with this instance.

Return Value:

Returns 1 if the instances are equal, 0 if they are not.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTextLineLayoutHyphenationInfo::operator<<=

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:

Multithread safe.

Other Considerations:

None.

Member Function: TTextLineLayoutHyphenationInfo::operator>>=

TStream & operator >>=(TStream & toWhere)

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:

Multithread safe.

Other Considerations:

None.

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