Class: TOrphanDataCommand

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

TOrphanDataCommand
operator=
~TOrphanDataCommand
operator>>=
operator<<=
HandleDoBegin
HandleUndo
HandleRedo
HandleCommitDone

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

TCutToClipboardCommand

Purpose:

Orphans data specified by a target model selection. This command uses the data exchange protocol implemented by model selections to orphan the data. 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: TOrphanDataCommand::TOrphanDataCommand

TOrphanDataCommand ()
TOrphanDataCommand (const TOrphanDataCommand &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TOrphanDataCommand & -The command to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOrphanDataCommand::operator=

TOrphanDataCommand & operator =(const TOrphanDataCommand &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual ~ TOrphanDataCommand ()

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

virtual void HandleDoBegin (MDataExchanger &)

Interface Category:

API.

Purpose:

Orphans the data selected by the target selection.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The target selection to orphan data from. The command calls OrphanData on the selection.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TOrphanDataCommand::HandleUndo

virtual void HandleUndo (MDataExchanger &)

Interface Category:

API.

Purpose:

Undoes the previous orphan data. The orphaned data is returned to the selection.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The target selection for undoing the orphan. UndoOrphanData is called with the model return from OrphanData.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TOrphanDataCommand::HandleRedo

virtual void HandleRedo (MDataExchanger &)

Interface Category:

API.

Purpose:

Redoes the orphan data.

Calling Context:

Called by TCommandOn.

Parameters:

MDataExchanger & -The target selection for redoing the orphan. Calls RedoOrphanData.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TOrphanDataCommand::HandleCommitDone

virtual void HandleCommitDone ()

Interface Category:

API.

Purpose:

Commits the command to a done state. The storage for the model owned by the command is deleted because the model will never be used again.

Calling Context:

Called by TCommandOn.

Parameters:

Takes no 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.