Class: TRaisedBorder

Declaration: Decoration.h

Taxonomy Categories:

Member Functions:

~TRaisedBorder
operator=
operator>>=
operator<<=
CalculateInsets
CalculateClipPart
TRaisedBorder

Interface Category:

API.

Inherits From:

TRecessedBorder

Inherited By:

TRaisedBackground

Purpose:

TRaisedBorder is simply an upside-down TRecessedBorder. It simply reverses the highlighting and shadowing drawn in the recessed border to give the border a raised appearance.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive from TRaisedBorder to add further to the border decoration.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRaisedBorder::~TRaisedBorder

virtual ~ TRaisedBorder ()

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.

Member Function: TRaisedBorder::operator=

TRaisedBorder & operator =(const TRaisedBorder &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TRaisedBorder & -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: TRaisedBorder::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: TRaisedBorder::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 TInvalidVersionError if the object has detected an unsupportable version during the stream-in process.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRaisedBorder::CalculateInsets

virtual void CalculateInsets (GDegrees angle, TGRect & highlight, TGRect & groove) const >Interface Category: API.

Purpose:

Returns the reverse insets from TRecessedBorder, so that the TRecessedBorder draws the highlights and shadows the other way around. This reverses the illusion and makes the border look raised.

Calling Context:

Called directly by friend classes or classes deriving from TRaisedBorder.

Parameters:

GDegrees angle -The angle by which this border has been rotated.
TGRect & highlight -The position of the highlight lines relative to the shadow. For example, (0, 0, -1, -1) puts the highlight over the top of the shadow on the top left, and inside the shadow on the bottom right.
TGRect & groove -The position of the groove lines.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected and overrides TRecessedBorder's function of the same name.

Member Function: TRaisedBorder::CalculateClipPart

virtual EClipPart CalculateClipPart (GDegrees angle) const

Interface Category:

API.

Purpose:

Calculates how to clip the highlight during drawing, given the angle of rotation. Because CalculateInsets reverses the insets calculated by TRecessedBorder, the clip parts have to be reversed also.

Calling Context:

Called directly by friend classes or classes deriving from TRaisedBorder.

Parameters:

GDegrees angle -The angle by which this border has been rotated.

Return Value:

Returns an EClipPart value that indicates the part to clip out while drawing the highlight.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected and overrides TRecessedBorder's function of the same name.

Member Function: TRaisedBorder::TRaisedBorder

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

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 TRaisedBorder & -The object to copy.

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.