Class: TBackground

Declaration: Decoration.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TBorder

Inherited By:

None.

Purpose:

TBackground derives from TBorder. It adds nothing to what TBorder already provides. All it does is change the defaults so that the border is a filled rectangle.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Deriving from TBackground is not intended; derive directly from TBorder instead.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TBackground::operator=

TBackground & operator =(const TBackground & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TBackground & source -The source object for the assignment.

Return Value:

Returns a 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: TBackground::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -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:

Not multithread safe.

Other Considerations:

None.

Member Function: TBackground::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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:

Not multithread safe.

Other Considerations:

None.

Member Function: TBackground::TBackground

TBackground ()
TBackground (const TGRect & bounds, GCoordinate thickness =kDefaultThickness, bool interior =TBackground :: kDefaultInteriorState)
TBackground (const TGRect & bounds, const TPaint & fill, GCoordinate thickness =kDefaultThickness, bool interior =TBackground :: kDefaultInteriorState)
TBackground (const MGraphic & bounds, GCoordinate thickness =kDefaultThickness, bool interior =TBackground :: kDefaultInteriorState)
TBackground (const MGraphic & bounds, const TPaint & fill, GCoordinate thickness =kDefaultThickness, bool interior =TBackground :: kDefaultInteriorState)
TBackground (const TView & bounds, GCoordinate thickness =kDefaultThickness, bool interior =TBackground :: kDefaultInteriorState)
TBackground (const TView & bounds, const TPaint & fill, GCoordinate thickness =kDefaultThickness, bool interior =TBackground :: kDefaultInteriorState)
TBackground (const TBackground & copy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TGRect & bounds -The outer bounds of the new border.
GCoordinate thickness =kDefaultThickness -The thickness of the new border.
bool interior =kDefaultInteriorState -Specifies whether the border has an interior.
const TGRect & bounds -The outer bounds of the new border.
const TPaint & fill -The fill paint of the new border.
GCoordinate thickness =kDefaultThickness -The thickness of the new border.
bool interior =kDefaultInteriorState -Specifies whether the border has an interior.
const MGraphic & bounds -The MGraphic object from which to derive the bounds of the new border.
GCoordinate thickness =kDefaultThickness -The thickness of the new border.
bool interior =kDefaultInteriorState -Specifies whether the border has an interior.
const MGraphic & bounds -The MGraphic object from which to derive the bounds of the new border.
const TPaint & fill -The fill paint of the new border.
GCoordinate thickness =kDefaultThickness -The thickness of the new border.
bool interior =kDefaultInteriorState -Specifies whether the border has an interior.
const TView & bounds -The TView object from which to derive the bounds of the new border.
GCoordinate thickness =kDefaultThickness -The thickness of the new border.
bool interior =kDefaultInteriorState -Specifies whether the border has an interior.
const TView & bounds -The TView object from which to derive the bounds of the new border.
const TPaint & fill -The fill paint of the new border.
GCoordinate thickness =kDefaultThickness -The thickness of the new border.
bool interior =kDefaultInteriorState -Specifies whether the border has an interior.
const TBackground & copy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBackground::~TBackground

virtual ~ TBackground ()

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.

Click the icon to mail questions or corrections about this material to Taligent personnel.