Class: TFillAndFrameBundle

Declaration: Bundles.h

Taxonomy Categories:

Member Functions:

TFillAndFrameBundle
~TFillAndFrameBundle
operator=
SetFillColor
SetFillTransferMode
SetFrameColor
SetFrameTransferMode
SetPenWidth
SetPenBalance
GetFillPaint
GetFillTransferMode
GetFramePaint
GetFrameTransferMode
GetFramePen
GetDrawingOperation
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

TLocalAttributeState

Inherited By:

None.

Purpose:

TFillAndFrameBundle is a derived class of TLocalAttributeState, and contains imaging information for 2-D graphic objects of the solid-filled, framed (with any size of frame) 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 fill attributes include the fill paint (which determines the color and pattern applied to a geometry's interior) and the transfer mode (which helps determine the actual color of the paint when the object is drawn). The frame attributes describe properties of the object's border; these include paint and transfer mode, as well as the styles of pen, starting cap, ending cap, and joint.

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

TFillAndFrameBundle ()
TFillAndFrameBundle (const TFillAndFrameBundle &)
TFillAndFrameBundle (const TColor & fillColor, const TColor & frameColor, GCoordinate penWidth =1, TPen :: EPenBalance balance =TPen :: kCenterFrame)
TFillAndFrameBundle (const TColor & fillColor, const TTransferMode & fillTransferMode, const TColor & frameColor, const TTransferMode & frameTransferMode, GCoordinate penWidth =1, TPen :: EPenBalance balance =TPen :: kCenterFrame)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates an attribute bundle with the specified values for the fill color, frame color, frame width (in pixels), and frame placement.
Creates an attribute bundle with the specified values for the fill color, frame color, frame width (in pixels), frame placement, and transfer modes for both the frame and fill region.

Calling Context:

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

Parameters:

Takes no parameters.
const TFillAndFrameBundle & -The object to be copied.
const TColor & fillColor -The color for the fill region.
const TColor & frameColor -The color for the frame.
GCoordinate penWidth =1 -The width, in pixels, of the frame.
TPen :: EPenBalance balance =TPen :: kCenterFrame -An enumeration tag specifying where, with respect to the edge of the graphic area, to render the frame.
const TColor & fillColor -The color for the fill region.
const TTransferMode & fillTransferMode -The transfer mode for the fill region.
const TColor & frameColor -The color for the frame.
const TTransferMode & frameTransferMode -The transfer mode for the frame.
GCoordinate penWidth =1 -The width, in pixels, of the frame.
TPen :: EPenBalance balance =TPen :: kCenterFrame -An enumeration tag specifying where, with respect to the edge of the graphic area, to render the frame.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFillAndFrameBundle::~TFillAndFrameBundle

virtual ~ TFillAndFrameBundle ()

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

TFillAndFrameBundle & operator =(const TFillAndFrameBundle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TFillAndFrameBundle & -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: TFillAndFrameBundle::SetFillColor

void SetFillColor (const TColor & color)

Interface Category:

API.

Purpose:

Sets the fill color for the object.

Calling Context:

Call this function directly.

Parameters:

const TColor & color -The color for the fill region.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFillAndFrameBundle::SetFillTransferMode

void SetFillTransferMode (const TTransferMode & transferMode)

Interface Category:

API.

Purpose:

Sets the transfer mode that determines the fill color. If a transfer mode is already defined for this object, it is deleted and replaced with the new transfer mode.

Calling Context:

Call this function directly.

Parameters:

const TTransferMode & transferMode -The new transfer mode to be used.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFillAndFrameBundle::SetFrameColor

void SetFrameColor (const TColor & color)

Interface Category:

API.

Purpose:

Sets the frame color for the graphic object.

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: TFillAndFrameBundle::SetFrameTransferMode

void SetFrameTransferMode (const TTransferMode & transferMode)

Interface Category:

API.

Purpose:

Sets the transfer mode that determines the frame color. If a transfer mode is already defined for this object, it is deleted and replaced with the new transfer mode.

Calling Context:

Call this function directly.

Parameters:

const TTransferMode & transferMode -The new transfer mode to be used.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFillAndFrameBundle::SetPenWidth

void SetPenWidth (GCoordinate penWidth)

Interface Category:

API.

Purpose:

Sets the pen width for the frame.

Calling Context:

Call this function directly.

Parameters:

GCoordinate penWidth -The width (in pixels) of the frame.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFillAndFrameBundle::SetPenBalance

void SetPenBalance (TPen :: EPenBalance balance)

Interface Category:

API.

Purpose:

Sets the pen balance for the frame. This specifies where, in relation to the edge of the rendered geometry, to render the frame. It can be drawn on the inside or outside of the geometry, or straddle the edge (when a value of kCenterFrame is used).

Calling Context:

Call this function directly.

Parameters:

TPen :: EPenBalance balance -The new balance value.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFillAndFrameBundle::GetFillPaint

virtual const TPaint * GetFillPaint () const

Interface Category:

API.

Purpose:

Returns the paint object being used for the fill region of this graphic object.

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: TFillAndFrameBundle::GetFillTransferMode

virtual const TTransferMode * GetFillTransferMode () const

Interface Category:

API.

Purpose:

Returns a pointer to the transfer mode being used by the fill region.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the transfer mode for the fill region.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFillAndFrameBundle::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: TFillAndFrameBundle::GetFrameTransferMode

virtual const TTransferMode * GetFrameTransferMode () const

Interface Category:

API.

Purpose:

Returns a pointer to the transfer mode being used by the frame of this graphic object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the transfer mode for this frame.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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