Class: TLinePlacement

Declaration: LineLayout.h

Taxonomy Categories:

Member Functions:

operator<<=
operator>>=
GetBlockHighlightMargins
GetLineStartOrigin
GetJustificationInfo
GetTabStartDelta
GetOrientation

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TLabelLinePlacement TStandardLinePlacement

Purpose:

This object is streamed by line layout to perform a device dependent layout. It defines pure abstract protocol.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Clients must implement the streaming operators.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TLinePlacement::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:

Multithread safe.

Other Considerations:

Clients must implement streaming operators.

Member Function: TLinePlacement::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:

Multithread safe.

Other Considerations:

Clients must implement streaming operators.

Member Function: TLinePlacement::GetBlockHighlightMargins

virtual void GetBlockHighlightMargins (GCoordinate & leftMargin, GCoordinate & rightMargin) const

Interface Category:

API.

Purpose:

Returns the margins to be used for block highlighting.

Calling Context:

Call to access this information.

Parameters:

GCoordinate & leftMargin -The left margin to be used for block highlighting.
GCoordinate & rightMargin -The right margin to be used for block highlighting.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLinePlacement::GetLineStartOrigin

virtual void GetLineStartOrigin (const TTextLineLayout & layout, const TGrafMatrix & gr, TGPoint & origin) const

Interface Category:

API.

Purpose:

Returns the origin of the start of the line.

Calling Context:

Call to access this information.

Parameters:

const TTextLineLayout & layout -The line whose original information is to be determined.
const TGrafMatrix & gr -The resolution to use in determining the origin of the start of the line.
TGPoint & origin -The origin of the start of the line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLinePlacement::GetJustificationInfo

virtual void GetJustificationInfo (TTextLineLayoutJustificationInfo & justifyParms) const

Interface Category:

API.

Purpose:

Returns information on how to justify the text.

Calling Context:

Call to access this information.

Parameters:

TTextLineLayoutJustificationInfo & justifyParms -The information on how to justify the text.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLinePlacement::GetTabStartDelta

virtual GCoordinate GetTabStartDelta () const

Interface Category:

API.

Purpose:

Returns the delta for the beginning of the start of tabulation.

Calling Context:

Call to access this information.

Parameters:

Takes no parameters.

Return Value:

The delta.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLinePlacement::GetOrientation

virtual void GetOrientation (TSingleLineOrientation &) const

Interface Category:

API.

Purpose:

Returns the orientation of the line.

Calling Context:

Call to access this information.

Parameters:

TSingleLineOrientation & -The orientation of the line.

Return Value:

None.

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.