Class: TBackgroundView

Declaration: LayoutViews.h

Taxonomy Categories:

Member Functions:

TBackgroundView
PlaceAndSizeChildren
DrawContents
GetBounds
operator<<=
operator>>=
operator=
~TBackgroundView

Interface Category:

API.

Inherits From:

TLayoutView

Inherited By:

None.

Purpose:

TBackgroundView derives from TLayoutView and provides a background (border) for a single child view.

Instantiation:

Always allocate on the heap.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TBackgroundView::TBackgroundView

TBackgroundView (const TGPoint & p, const TColor & c, TView * vievToAdopt =NIL)
TBackgroundView (const TGPoint & p, TGrafBundle * bundleToAdopt, TView * vievToAdopt =NIL)
TBackgroundView (const TGPoint & p, TView * vievToAdopt)
TBackgroundView();
TBackgroundView(const TBackgroundView &other);

Interface Category:

API.

Purpose:

Creates a background view for the specified subview with the specified background color.
Creates a background view for the specified subview with the specified graphics bundle.
Creates a background view for the specified subview.
Default constructor.
Copy constructor.

Calling Context:

Called to create a background for a specific view.
Called to create a background for a specific view.
Called to create a background for a specific view.
Called by the stream-in operators.
Called to copy an object.

Parameters:

const TGPoint & p -The size of the border.
const TColor & c -The color of the background.
TView * vievToAdopt =NIL -The first view to adopt.
const TGPoint & p -Size of border.
TGrafBundle * bundleToAdopt -The TGrafBundle to adopt for the background.
TView * vievToAdopt =NIL -The first view to adopt.
const TGPoint & p -Size of border.
TView * vievToAdopt =NIL -The first view to adopt.
Takes no parameters.
const TBackgroundView & other -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBackgroundView::PlaceAndSizeChildren

virtual void PlaceAndSizeChildren (const TGRect & area)

Interface Category:

API.

Purpose:

Positions and resizes children based on new allocated area.

Calling Context:

Called whenever the size of the view changes.

Parameters:

const TGRect & area -The new allocated area.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TBackgroundView::DrawContents

virtual void DrawContents (TGrafPort & port) const

Interface Category:

API.

Purpose:

Draws the contents of this view to the specified port. This function draws the background.

Calling Context:

Called when the layout view needs to redraw itself.

Parameters:

TGrafPort & port -The port to which to render the view.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TBackgroundView::GetBounds

virtual void GetBounds (TGArea & area) const

Interface Category:

API.

Purpose:

Returns the bounds of this view through the parameter. The bounds for TBackgroundView is size of its child view plus the size of the borders.

Calling Context:

Call from the same thread as the view. The area parameter should be created, but its value will be ignored, and the returned area will be returned through the parameter.

Parameters:

TGArea & area -The bounds of this view as returned by this function. Input value ignored.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TBackgroundView::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TBackgroundView::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream to which the object streams itself out.

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: TBackgroundView::operator=

TBackgroundView & operator =(const TBackgroundView & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

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

Parameters:

const TBackgroundView & other -The object to be copied.

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: TBackgroundView::~TBackgroundView

virtual ~ TBackgroundView ()

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.