Class: TComponentAreaRectControlState

Declaration: GUICompoundDocumentEmbedder.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRectControlState

Inherited By:

None.

Purpose:

TComponentAreaRectControlState is a rect control state that uses commands to act on MEmbeddedComponentAccessor to modify the the component's area in the model based on changes to the control's rect. The state is usually used with a TFrameView.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::TComponentAreaRectControlState

TComponentAreaRectControlState ()
TComponentAreaRectControlState (const TDocumentComponentReference &, TGUIBundle * theBundleToAlias)
TComponentAreaRectControlState (const TComponentAreaRectControlState &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a control state for a specific component and presenter.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TDocumentComponentReference & -The component to control.
TGUIBundle * theBundleToAlias -The presenter's bundle.
const TComponentAreaRectControlState & -The state to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::~TComponentAreaRectControlState

~ TComponentAreaRectControlState ()

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: TComponentAreaRectControlState::GetGUIBundle

TGUIBundle * GetGUIBundle () const

Interface Category:

API.

Purpose:

Returns the GUIBundle of the presenter that owns this state's control.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the bundle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::SetGUIBundle

void SetGUIBundle (TGUIBundle * theBundleToAlias)

Interface Category:

API.

Purpose:

Sets the GUIBundle of the presenter that owns this state's control

Calling Context:

Called by any client object.

Parameters:

TGUIBundle * theBundleToAlias -The bundle to set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::GetDocumentComponentReference

TDocumentComponentReference GetDocumentComponentReference () const

Interface Category:

API.

Purpose:

Returns a reference to the component this state controls.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the component reference.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::SetDocumentComponentReference

void SetDocumentComponentReference (const TDocumentComponentReference &)

Interface Category:

API.

Purpose:

Sets the reference to the component that this control state controls. This must be the same component the this state's control (frame view) presents.

Calling Context:

Called by any client object.

Parameters:

const TDocumentComponentReference & -The component to control.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::IsSelected

virtual bool IsSelected () const

Interface Category:

API.

Purpose:

Determines if the embedded component control by this state is selected.

Calling Context:

Called by Controls Framework.

Parameters:

Takes no parameters.

Return Value:

Returns true if the component is selected.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::GetRect

virtual TGRect GetRect () const

Interface Category:

API.

Purpose:

Returns the rectangle from the component this state controls. The rectangle is the bounding rectangle of the component's area.

Calling Context:

Called by control.

Parameters:

Takes no parameters.

Return Value:

Returns the components bounding rectangle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::IntermediateSetRect

virtual void IntermediateSetRect (const TGRect &)

Interface Category:

API.

Purpose:

Sets the area of the component this state controls to an intermediate rectangular value.

Calling Context:

Called by the control.

Parameters:

const TGRect & -The rect to set as the area of the component.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::FinalSetRect

virtual void FinalSetRect (const TGRect &)

Interface Category:

API.

Purpose:

Sets the area of the component this state controls to the final rectangular value.

Calling Context:

Called by the control.

Parameters:

const TGRect & -The rect to set as the area of the component.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::Update

virtual void Update (const TInterest &)

Interface Category:

API.

Purpose:

Updates the state based on a notification from the model containing the component this state controls. Does nothing.

Calling Context:

Called by the control.

Parameters:

const TInterest & -The interest from the notification.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::AddInterests

virtual void AddInterests (TSetOf < TInterest > & set)

Interface Category:

API.

Purpose:

Adds to the control's interest list any interests this state needs to remain in sync with the component area. Adds TGUIEmbedderModel::GetComponentAreaChangeInterest().

Calling Context:

Called by the control.

Parameters:

TSetOf < TInterest > & set -The set to fill with the returned interests.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TComponentAreaRectControlState::operator=

TComponentAreaRectControlState & operator =(const TComponentAreaRectControlState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TComponentAreaRectControlState & -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: TComponentAreaRectControlState::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this object. The hash value is used to speed comparisons.

Calling Context:

Called by collection classes.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value.

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.