Class: TDocumentComponentCommandBindingTo

Declaration: CompoundDocumentCommand.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TDocumentComponentCommandBinding

Inherited By:

TGUIDocumentComponentCommandBindingTo

Purpose:

Provides a type safe binding of a model, or presenter state command to a compatible selection. The following member functions all delegate to the corresponding function of the bound command, passing the appropriate target as a parameter: Do, DoBegin, DoIncrement, DoEnd, Undo, Redo, CanDo, CanUndo, CanRedo, and Commit. The following member functions provide type safe access to the bound target: GetCommand, and GetTarget.

Instantiation:

Always allocate on the heap. Ownership of the command binding is handed off to the document for execution.

Deriving Classes:

This class template is not usually derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Invariants:

Assert (GetCommand() != NIL)
Assert (GetTarget() != NIL)

Member Function: TDocumentComponentCommandBindingTo::TDocumentComponentCommandBindingTo

TDocumentComponentCommandBindingTo (TCommandOn < ATarget > *, ATarget *)
TDocumentComponentCommandBindingTo (TCommandOn < ATarget > *, const TModelAnchorReference &, EAnchorUse =kUseSelection)
TDocumentComponentCommandBindingTo (const TDocumentComponentCommandBindingTo < ATarget > &)
TDocumentComponentCommandBindingTo ()

Interface Category:

API.

Purpose:

Constructor used to bind command to a model or presenter state selection.
Constructor used to bind command to a model anchor.
Copy constructor.
Default constructor.

Calling Context:

Call this function directly.
Call this function directly.
Call this function directly.
Only for internal use by Resurrect. Developers should treat as internal.

Parameters:

TCommandOn < ATarget > * -The command to be bound to a target.
ATarget * -The target to bind to command.
TCommand < ATarget > * -The command to be bound to an anchor.
const TModelAnchorReference & -The anchor to bind to command.
EAnchorUse =kUseSelection -Indicates how the command will use the selection.
const TDocumentComponentCommandBindingTo < ATarget > & -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Preconditions:

Assert (TCommand<ATarget>* != NIL )
Assert (ATarget* != NIL )

Member Function: TDocumentComponentCommandBindingTo::~TDocumentComponentCommandBindingTo

TDocumentComponentCommandBindingTo

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

TDocumentComponentCommandBindingTo<ATarget> & operator =(const TDocumentComponentCommandBindingTo < ATarget > &)

Interface Category:

API.

Purpose:

Assigns one object to another like object.

Calling Context:

Called for assignment.

Parameters:

const TDocumentComponentCommandBindingTo < ATarget > & -The right hand side object.

Return Value:

Returns a reference to left hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentCommandBindingTo::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: TDocumentComponentCommandBindingTo::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: TDocumentComponentCommandBindingTo::GetCommand

TCommandOn < ATarget > * GetCommand ()
const TCommandOn < ATarget > * GetCommand () const

Interface Category:

API.

Purpose:

Provides access to bound command.
Provides access to const bound command.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the command bound by this binding.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentCommandBindingTo::GetTarget

ATarget * GetTarget ()
const ATarget * GetTarget () const

Interface Category:

API.

Purpose:

Provides access to bound target.
Provide access to const bound target.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns the target bound to this command.

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.