Class: TComponentArea

Declaration: GUICompoundDocumentEmbedder.h

Taxonomy Categories:

Member Functions:

TComponentArea
~TComponentArea
GetArea
SetArea
GetComponent
OrphanComponent
Hash
operator=
operator==
operator!=
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TComponentArea is a wrapper for a TDocumentComponent that provides an area to be used to layout the component in a frame view. TGUIEmbedderModel manages a list of TComponentArea to manage its embedded components. The specific use of the area is up to the client, but typically it is used to manage the allocated area in parent for frame view's on the component.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Classes that need to add additional information to be associated with a document component derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TComponentArea::TComponentArea

TComponentArea ()
TComponentArea (TDocumentComponent * componentToAdopt)
TComponentArea (TDocumentComponent * componentToAdopt, const TGArea & theArea)
TComponentArea (const TComponentArea &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a component area for a specific component.
Creates a component area for a specific component with an initial area.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
TDocumentComponent * componentToAdopt -The component to adopt.
TDocumentComponent * componentToAdopt -The component to adopt.
const TGArea & theArea -The initial area for component layout.
const TComponentArea & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::~TComponentArea

~ TComponentArea ()

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: TComponentArea::GetArea

TGArea GetArea () const

Interface Category:

API.

Purpose:

Gets the area associated with the component. The area is typically used to manage a component frame view's allocated area in parent.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the current area for the component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::SetArea

void SetArea (const TGArea & theArea)

Interface Category:

API.

Purpose:

Sets the area associated with the component. The area is typically used to manage a component frame view's allocated area in parent.

Calling Context:

Called by any client object.

Parameters:

const TGArea & theArea -The new area to set for the component.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::GetComponent

TDocumentComponent * GetComponent ()
const TDocumentComponent * GetComponent () const

Interface Category:

API.

Purpose:

Returns the component owned by this component area.
Returns a const pointer to the component owned by this component area.

Calling Context:

Called by any client object.
Called by any client object.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the component owned by this area.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::OrphanComponent

TDocumentComponent * OrphanComponent ()

Interface Category:

API.

Purpose:

Orphans the component owned by this area. This component area no long references any component. The component is owned by the caller.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the orphaned component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::Hash

HashResult Hash () const

Interface Category:

API.

Purpose:

Provides a hash value for use in collections.

Calling Context:

Called by collection classes.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value for this object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::operator=

TComponentArea & operator =(const TComponentArea &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TComponentArea & -The right-hand side object.

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

bool operator ==(const TComponentArea &) const

Interface Category:

API.

Purpose:

Compares this component area against another for equality.

Calling Context:

Called by any client object.

Parameters:

const TComponentArea & -The right-hand side object.

Return Value:

Returns true if this component area has the same area and same component as the other. This is only true if they are the same component area.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::operator!=

bool operator != (const TComponentArea &) const

Interface Category:

API.

Purpose:

Compares this component area against another for inequality.

Calling Context:

Called by any client object.

Parameters:

const TComponentArea & -The right-hand side object.

Return Value:

Returns true if this component area has a different area or component than the other.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentArea::operator>>=

TStream & operator >>=(TStream & towhere) 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: TComponentArea::operator<<=

TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -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.

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