![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TAttributeState
Inherited By:
TFillAndFrameBundle
TFillAndHairlineFrameBundle
TFillBundle
TFrameBundle
THairlineFrameBundle
TGUIPaintsBundle
Purpose:
This is a class that provides the default of no attribute for all attributes. It is provided as a convenience for derived classes of TAttributeState that provide a subset of local attributes. Member functions are to be overridden only for the local attributes that are present.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Examples of provided derived classes are TSolidFillBundle, TFillBundle, THairlineBundle, THairlineFillBundle, TFrameBundle, and TFrameAndFillBundle. This base class must be used to create derived classes. Only override the member functions that do something different from this class.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
- TLocalAttributeState ()
- TLocalAttributeState (const TLocalAttributeState &)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
Calling Context:
- Called by the stream-in operators and can be called directly.
- Called to copy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TLocalAttributeState ()
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.
TLocalAttributeState & operator =(const TLocalAttributeState &)
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.
virtual const TPaint * GetFillPaint () const
Interface Category:
API.
Purpose:
Returns the paint used for the surface fill operations. This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TPaint object that specifies the color or pattern to be used by the kFill drawing operation.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TPaint * GetFramePaint () const
Interface Category:
API.
Purpose:
Returns the paint used for the frame drawing operations. This is a pure virtual function that must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TPaint object that specifies the color or pattern to be used by the kFrame drawing operation.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TTransferMode * GetFillTransferMode () const
Interface Category:
API.
Purpose:
Returns the transfer mode (such as TSrcCopyTransferMode) to be used during a fill drawing operation. This is a pure virtual function that must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TTransferMode object that represents the transfer mode to be used during a kFill drawing operation.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TTransferMode * GetFrameTransferMode () const
Interface Category:
API.
Purpose:
Returns the transfer mode (such as TSrcCopyTransferMode) to be used during a frame drawing operation. This is a pure virtual function that must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TTransferMode object that represents the transfer mode to be used during a kFrame drawing operation.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TJoint * GetFrameJoint () const
Interface Category:
API.
Purpose:
Returns the joint (such as TBevelJoint) to be used to smooth out the discontinuities which occur at the intersection of two line segments. This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TJoint object that represents the joint to be used at the intersection of two line segments.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TCap * GetFrameEndCap () const
Interface Category:
API.
Purpose:
Returns the cap (such as TFlushCap) to be used at the end of a line or geometry path. This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TCap object that represents the cap to be used at the end of a line or geometry path.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TCap * GetFrameStartCap () const
Interface Category:
API.
Purpose:
Returns the cap (such as TFlushCap) to be used at the start of a line or geometry path. This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TCap object that represents the cap to be used at the start of a line or geometry path.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TPen * GetFramePen () const
Interface Category:
API.
Purpose:
Returns the pen (such as THairlinePen) to be used to draw the frame model of the graphic. This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TPen object that represents the pen to be used by the kFrame drawing operation.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual EDrawOperation GetDrawingOperation () const
Interface Category:
Returns the drawing operation specified by the attribute state. The return value is one of the EDrawOperation types (kFill, kFrame, or kFillAndFrame). This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A pointer to an EDrawOperation enumerated type that represents the drawing operation specified by this attribute state.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
API.
Other Considerations:
None.
virtual const TImageSamplingControl * GetImageSampling () const
Interface Category:
API.
Purpose:
Returns the image sampling to be done when the graphic is either interpolated (enlarged) or decimated (shrunk). How an image is sampled prior to interpolation or decimation is specified in a TImageSampleControl object. This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TImageSamplingControl object that determines how an image will be sampled prior to interpolation or decimation.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TTransferMode * GetImageTransferMode () const
Interface Category:
API.
Purpose:
Returns the image transfer mode (such as TSrcCopyTransferMode) that determines how the colors of the image are modified when placed at the destination.
Calling Context:
Call this function directly.
Parameters:
Return Value:
A constant pointer to a TTransferMode object that represents how the image colors are transferred to the destination.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TDitherHint * GetPrimaryDitherHint () const
Interface Category:
API.
Purpose:
Returns a pointer to the current dither hint for this attribute bundle.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the pointer to this attribute bundle's primary dither hint.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const TGrafAttribute * GetGrafAttribute ( const TToken & key) const
Interface Category:
API.
Purpose:
Returns the TGrafAttribute object that is associated with the key. TGrafAttribute objects are custom attributes that you install into the bundle. This is a pure virtual function which must be overridden by derived classes.
Calling Context:
Call this function directly.
Parameters:
- const TToken & key -The name of the attribute class to be retrieved.
Return Value:
A constant pointer to the TGrafAttribute object associated with the name that is passed in as a key.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
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.
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.