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 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 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.
- TFrameBundle ()
- TFrameBundle (const TFrameBundle &)
- TFrameBundle (const TColor & frameColor, GCoordinate penWidth =1, TPen :: EPenBalance balance =TPen :: kCenterFrame)
- TFrameBundle (const TColor & frameColor, const TTransferMode & transferMode, GCoordinate penWidth =1, TPen :: EPenBalance balance =TPen :: kCenterFrame)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
- Creates a new frame bundle with the specified pen width and color.
- Creates a new frame bundle with the specified pen width, color, and transfer mode.
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 TFrameBundle & -The object to be copied.
- 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 & frameColor -The color for the frame.
- const TTransferMode & transferMode -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.
virtual ~ TFrameBundle ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TFrameBundle::operator=
TFrameBundle & operator =(const TFrameBundle &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
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: TFrameBundle::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: TFrameBundle::SetFrameTransferMode
void SetFrameTransferMode (const TTransferMode & transferMode)
Interface Category:
API.
Purpose:
Sets the transfer mode for the frame bundle. 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: TFrameBundle::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: TFrameBundle::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: TFrameBundle::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:
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: TFrameBundle::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:
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: TFrameBundle::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:
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: TFrameBundle::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:
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: TFrameBundle::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: TFrameBundle::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.
Copyright©1995 Taligent,Inc. All rights reserved.