Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TLineLayoutStyle
Inherited By:
TBackgroundStyle
TLineStyle
TTextColorStyle
Purpose:
TColorStyle, derived from TLineLayoutStyle, is a style used for associating a TFillBundle with text.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
TColorStyle is abstract and must be derived to associate the TFillBundle value with a higher concept.
Concurrency:
Multithread safe.
Resource Use:
No special requirements.
Member Function: TColorStyle::operator=
TColorStyle & operator =(const TColorStyle &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
- const TColorStyle & -The source object for the assignment.
Return Value:
A non-const reference to the left-hand side object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TColorStyle::GetName
virtual const TStyleName & GetName () const
Interface Category:
API.
Purpose:
Returns the style's internal name. This is not necessarily the class name. For example, there are related underlining styles that are each separate derived classes. However, because they are mutually exclusive, they share the same internal name.
Calling Context:
Called when the name associated with an object is needed; for example, when comparing objects.
Parameters:
Return Value:
The TToken for the associated name.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual ~ TColorStyle ()
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:
Multithread safe.
Other Considerations:
None.
Member Function: TColorStyle::operator<<=
virtual TStream & operator <<= (TStream & fromWhere)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & fromWhere -The stream 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:
Multithread safe.
Other Considerations:
None.
Member Function: TColorStyle::operator>>=
virtual TStream & operator >>=(TStream & toWhere) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & toWhere -The stream 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:
Multithread safe.
Other Considerations:
None.
Member Function: TColorStyle::operator==
virtual bool operator ==(const TStyle & thatStyle) const
Interface Category:
API.
Purpose:
Equality operator.
Calling Context:
Called to compare two objects.
Parameters:
- const TStyle & thatStyle -The object to compare with this object.
Return Value:
Returns true if the objects are equal.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TColorStyle::Hash
virtual long Hash () const
Interface Category:
API.
Purpose:
Overrides inherited MCollectible function.
Calling Context:
Same as for base class.
Parameters:
Return Value:
The numeric value of the hash.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TColorStyle::SetDefault
virtual void SetDefault ()
Interface Category:
API.
Purpose:
Assigns the system default color to this style.
Calling Context:
Call to set the system default color on this style.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
virtual void Set (const TAttributeState & paint)
Interface Category:
API.
Purpose:
Sets the color for this style object.
Calling Context:
Called by derived classes to set the color for this style object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
- TColorStyle (const TAttributeState & paint)
- TColorStyle (const TColorStyle & paint)
- TColorStyle ()
Interface Category:
API.
Purpose:
- Instantiates this style class with a specified value.
- Copy constructor.
- Default constructor.
Calling Context:
- Call to instantiate a style object with a particular value.
- Called to copy an object.
- Called by the stream-in operators.
Parameters:
- const TAttributeState & paint -The color to assign to this style object.
- const TColorStyle & paint -The object to copy.
- Takes no parameters.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TColorStyle::GetColor
- virtual void GetColor (TGrafBundle & color) const
- virtual const TAttributeState & GetColor () const
Interface Category:
API.
Purpose:
- Returns the color associated with this style object as a TGrafBundle.
- Returns the color associated with this style object as a TAttributeState.
Calling Context:
- Used to obtain the color associated with this object instance.
- Used to obtain the color associated with this object instance.
Parameters:
- TGrafBundle & color -Filled in with the color associated with this style object.
- Takes no parameters.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
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.