Class: THairlineFrameBundle

Declaration: Bundles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLocalAttributeState

Inherited By:

None.

Purpose:

TFrameBundle is a derived class of TLocalAttributeState, and contains imaging information for 2-D graphic objects of the non-filled, framed (with a hairline) variety. Because it is derived from the local attribute bundle class, only those attributes pertinent to this form of graphic object need to be overridden. The frame attributes describe properties of the object's border. However, because a hairline pen is used here, the user need only be concerned with the paint information for the frame.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: THairlineFrameBundle::THairlineFrameBundle

THairlineFrameBundle ()
THairlineFrameBundle (const THairlineFrameBundle &)
THairlineFrameBundle (const TColor & frameColor)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates a hairline frame of a specified color.

Calling Context:

Called by the stream-in operators and can be called directly.
Called to copy an object.
Call this function directly.

Parameters:

Takes no parameters.
const THairlineFrameBundle & -The object to be copied.
const TColor & frameColor -The color for the hairline frame.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle::~THairlineFrameBundle

virtual ~ THairlineFrameBundle ()

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

THairlineFrameBundle & operator =(const THairlineFrameBundle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const THairlineFrameBundle & -The object 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: THairlineFrameBundle::SetFrameColor

void SetFrameColor (const TColor & color)

Interface Category:

API.

Purpose:

Sets the color for the frame.

Calling Context:

Call this function directly.

Parameters:

const TColor & color -The color for the frame.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle::GetFramePaint

virtual const TPaint * GetFramePaint () const

Interface Category:

API.

Purpose:

Returns the paint object being used for this frame.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Pointer to the paint object being used.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle::GetFramePen

virtual const TPen * GetFramePen () const

Interface Category:

API.

Purpose:

Gets the TPen object that is used for the rendering of the frame.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to this frame's TPen.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle::GetDrawingOperation

virtual EDrawOperation GetDrawingOperation () const

Interface Category:

API.

Purpose:

Returns the EDrawOperation that determines whether to paint the fill, the frame, or both.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The EDrawingOperation value of the bundle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream that 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:

Not multithread safe.

Other Considerations:

None.

Member Function: THairlineFrameBundle::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream that 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:

Not multithread safe.

Other Considerations:

None.

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