Class: TLabelLinePlacement

Declaration: LineLayout.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLinePlacement

Inherited By:

None.

Purpose:

Derived from TLinePlacement, used to indicate the position of a label on a line.

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: TLabelLinePlacement::SetLineMinMaxWidths

virtual void SetLineMinMaxWidths (GCoordinate minWidth, GCoordinate maxWidth)

Interface Category:

API.

Purpose:

Sets the line's minimum and maximum widths.

Calling Context:

Call to set the line's minimum and maximum widths.

Parameters:

GCoordinate minWidth -The minimum width.
GCoordinate maxWidth -The maximum width.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

This will default to left. The line will be aligned relative to the line (0, 0) origin point.

Member Function: TLabelLinePlacement::operator=

TLabelLinePlacement & operator =(const TLabelLinePlacement &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TLabelLinePlacement & -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: TLabelLinePlacement::operator==

virtual int operator ==(const TLabelLinePlacement &) const

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Call to compare two instances of this class.

Parameters:

const TLabelLinePlacement & -The object to compare with 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: TLabelLinePlacement::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: TLabelLinePlacement::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: TLabelLinePlacement::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: TLabelLinePlacement::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: TLabelLinePlacement::GetLineMinMaxWidths

virtual void GetLineMinMaxWidths (GCoordinate & minWidth, GCoordinate & maxWidth) const

Interface Category:

API.

Purpose:

Returns the line's minimum and maximum widths.

Calling Context:

Call to access this information.

Parameters:

GCoordinate & minWidth -The minimum width.
GCoordinate & maxWidth -The maximum width.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLabelLinePlacement::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.

Member Function: TLabelLinePlacement::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: TLabelLinePlacement::~TLabelLinePlacement

virtual ~ TLabelLinePlacement ()

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

TLabelLinePlacement ()
TLabelLinePlacement (const TSingleLineOrientation &)
TLabelLinePlacement (GCoordinate minWidth, GCoordinate maxWidth, const TSingleLineOrientation &)
TLabelLinePlacement (const TLabelLinePlacement &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TLabelLinePlacement instance with a specified line orientation.
Creates a TLabelLinePlacement instance with a specified line orientation, minimum width, and maximum width.
Copy constructor.

Calling Context:

Called by the stream-in operators and to instantiate this class.
Call directly.
Call directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TSingleLineOrientation & -The orientation to use for this line.
GCoordinate minWidth -The minimum width for this line.
GCoordinate maxWidth -The maximum width for this line.
const TSingleLineOrientation & -The orientation to use for this line.
const TLabelLinePlacement & -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.