Class: TStandardLinePlacement

Declaration: LineLayout.h

Taxonomy Categories:

Member Functions:

SetViewMargins
SetParagraphMargins
operator=
operator==
operator<<=
operator>>=
GetBlockHighlightMargins
GetLineStartOrigin
GetJustificationInfo
GetTabStartDelta
GetParagraphMargins
GetViewMargins
GetOrientation
SetOrientation
~TStandardLinePlacement
TStandardLinePlacement

Interface Category:

API.

Inherits From:

TLinePlacement

Inherited By:

None.

Purpose:

Provides standard information for line positioning.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive unless you are implementing your own version of Line Layout.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardLinePlacement::SetViewMargins

virtual void SetViewMargins (const GCoordinate leftMargin, const GCoordinate rightMargin)

Interface Category:

API.

Purpose:

Sets the margins for viewing the line.

Calling Context:

Call to set the margins for viewing the line.

Parameters:

const GCoordinate leftMargin -The left margin for viewing the line.
const GCoordinate rightMargin -The right margin for viewing the line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

These should normally be leftMargin =0 and the rightMargin =viewWidth. These will be set as defaults from the view width. For irregular shapes these values may be different.

Member Function: TStandardLinePlacement::SetParagraphMargins

virtual void SetParagraphMargins (const GCoordinate beforeMargin, const GCoordinate AfterMargin)

Interface Category:

API.

Purpose:

Sets the paragraph margins for the line.

Calling Context:

Sets the paragraph margins for the line.

Parameters:

const GCoordinate beforeMargin -The margin before the text line.
const GCoordinate AfterMargin -The margin after the text line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

These should normally be the paragraph leftMargin the paragraph rightMargin for right to left text, otherwise it has the opposite meaning. These will default to 0, 0. The margins are relative to the text view's right and left edge.

Member Function: TStandardLinePlacement::operator=

TStandardLinePlacement & operator =(const TStandardLinePlacement &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardLinePlacement & -The object to copy.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardLinePlacement::operator==

virtual int operator ==(const TStandardLinePlacement &) const

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Call to compare two objects.

Parameters:

const TStandardLinePlacement & -The object to compare to this object.

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: TStandardLinePlacement::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:

None.

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

None.

Member Function: TStandardLinePlacement::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: TStandardLinePlacement::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 the origin of whose start 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: TStandardLinePlacement::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 -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: TStandardLinePlacement::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: TStandardLinePlacement::GetParagraphMargins

virtual void GetParagraphMargins (GCoordinate & beforeMargin, GCoordinate & AfterMargin) const

Interface Category:

API.

Purpose:

Returns the paragraph margins for the line.

Calling Context:

Call to access this information.

Parameters:

const GCoordinate beforeMargin -The margin before the text line.
const GCoordinate AfterMargin -The margin after the text line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardLinePlacement::GetViewMargins

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

Interface Category:

API.

Purpose:

Returns the margins for viewing the line.

Calling Context:

Call to access this information.

Parameters:

const GCoordinate leftMargin -The left margin for viewing the line.
const GCoordinate rightMargin -The right margin for viewing the line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardLinePlacement::GetOrientation

virtual void GetOrientation (TSingleLineOrientation &) const

Interface Category:

API.

Purpose:

Gets 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.

Member Function: TStandardLinePlacement::SetOrientation

virtual void SetOrientation (const TSingleLineOrientation &)

Interface Category:

API.

Purpose:

Sets the orientation of the line.

Calling Context:

Call to set the orientation of the line.

Parameters:

const TSingleLineOrientation & -The orientation of the line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardLinePlacement::~TStandardLinePlacement

virtual ~ TStandardLinePlacement ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TStandardLinePlacement::TStandardLinePlacement

TStandardLinePlacement (const GCoordinate & viewWidth)
TStandardLinePlacement (const TStandardLinePlacement &)

Interface Category:

API.

Purpose:

Creates a TStandardLinePlacement with a value specified for the right margin and all other values set to defaults.
Copy constructor.

Calling Context:

Called to create a TStandardLinePlacement with a value specified for the right margin and all other values set to defaults.
Called to copy an object.

Parameters:

const GCoordinate & viewWidth -The right margin for the view (the left margin defaults to 0).
const TStandardLinePlacement & -The object to copy.

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.