Class: TGUIEmbedderModel

Declaration: GUICompoundDocumentEmbedder.h

Taxonomy Categories:

Member Functions:

TGUIEmbedderModel
~TGUIEmbedderModel
CreateSelection
DeleteAll
Adopt
Orphan
LookupComponent
CreateComponentIterator
SetComponentArea
GetAddedComponentInterest
GetRemovedComponentInterest
GetComponentAreaChangedInterest
operator=
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

TModel

Inherited By:

None.

Purpose:

TGUIEmbedderModel is a very simple embedder model that maintains a list of TComponentArea. Each component area manages a component and an area for that component that is used to layout the component's frame view in a TGUIEmbedderModelContentView.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None. A derived class may provide member functions to access/modify data.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::TGUIEmbedderModel

TGUIEmbedderModel ()
TGUIEmbedderModel (const TGUIEmbedderModel &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TGUIEmbedderModel & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::~TGUIEmbedderModel

virtual ~ TGUIEmbedderModel ()

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: TGUIEmbedderModel::CreateSelection

virtual TModelSelection * CreateSelection () const

Interface Category:

API.

Purpose:

Creates a selection on this model.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the selection. The real type is TGUIEmbedderModelSelection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::DeleteAll

virtual void DeleteAll ()

Interface Category:

API.

Purpose:

Deletes all the components in the model. Deleting components in this way is not undoable, so this is not usually used for models that are part of a document hierarchy.

Calling Context:

Called by any client 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: TGUIEmbedderModel::Adopt

virtual void Adopt (TComponentArea *)

Interface Category:

API.

Purpose:

Adopts a component area into the model. A TDocumentComponentNotification is generated with GetAddedComponentInterest.

Calling Context:

Called by any client object.

Parameters:

TComponentArea * -The component area to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::Orphan

virtual TComponentArea * Orphan (TComponentArea &)

Interface Category:

API.

Purpose:

Orphans a component are from the model. A TDocumentComponentNotification is generated with GetRemovedComponentInterest().

Calling Context:

Called by any client object.

Parameters:

TComponentArea & -The component area to be orphaned.

Return Value:

Returns the orphaned component area.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::LookupComponent

virtual TComponentArea * LookupComponent (const TDocumentComponentReference &)
virtual const TComponentArea * LookupComponent (const TDocumentComponentReference &) const

Interface Category:

API.

Purpose:

Looks up a component area given a component reference.
Looks up a component area given a component reference.

Calling Context:

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

Parameters:

const TDocumentComponentReference & -The component to look up.
const TDocumentComponentReference & -The component to look up.

Return Value:

Returns the found component.

Exceptions:

Throws TCompoundDocumentException::kComponentDoesNotExist if component is not in model. All other exceptions are passed through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::CreateComponentIterator

virtual TIteratorOver < TComponentArea > * CreateComponentIterator () const

Interface Category:

API.

Purpose:

Creates an iterator over all the component areas in this model.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns an iterator over all the embedded component areas.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::SetComponentArea

virtual void SetComponentArea (const TDocumentComponentReference &, const TGArea &)

Interface Category:

API.

Purpose:

Sets the area associated with a component embedded in this model. A TDocumentComponentArea is generated with GetComponentAreaChangedInterest().

Calling Context:

Called by any client object.

Parameters:

const TDocumentComponentReference & -The reference to the component to change the area for.
const TGArea & -The new area for the component.

Return Value:

None.

Exceptions:

Throws TCompoundDocumentException::kComponentDoesNotExist if component is not in model. All other exceptions are passed through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::GetAddedComponentInterest

TModelInterest GetAddedComponentInterest () const

Interface Category:

API.

Purpose:

Returns an interest in notifications on components being added to the model. Notifications are TDocumentComponentNotification.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the new interest object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::GetRemovedComponentInterest

TModelInterest GetRemovedComponentInterest () const

Interface Category:

API.

Purpose:

Returns an interest in notifications on components being removed from the model. Notifications are TDocumentComponentNotification.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the new interest object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::GetComponentAreaChangedInterest

TModelInterest GetComponentAreaChangedInterest () const

Interface Category:

API.

Purpose:

Returns an interest in the area of a component being changed. Notifications are TDocumentComponentNotification.

Calling Context:

Called by any client object.

Parameters:

Takes no parameters.

Return Value:

Returns the new interest object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGUIEmbedderModel::operator=

TGUIEmbedderModel & operator =(const TGUIEmbedderModel &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TGUIEmbedderModel & -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: TGUIEmbedderModel::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: TGUIEmbedderModel::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.

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