Class: TAdoptAnchorCommand

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

Adopts a new anchor into a model. The anchor must be an anchor on the target model. This command supports undo and redo of the operation.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TAdoptAnchorCommand::TAdoptAnchorCommand

TAdoptAnchorCommand (TModelAnchor * anchorToAdopt)
TAdoptAnchorCommand (const TAdoptAnchorCommand &)
TAdoptAnchorCommand ()

Interface Category:

API.

Purpose:

Constructs a command with an anchor to adopt into a model.
Copy constructor.
Default constructor.

Calling Context:

Called to create new command.
Called to copy command.
Called by the stream-in operators and derived classes.

Parameters:

TModelAnchor * anchorToAdopt -The anchor to be adopted into model.
const TAdoptAnchorCommand & -The command to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Postconditions:

Assert (GetAnchor() != NIL)

Member Function: TAdoptAnchorCommand::operator=

TAdoptAnchorCommand

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAdoptAnchorCommand & -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: TAdoptAnchorCommand::~TAdoptAnchorCommand

virtual ~ TAdoptAnchorCommand ()

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: TAdoptAnchorCommand::GetAnchor

virtual TModelAnchor * GetAnchor ()

Interface Category:

API.

Purpose:

Provides access to the anchor to be adopted into the model.

Calling Context:

No special requirements.

Parameters:

Takes no parameters.

Return Value:

Returns the anchor that the command will adopt into the model. Returns NIL after command has been done or redone.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAdoptAnchorCommand::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: TAdoptAnchorCommand::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: TAdoptAnchorCommand::HandleDoBegin

virtual void HandleDoBegin (TModelSelection &)

Interface Category:

API.

Purpose:

Called to do the command. The anchor is adopted into the target model.

Calling Context:

Called only by TCommand.

Parameters:

TModelSelection & -The selection on model into which the anchor will be adopted.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAdoptAnchorCommand::HandleUndo

virtual void HandleUndo (TModelSelection &)

Interface Category:

API.

Purpose:

Called to undo the command. The previously adopted anchor is orphaned from the target model.

Calling Context:

Called only by TCommand.

Parameters:

TModelSelection & -The selection on model from which the anchor is orphaned.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAdoptAnchorCommand::HandleRedo

virtual void HandleRedo (TModelSelection &)

Interface Category:

API.

Purpose:

Called to redo the command. Same as HandleDoBegin.

Calling Context:

Called only by TCommand.

Parameters:

TModelSelection & -The selection on model to which the anchor will be adopted.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

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