Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
TCommandOn
Purpose:
TCommonCommand is a private base class for TCommandOn<ATarget>. The member functions and enumerated types listed are exported to TCommandOn's public interface.
Instantiation:
Abstract base class; do not allocate.
Deriving Classes:
This is a private class; do not derive from this class; rather, use TCommandOn.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Member Function: TCommonCommand::GetUndoType
UndoType GetUndoType () const
Interface Category:
API.
Purpose:
Returns a copy of the undo type of the command. The undo type is immutable.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a copy of the undo type of the command.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
State GetState () const
Interface Category:
API.
Purpose:
Returns a copy of the state of the command.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns a copy of the state of the command.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::SupportsUndo
bool SupportsUndo () const
Interface Category:
API.
Purpose:
Indicates if the command provides support for undo.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if undo type <> kCantUndo.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::ChangesTarget
bool ChangesTarget () const
Interface Category:
API.
Purpose:
Indicates if the command modifies the target. A return value of false indicates the command does not effect the target. Commands, such as print, which do not effect the target will not require logging.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if undo type <> kNoChange.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::IsThisIncrementRequired
bool IsThisIncrementRequired () const
Interface Category:
API.
Purpose:
Indicates if the value of this increment of the command is necessary for reconstructing the command's execution.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns true if HandleIsThisIncrementRequired returns true.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::StreamOutIncrementDelta
void StreamOutIncrementDelta (TStream & stream) const
Interface Category:
API.
Purpose:
Streams the change from a DoIncrement.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::StreamInIncrementDelta
void StreamInIncrementDelta (TStream & stream)
Interface Category:
API.
Purpose:
Restores the effect of a DoIncrement from a stream.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::HandleDoEnd
virtual void HandleDoEnd ()
Interface Category:
API.
Purpose:
Override this command to clean up after execution. The default implementation of this function does nothing.
Calling Context:
Called by DoEnd after command state has been verified.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Preconditions:
Interface Category:
API.
Purpose:
Override this function to commit a command that is in the Done state. Does nothing by default.
Calling Context:
Called by Commit after the command state is determined to be Done.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Preconditions:
Interface Category:
API.
Purpose:
Override to indicate if the command increment is required for streaming
Calling Context:
Called by IsThisIncrementRequired.
Parameters:
Return Value:
Returns true if increment is required for command reconstruction. Returns true by default.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::HandleStreamOutIncrementDelta
virtual void HandleStreamOutIncrementDelta (TStream &) const
Interface Category:
API.
Purpose:
Override to stream out a command increment. Calls operator>>=(TStream&) by default.
Calling Context:
Called by StreamOutIncrementDelta.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::HandleStreamInIncrementDelta
virtual void HandleStreamInIncrementDelta (TStream &)
Interface Category:
API.
Purpose:
Override to stream in a command increment. Calls operator<<=(TStream&) by default.
Calling Context:
Called by StreamInIncrementDelta.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CheckAddRedoInterests
void CheckAddRedoInterests () const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CheckAddUndoInterests
void CheckAddUndoInterests () const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CheckAddDoInterests
void CheckAddDoInterests () const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
void CheckRedo ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
void CheckUndo ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CheckDoEnd
void CheckDoEnd ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CheckDoIncrement
void CheckDoIncrement ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CheckDoBegin
void CheckDoBegin ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::operator<<=
virtual TStream & operator <<= (TStream & fromWhere)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Called to stream in data. Do not call.
Parameters:
Return Value:
Returns a reference to the stream the object streams itself in from.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::operator>>=
virtual TStream & operator >>=(TStream & toWhere) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Called to stream out data. Do not call.
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.
TCommonCommand & operator =(const TCommonCommand & source)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Called when an object is assigned to another compatible object. Do not call.
Parameters:
Return Value:
A non-const reference to the left-hand side object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
- TCommonCommand (UndoType theUndoType)
- TCommonCommand (const TCommonCommand & other)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
- Do not call.
- Called to copy an object. Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonWriteVersion
static void CommonWriteVersion (TStream & toWhere, VersionInfo theVersion)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
- TStream & toWhere
- VersionInfo theVersion
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonReadVersion
static VersionInfo CommonReadVersion (TStream & fromWhere, VersionInfo lowVersion, VersionInfo highVersion)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
- TStream & fromWhere
- VersionInfo lowVersion
- VersionInfo highVersion
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::HandleCommitUndone
virtual void HandleCommitUndone ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleAddRedoInterests
virtual void TypeSafeHandleAddRedoInterests (const void * target, TCollectionOf < TInterest > & fillin) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleAddUndoInterests
virtual void TypeSafeHandleAddUndoInterests (const void * target, TCollectionOf < TInterest > & fillin) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleAddDoInterests
virtual void TypeSafeHandleAddDoInterests (const void * target, TCollectionOf < TInterest > & fillin) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleCanRedo
virtual bool TypeSafeHandleCanRedo (const void * target) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleCanUndo
virtual bool TypeSafeHandleCanUndo (const void * target) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleCanDo
virtual bool TypeSafeHandleCanDo (const void * target) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleRedo
virtual void TypeSafeHandleRedo (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleUndo
virtual void TypeSafeHandleUndo (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleDoIncrement
virtual void TypeSafeHandleDoIncrement (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::TypeSafeHandleDoBegin
virtual void TypeSafeHandleDoBegin (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonAddRedoInterests
void CommonAddRedoInterests (const void * target, TCollectionOf < TInterest > & fillin) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonAddUndoInterests
void CommonAddUndoInterests (const void * target, TCollectionOf < TInterest > & fillin) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonAddDoInterests
void CommonAddDoInterests (const void * target, TCollectionOf < TInterest > & fillin) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonCanRedo
bool CommonCanRedo (const void * target) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonCanUndo
bool CommonCanUndo (const void * target) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonCanDo
bool CommonCanDo (const void * target) const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonCommit
void CommonCommit ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonRedo
void CommonRedo (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonUndo
void CommonUndo (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonDoEnd
void CommonDoEnd ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonDoIncrement
void CommonDoIncrement (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::CommonDoBegin
void CommonDoBegin (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
void CommonDo (void * target)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
void SetState (State)
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TCommonCommand::ChangesTarget
bool ChangesTarget () const
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
Calling Context:
Do not call.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TCommonCommand ()
Interface Category:
API.
Purpose:
This function is an implementation detail of TCommandOn<ATarget>. It will be removed from the public interface in future releases of the CommonPoint application system.
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.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.