Class: TRoundCap

Declaration: GrafCaps.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCap

Inherited By:

None.

Purpose:

TRoundCap implements a round cap. A round cap puts a semicircle at the start or end point of the geometry. TRoundCap is derived directly from TCap.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRoundCap::TRoundCap

TRoundCap ()
TRoundCap (const TRoundCap &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TRoundCap & -The round cap to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRoundCap::~TRoundCap

virtual ~ TRoundCap ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TRoundCap::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & stream -The stream to which the object streams itself out.

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: TRoundCap::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

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: TRoundCap::operator=

TRoundCap & operator =(const TRoundCap & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TRoundCap & source -The round cap to be copied.

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: TRoundCap::AdjustBounds

virtual TGRect AdjustBounds (const TGRect & currentBounds, const TPen * pen =NIL) const

Interface Category:

Same as the Class

Purpose:

Adjusts the size of the bounding rectangle to account for the round cap.

Calling Context:

Call this function directly.

Parameters:

const TGRect & currentBounds -The bounding rectangle to adjust.
const TPen * pen =NIL -The pen to be used in the adjusting process.

Return Value:

A TGRect that is the modified version of the rectangle passed as the current bounds.

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.