Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TLocalAttributeState
Inherited By:
None.
Purpose:
TFillBundle is a derived class of TLocalAttributeState, and contains imaging information for 2-D graphic objects of the solid-filled, no 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 used for this type of graphic object 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).
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
None.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
- TFillBundle ()
- TFillBundle (const TFillBundle &)
- TFillBundle (const TColor & fillColor)
- TFillBundle (const TColor & fillColor, const TTransferMode & transferMode)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
- Creates a new fill bundle using a specified color.
- Creates a new fill bundle using a specified color and a transfer mode.
Calling Context:
- Called by the stream-in operators and can be called directly.
- Called to copy an object.
- Called when a fill bundle with a certain color fill is desired.
- Called when a fill bundle with a certain color and transfer mode fill is desired.
Parameters:
- Takes no parameters.
- const TFillBundle & -The object to be copied.
- const TColor & fillColor -The color for the fill area.
- const TColor & fillColor -The color for the fill area.
- const TTransferMode & transferMode -The transfer mode to be used.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TFillBundle ()
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: TFillBundle::operator=
TFillBundle & operator =(const TFillBundle &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
- const TFillBundle & -The object to be copied in the assignment.
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: TFillBundle::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: TFillBundle::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: TFillBundle::GetFillPaint
virtual const TPaint * GetFillPaint () const
Interface Category:
API.
Purpose:
Returns the paint object being used for this object.
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: TFillBundle::GetFillTransferMode
virtual const TTransferMode * GetFillTransferMode () const
Interface Category:
API.
Purpose:
Returns a pointer to the transfer mode being used by this object.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to the transfer mode for this object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TFillBundle::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: TFillBundle::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: TFillBundle::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.