Class: TOrphanAnchorCommand

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

Orphans an existing anchor from a model. This command supports undo and redo operations.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TOrphanAnchorCommand::TOrphanAnchorCommand

  1. TOrphanAnchorCommand (const TModelAnchorReference &)
  2. TOrphanAnchorCommand (const TOrphanAnchorCommand &)
  3. TOrphanAnchorCommand ()

Interface Category:

API.

Purpose:

  1. Creates a command to orphan a specific anchor.
  2. Copy constructor
  3. Default constructor.

Calling Context:

  1. Call this function directly.
  2. Called to copy command.
  3. Called by the stream-in operators and derived classes

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOrphanAnchorCommand::operator=

TOrphanAnchorCommand & operator =(const TOrphanAnchorCommand &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual ~ TOrphanAnchorCommand ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOrphanAnchorCommand::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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: TOrphanAnchorCommand::HandleDoBegin

virtual void HandleDoBegin (TModelSelection &)

Interface Category:

API.

Purpose:

Does the command. Orphans an existing anchor from a model.

Calling Context:

Called only by TCommand.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TOrphanAnchorCommand::HandleUndo

virtual void HandleUndo (TModelSelection &)

Interface Category:

API.

Purpose:

Undoes the command. Adopts the orphaned anchor back into the model.

Calling Context:

Called only by TCommand.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TOrphanAnchorCommand::HandleRedo

virtual void HandleRedo (TModelSelection &)

Interface Category:

API.

Purpose:

Redoes the command. Same as HandleDoBegin.

Calling Context:

Called only by TCommand.

Parameters:

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.
Copyright©1995 Taligent,Inc. All rights reserved.