Class: TCommandStatusReceiver

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

Allows other objects to listen when a command is executed against the document. Such objects must provide a command status receiver.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive from this class to receive status on commands as they are processed. Derived classes can override any of the HandleXXX member functions to receive status on various phases of a command's execution.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCommandStatusReceiver::TCommandStatusReceiver

TCommandStatusReceiver ()
TCommandStatusReceiver (const TCommandStatusReceiver &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and directly.
Called to copy an object. You can also call this function directly.

Parameters:

Takes no parameters. Streaming constructor.
const TCommandStatusReceiver & -The receiver to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::~TCommandStatusReceiver

virtual ~ TCommandStatusReceiver ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. You can also call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::operator=

TCommandStatusReceiver & operator =(const TCommandStatusReceiver &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. You can also call this function directly.

Parameters:

TStream & towhere -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: TCommandStatusReceiver::operator<<=

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. You can also call this function directly.

Parameters:

TStream & fromwhere -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: TCommandStatusReceiver::BeforeDo

virtual void BeforeDo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called before calling Do on the command binding so that the status receiver can record (if necessary) the binding that will be used.

Calling Context:

Called by the TCompoundDocument immediately before calling Do on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that will get the Do message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::AfterDo

virtual void AfterDo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Do on the command binding, provided the call was successful. This is so that the status receiver can record (if necessary) the binding that was used successfully.

Calling Context:

Called by the TCompoundDocument immediately after calling Do on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that received the Do message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::FailDo

virtual void FailDo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Do and receiving a failure of some sort on the command binding so that the status receiver can record (if necessary) that the attempt to execute Do on the binding failed.

Calling Context:

Called by the TCompoundDocument immediately after calling Do on the command binding and getting a failure.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that got a failure when trying to process the Do message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::BeforeUndo

virtual void BeforeUndo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called before calling Undo on the command binding so that the status receiver can record (if necessary) the binding that will be used.

Calling Context:

Called by the TCompoundDocument immediately before calling Undo on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that will get the Undo message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::AfterUndo

virtual void AfterUndo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Undo on the command binding, provided the call was successful. This is so that the status receiver can record (if necessary) the binding that was used successfully.

Calling Context:

Called by the TCompoundDocument immediately after calling Undo on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that received the Undo message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::FailUndo

virtual void FailUndo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Undo and receiving a failure of some sort on the command binding so that the status receiver can record (if necessary) that the attempt to execute Undo on the binding failed.

Calling Context:

Called by the TCompoundDocument immediately after calling Undo on the command binding and getting a failure.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that got a failure when trying to process the Undo message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::BeforeRedo

virtual void BeforeRedo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called before calling Redo on the command binding so that the status receiver can record (if necessary) the binding that will be used.

Calling Context:

Called by the TCompoundDocument immediately before calling Redo on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that will get the Redo message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::AfterRedo

virtual void AfterRedo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Redo on the command binding, provided the call was successful. This is so that the status receiver can record (if necessary) the binding that was used successfully.

Calling Context:

Called by the TCompoundDocument immediately after calling Redo on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that received the Redo message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::FailRedo

virtual void FailRedo (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Redo and receiving a failure of some sort on the command binding so that the status receiver can record (if necessary) that the attempt to execute Redo on the binding failed.

Calling Context:

Called by the TCompoundDocument immediately after calling Redo on the command binding and getting a failure.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that got a failure when trying to process the Redo message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::BeforeDoBegin

virtual void BeforeDoBegin (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called before calling DoBegin on the command binding so that the status receiver can record (if necessary) the binding that will be used.

Calling Context:

Called by the TCompoundDocument immediately before calling DoBegin on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that will get the DoBegin message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::AfterDoBegin

virtual void AfterDoBegin (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling DoBegin on the command binding, provided the call was successful. This is so that the status receiver can record (if necessary) the binding that was used successfully.

Calling Context:

Called by the TCompoundDocument immediately after calling DoBegin on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that received the DoBegin message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::FailDoBegin

virtual void FailDoBegin (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling DoBegin and receiving a failure of some sort on the command binding so that the status receiver can record (if necessary) that the attempt to execute DoBegin on the binding failed.

Calling Context:

Called by the TCompoundDocument immediately after calling DoBegin on the command binding and getting a failure.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that got a failure when trying to process the DoBegin message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::BeforeDoIncrement

virtual void BeforeDoIncrement (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called before calling DoIncrement on the command binding so that the status receiver can record (if necessary) the binding that will be used.

Calling Context:

Called by the TCompoundDocument immediately before calling DoIncrement on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that will get the DoIncrement message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::AfterDoIncrement

virtual void AfterDoIncrement (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling DoIncrement on the command binding, provided the call was successful. This is so that the status receiver can record (if necessary) the binding that was used successfully.

Calling Context:

Called by the TCompoundDocument immediately after calling DoIncrement on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that received the DoIncrement message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::FailDoIncrement

virtual void FailDoIncrement (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling DoIncrement and receiving a failure of some sort on the command binding so that the status receiver can record (if necessary) that the attempt to execute DoIncrement on the binding failed.

Calling Context:

Called by the TCompoundDocument immediately after calling DoIncrement on the command binding and getting a failure.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that got a failure when trying to process the DoIncrement message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::BeforeDoEnd

virtual void BeforeDoEnd (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called before calling DoEnd on the command binding so that the status receiver can record (if necessary) the binding that will be used.

Calling Context:

Called by the TCompoundDocument immediately before calling DoEnd on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that will get the DoEnd message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::AfterDoEnd

virtual void AfterDoEnd (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling DoEnd on the command binding, provided the call was successful. This is so that the status receiver can record (if necessary) the binding that was used successfully.

Calling Context:

Called by the TCompoundDocument immediately after calling DoEnd on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that received the DoEnd message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::FailDoEnd

virtual void FailDoEnd (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling DoEnd and receiving a failure of some sort on the command binding so that the status receiver can record (if necessary) that the attempt to execute DoEnd on the binding failed.

Calling Context:

Called by the TCompoundDocument immediately after calling DoEnd on the command binding and getting a failure.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that got a failure when trying to process the DoEnd message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::BeforeCommit

virtual void BeforeCommit (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called before calling Commit on the command binding so that the status receiver can record (if necessary) the binding that will be used.

Calling Context:

Called by the TCompoundDocument immediately before calling Commit on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that will get the Commit message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::AfterCommit

virtual void AfterCommit (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Commit on the command binding, provided the call was successful. This is so that the status receiver can record (if necessary) the binding that was used successfully.

Calling Context:

Called by the TCompoundDocument immediately after calling Commit on the command binding.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that received the Commit message.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCommandStatusReceiver::FailCommit

virtual void FailCommit (TAbstractDocumentComponentCommandBinding &)

Interface Category:

API.

Purpose:

Called after calling Commit and receiving a failure of some sort on the command binding so that the status receiver can record (if necessary) that the attempt to execute Commit on the binding failed.

Calling Context:

Called by the TCompoundDocument immediately after calling Commit on the command binding and getting a failure.

Parameters:

TAbstractDocumentComponentCommandBinding & -The binding that got a failure when trying to process the Commit message.

Return Value:

None.

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.